Skip to content

Commit 1af7b67

Browse files
committed
fix methods signature and add codecov badge in README.md file
1 parent 1443cc5 commit 1af7b67

3 files changed

Lines changed: 27 additions & 23 deletions

File tree

.idea/compiler.xml

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.travis.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,4 @@ after_failure:
1919
- cat $HOME/build/auth0/auth0-java/build/reports/tests/index.html
2020
branches:
2121
only:
22-
- master
23-
- v1
22+
- master

README.md

Lines changed: 24 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
[![MIT][mit-badge]][mit-url]
55
[![Maven][maven-badge]][maven-url]
66
[![JCenter][jcenter-badge]][jcenter-url]
7+
[![codecov][codecov-badge]][codecov-url]
78

89
Java client library for the [Auth0](https://auth0.com) platform.
910

@@ -45,7 +46,7 @@ AuthAPI auth = new AuthAPI("{YOUR_DOMAIN}", "{YOUR_CLIENT_ID}", "{YOUR_CLIENT_SE
4546

4647
Creates an `AuthorizeUrlBuilder` to authenticate the user with an OAuth provider. The `redirectUri` must be white-listed in the "Allowed Callback URLs" section of the Client Settings. Parameters can be added to the final url by using the builder methods. When ready, call `build()` and obtain the Url.
4748

48-
`AuthorizeUrlBuilder authorizeUrl("{REDIRECT_URI}")`
49+
```AuthorizeUrlBuilder authorizeUrl(String redirectUri)```
4950

5051
Example:
5152
```java
@@ -60,7 +61,7 @@ String url = auth.authorizeUrl("https://me.auth0.com/callback")
6061
### Logout - /v2/logout
6162
Creates a `LogoutUrlBuilder` to log out the user. The `returnToUrl` must be white-listed in the "Allowed Logout URLs" section of the Client Settings. Parameters can be added to the final url by using the builder methods. When ready, call `build()` and obtain the Url.
6263

63-
`LogoutUrlBuilder logoutUrl("{RETURN_TO_URL}", "{SEND_CLIENT_ID}")`
64+
`LogoutUrlBuilder logoutUrl(String returnToUrl, boolean setClientId)`
6465

6566
Example:
6667
```java
@@ -72,7 +73,7 @@ String url = auth.logoutUrl("https://me.auth0.com/home", true)
7273
### UserInfo - /userinfo
7374
Creates a new request to get the user information associated to a given access token. This will only work if the token has been granted the `openid` scope.
7475

75-
`Request<UserInfo> userInfo("{ACCESS_TOKEN}")`
76+
`Request<UserInfo> userInfo(String accessToken)`
7677

7778
Example:
7879
```java
@@ -90,7 +91,7 @@ try {
9091
### Reset Password - /dbconnections/change_password
9192
Creates a new request to reset the user's password. This will only work for db connections.
9293

93-
`Request resetPassword("{EMAIL}", "{CONNECTION}")`
94+
`Request resetPassword(String email, String connection)`
9495

9596
Example:
9697
```java
@@ -108,9 +109,9 @@ try {
108109
### Sign Up - /dbconnections/signup
109110
Creates a new request to create a new user. Up to 10 additional Sign Up fields can be added to the request. This will only work for db connections.
110111

111-
`SignUpRequest signUp("{EMAIL}", "{USERNAME}", "{PASSWORD}", "{CONNECTION}")`
112+
`SignUpRequest signUp(String email, String username, String password, String connection)`
112113

113-
`SignUpRequest signUp("{EMAIL}", "{PASSWORD}", "{CONNECTION}")`
114+
`SignUpRequest signUp(String email, String password, String connection)`
114115

115116
Example:
116117
```java
@@ -132,7 +133,7 @@ try {
132133

133134
Creates a new request to exchange the `code` previously obtained by calling the /authorize endpoint. The redirect uri must be the one sent in the /authorize call.
134135

135-
`AuthRequest exchangeCode("{CODE}", "{REDIRECT_URI}")`
136+
`AuthRequest exchangeCode(String code, String redirectUri)`
136137

137138
Example:
138139
```java
@@ -152,7 +153,7 @@ try {
152153

153154
Creates a new request to log in the user with `username` and `password`. The connection used is the one defined as "Default Directory" in the account settings.
154155

155-
`AuthRequest login("{USERNAME_OR_EMAIL}", "{PASSWORD}")`
156+
`AuthRequest login(String emailOrUsername, String password)`
156157

157158
Example:
158159
```java
@@ -172,7 +173,7 @@ try {
172173

173174
Creates a new request to log in the user with `username` and `password` using the Password Realm.
174175

175-
`AuthRequest login("{USERNAME_OR_EMAIL}", "{PASSWORD}", "{REALM}")`
176+
`AuthRequest login(String emailOrUsername, String password, String realm)`
176177

177178
Example:
178179
```java
@@ -192,7 +193,7 @@ try {
192193

193194
Creates a new request to get a Token for the given Audience.
194195

195-
`AuthRequest requestToken("{AUDIENCE}")`
196+
`AuthRequest requestToken(String audience)`
196197

197198
Example:
198199
```java
@@ -243,7 +244,7 @@ The Management API is divided into different entities. Each of them have the lis
243244
Creates a new request to list the Users. An API Token with scope `read:users` is needed. If you want the identities.access_token property to be included, you will also need the scope `read:user_idp_tokens`.
244245
You can pass an optional Filter to narrow the results in the response.
245246

246-
`Request<UsersPage> list({FILTER})`
247+
`Request<UsersPage> list(UserFilter filter)`
247248

248249
Example:
249250
```java
@@ -263,7 +264,7 @@ try {
263264
Creates a new request to get a User. An API Token with scope `read:users` is needed. If you want the identities.access_token property to be included, you will also need the scope `read:user_idp_tokens`.
264265
You can pass an optional Filter to narrow the results in the response.
265266

266-
`Request<User> get("{USER_ID}", {FILTER})`
267+
`Request<User> get(String userId, UserFilter filter)`
267268

268269
Example:
269270
```java
@@ -282,7 +283,7 @@ try {
282283

283284
Creates a new request to create a new User. An API Token with scope `create:users` is needed.
284285

285-
`Request<User> create({DATA})`
286+
`Request<User> create(User user)`
286287

287288
Example:
288289
```java
@@ -301,7 +302,7 @@ try {
301302

302303
Creates a new request to delete a User. An API Token with scope `delete:users` is needed.
303304

304-
`Request delete("{USER_ID}")`
305+
`Request delete(String userId)`
305306

306307
Example:
307308
```java
@@ -319,7 +320,7 @@ try {
319320

320321
Creates a new request to update a User. An API Token with scope `update:users` is needed. If you're updating app_metadata you'll also need `update:users_app_metadata` scope.
321322

322-
`Request<User> update("{USER_ID}", {DATA})`
323+
`Request<User> update(String userId, User user)`
323324

324325
Example:
325326
```java
@@ -338,7 +339,7 @@ try {
338339

339340
Creates a new request to list the User's Guardian Enrollments. An API Token with scope `read:users` is needed.
340341

341-
`Request<List<Enrollment>> getEnrollments("{USER_ID}")`
342+
`Request<List<Enrollment>> getEnrollments(String userId)`
342343

343344
Example:
344345
```java
@@ -357,7 +358,7 @@ try {
357358
Creates a new request to list the User's Log Events. An API Token with scope `read:logs` is needed.
358359
You can pass an optional Filter to narrow the results in the response.
359360

360-
`Request<LogEventsPage> getLogEvents("{USER_ID}", {FILTER})`
361+
`Request<LogEventsPage> getLogEvents(String userId, LogEventFilter filter)`
361362

362363
Example:
363364
```java
@@ -377,7 +378,7 @@ try {
377378

378379
Creates a new request to delete the User's Multifactor Provider. An API Token with scope `update:users` is needed.
379380

380-
`Request deleteMultifactorProvider("{USER_ID}", "{MULTIFACTOR_PROVIDER}")`
381+
`Request deleteMultifactorProvider(String userId, String provider)`
381382

382383
Example:
383384
```java
@@ -395,7 +396,7 @@ try {
395396

396397
Creates a new request to rotate the User's Recovery Code. An API Token with scope `update:users` is needed.
397398

398-
`Request<RecoveryCode> rotateRecoveryCode("{USER_ID}")`
399+
`Request<RecoveryCode> rotateRecoveryCode(String userId)`
399400

400401
Example:
401402
```java
@@ -413,7 +414,7 @@ try {
413414

414415
Creates a new request to link two User identities. An API Token with scope `update:users` is needed.
415416

416-
`Request<List<Identities>> linkIdentity("{PRIMARY_USER_ID}", "{SECONDARY_USER_ID}", "{PROVIDER}", "{CONNECTION_ID}")`
417+
`Request<List<Identity>> linkIdentity(String primaryUserId, String secondaryUserId, String provider, String connectionId)`
417418

418419
Example:
419420
```java
@@ -431,7 +432,7 @@ try {
431432

432433
Creates a new request to un-link two User identities. An API Token with scope `update:users` is needed.
433434

434-
`Request<List<Identities>> unlinkIdentity("{PRIMARY_USER_ID}", "{SECONDARY_USER_ID}", "{PROVIDER}")`
435+
`Request<List<Identity>> unlinkIdentity(String primaryUserId, String secondaryUserId, String provider)`
435436

436437
Example:
437438
```java
@@ -510,3 +511,5 @@ This project is licensed under the MIT license. See the [LICENSE](LICENSE) file
510511
[maven-url]: http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.auth0%22%20AND%20a%3A%22auth0%22
511512
[jcenter-badge]: https://api.bintray.com/packages/auth0/java/auth0/images/download.svg
512513
[jcenter-url]: https://bintray.com/auth0/java/auth0/_latestVersion
514+
[codecov-badge]: https://codecov.io/gh/auth0/auth0-java/branch/master/graph/badge.svg
515+
[codecov-url]: https://codecov.io/gh/auth0/auth0-java

0 commit comments

Comments
 (0)