Skip to content

Commit 18bc8fd

Browse files
committed
rename clients to applications
1 parent c7b7e35 commit 18bc8fd

18 files changed

Lines changed: 113 additions & 113 deletions

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,15 @@ The Auth0 Authentication API and User's Management API are available for Android
3636

3737
The implementation is based on the [Authentication API Docs](https://auth0.com/docs/api/authentication).
3838

39-
Create an `AuthAPI` instance by providing the client data from the [dashboard](https://manage.auth0.com/#/clients).
39+
Create an `AuthAPI` instance by providing the Application details from the [dashboard](https://manage.auth0.com/#/applications).
4040

4141
```java
4242
AuthAPI auth = new AuthAPI("{YOUR_DOMAIN}", "{YOUR_CLIENT_ID}", "{YOUR_CLIENT_SECRET}");
4343
```
4444

4545
### Authorize - /authorize
4646

47-
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.
47+
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 Applications Settings. Parameters can be added to the final url by using the builder methods. When ready, call `build()` and obtain the Url.
4848

4949
```AuthorizeUrlBuilder authorizeUrl(String redirectUri)```
5050

@@ -59,7 +59,7 @@ String url = auth.authorizeUrl("https://me.auth0.com/callback")
5959
```
6060

6161
### Logout - /v2/logout
62-
Creates a `LogoutUrlBuilder` to log out the user. The `returnToUrl` must be white-listed in the "Allowed Logout URLs" section of the Dashboard, depending on the value of `setClientId` this configuration should be set in the Client or in the Tenant. Parameters can be added to the final url by using the builder methods. When ready, call `build()` and obtain the Url.
62+
Creates a `LogoutUrlBuilder` to log out the user. The `returnToUrl` must be white-listed in the "Allowed Logout URLs" section of the Dashboard, depending on the value of `setClientId` this configuration should be set in the Application or in the Tenant Settings. Parameters can be added to the final url by using the builder methods. When ready, call `build()` and obtain the Url.
6363

6464
`LogoutUrlBuilder logoutUrl(String returnToUrl, boolean setClientId)`
6565

@@ -249,13 +249,13 @@ try {
249249

250250
The implementation is based on the [Management API Docs](https://auth0.com/docs/api/management/v2).
251251

252-
Create a `ManagementAPI` instance by providing the domain from the [client dashboard](https://manage.auth0.com/#/clients) and a valid API Token.
252+
Create a `ManagementAPI` instance by providing the domain from the [Application dashboard](https://manage.auth0.com/#/applications) and a valid API Token.
253253

254254
```java
255255
ManagementAPI mgmt = new ManagementAPI("{YOUR_DOMAIN}", "{YOUR_API_TOKEN}");
256256
```
257257

258-
You can use the Authentication API to obtain a token for a previously authorized client:
258+
You can use the Authentication API to obtain a token for a previously authorized Application:
259259

260260
```java
261261
AuthAPI authAPI = new AuthAPI("{YOUR_DOMAIN}", "{YOUR_CLIENT_ID}", "{YOUR_CLIENT_SECRET}");
@@ -546,7 +546,7 @@ For more information about [auth0](http://auth0.com) check our [documentation pa
546546

547547
Auth0 helps you to:
548548

549-
* Add authentication with [multiple authentication sources](https://docs.auth0.com/identityproviders), either social like **Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce, amont others**, or enterprise identity systems like **Windows Azure AD, Google Apps, Active Directory, ADFS or any SAML Identity Provider**.
549+
* Add authentication with [multiple authentication sources](https://docs.auth0.com/identityproviders), either social like **Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce, among others**, or enterprise identity systems like **Windows Azure AD, Google Apps, Active Directory, ADFS or any SAML Identity Provider**.
550550
* Add authentication through more traditional **[username/password databases](https://docs.auth0.com/mysql-connection-tutorial)**.
551551
* Add support for **[linking different user accounts](https://docs.auth0.com/link-accounts)** with the same user.
552552
* Support for generating signed [Json Web Tokens](https://docs.auth0.com/jwt) to call your APIs and **flow the user identity** securely.

src/main/java/com/auth0/client/auth/AuthAPI.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
/**
1313
* Class that provides an implementation of some of the Authentication and Authorization API methods defined in https://auth0.com/docs/api/authentication.
14-
* To begin create a new instance of {@link #AuthAPI(String, String, String)} using the tenant domain, client id and client secret.
14+
* To begin create a new instance of {@link #AuthAPI(String, String, String)} using the tenant domain, and the Application's client id and client secret.
1515
*/
1616
@SuppressWarnings("WeakerAccess")
1717
public class AuthAPI {
@@ -40,11 +40,11 @@ public class AuthAPI {
4040
private final HttpLoggingInterceptor logging;
4141

4242
/**
43-
* Create a new instance with the given tenant's domain, client id and client secret. These values can be obtained at https://manage.auth0.com/#/clients/{YOUR_CLIENT_ID}/settings.
43+
* Create a new instance with the given tenant's domain, application's client id and client secret. These values can be obtained at https://manage.auth0.com/#/applications/{YOUR_CLIENT_ID}/settings.
4444
*
4545
* @param domain tenant's domain.
46-
* @param clientId the client's id.
47-
* @param clientSecret the client's secret.
46+
* @param clientId the application's client id.
47+
* @param clientSecret the application's client secret.
4848
*/
4949
public AuthAPI(String domain, String clientId, String clientSecret) {
5050
Asserts.assertNotNull(domain, "domain");
@@ -116,7 +116,7 @@ private HttpUrl createBaseUrl(String domain) {
116116
* }
117117
* </pre>
118118
*
119-
* @param redirectUri the redirect_uri value to set, white-listed in the client settings. Must be already URL Encoded.
119+
* @param redirectUri the redirect_uri value to set, white-listed in the Application settings. Must be already URL Encoded.
120120
* @return a new instance of the {@link AuthorizeUrlBuilder} to configure.
121121
*/
122122
public AuthorizeUrlBuilder authorizeUrl(String redirectUri) {
@@ -137,7 +137,7 @@ public AuthorizeUrlBuilder authorizeUrl(String redirectUri) {
137137
* }
138138
* </pre>
139139
*
140-
* @param returnToUrl the redirect_uri value to set, white-listed in the client settings. Must be already URL Encoded.
140+
* @param returnToUrl the redirect_uri value to set, white-listed in the Application settings. Must be already URL Encoded.
141141
* @param setClientId whether the client_id value must be set or not. This affects the white-list that the Auth0's Dashboard uses to validate the returnTo url.
142142
* @return a new instance of the {@link LogoutUrlBuilder} to configure.
143143
*/

src/main/java/com/auth0/client/auth/AuthorizeUrlBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ public class AuthorizeUrlBuilder {
2020
* Creates an instance of the {@link AuthorizeUrlBuilder} using the given domain and base parameters.
2121
*
2222
* @param baseUrl the base url constructed from a valid domain.
23-
* @param clientId the client_id value to set
23+
* @param clientId the application's client_id value to set
2424
* @param redirectUri the redirect_uri value to set. Must be already URL Encoded and must be white-listed in your Auth0's dashboard.
2525
* @return a new instance of the {@link AuthorizeUrlBuilder} to configure.
2626
*/

src/main/java/com/auth0/client/auth/LogoutUrlBuilder.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ public class LogoutUrlBuilder {
2020
* Creates a instance of the {@link LogoutUrlBuilder} using the given domain and base parameters.
2121
*
2222
* @param baseUrl the base url constructed from a valid domain.
23-
* @param clientId the client_id value to set
23+
* @param clientId the application's client_id value to set
2424
* @param returnToUrl the returnTo value to set. Must be already URL Encoded and must be white-listed in your Auth0's dashboard.
2525
* @param setClientId whether the client_id value must be set or not. This affects the white-list that the Auth0's Dashboard uses to validate the returnTo url.
26-
* If the client_id is set, the white-list is read from the Client configuration. If the client_id is not set, the white-list is read from the Tenant configuration.
26+
* If the client_id is set, the white-list is read from the Application's settings. If the client_id is not set, the white-list is read from the Tenant's settings.
2727
* @return a new instance of the {@link LogoutUrlBuilder} to configure.
2828
*/
2929
static LogoutUrlBuilder newInstance(HttpUrl baseUrl, String clientId, String returnToUrl, boolean setClientId) {

src/main/java/com/auth0/client/mgmt/ClientGrantsEntity.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ public Request<List<ClientGrant>> list() {
4343
* Create a Client Grant. A token with scope create:client_grants is needed.
4444
* See https://auth0.com/docs/api/management/v2#!/Client_Grants/post_client_grants
4545
*
46-
* @param clientId the client id to associate this grant with.
46+
* @param clientId the application's client id to associate this grant with.
4747
* @param audience the audience of the grant.
4848
* @param scope the scope to grant.
4949
* @return a Request to execute.

src/main/java/com/auth0/client/mgmt/ClientsEntity.java

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
import java.util.List;
1414

1515
/**
16-
* Class that provides an implementation of the Clients methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/Clients
16+
* Class that provides an implementation of the Application methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/Clients
1717
*/
1818
@SuppressWarnings("WeakerAccess")
1919
public class ClientsEntity extends BaseManagementEntity {
@@ -23,7 +23,7 @@ public class ClientsEntity extends BaseManagementEntity {
2323
}
2424

2525
/**
26-
* Request all the ClientsEntity. A token with scope read:clients is needed. If you also need the client_secret and encryption_key attributes the token must have read:client_keys scope.
26+
* Request all the Applications. A token with scope read:clients is needed. If you also need the client_secret and encryption_key attributes the token must have read:client_keys scope.
2727
* See https://auth0.com/docs/api/management/v2#!/Clients/get_clients
2828
*
2929
* @return a Request to execute.
@@ -41,10 +41,10 @@ public Request<List<Client>> list() {
4141
}
4242

4343
/**
44-
* Request a Client. A token with scope read:clients is needed. If you also need the client_secret and encryption_key attributes the token must have read:client_keys scope.
44+
* Request an Application. A token with scope read:clients is needed. If you also need the client_secret and encryption_key attributes the token must have read:client_keys scope.
4545
* See https://auth0.com/docs/api/management/v2#!/Clients/get_clients_by_id
4646
*
47-
* @param clientId the client id.
47+
* @param clientId the application's client id.
4848
* @return a Request to execute.
4949
*/
5050
public Request<Client> get(String clientId) {
@@ -63,10 +63,10 @@ public Request<Client> get(String clientId) {
6363
}
6464

6565
/**
66-
* Create a new Client. A token with scope create:clients is needed.
66+
* Create a new Application. A token with scope create:clients is needed.
6767
* See https://auth0.com/docs/api/management/v2#!/Clients/post_clients
6868
*
69-
* @param client the client data to set.
69+
* @param client the application data to set.
7070
* @return a Request to execute.
7171
*/
7272
public Request<Client> create(Client client) {
@@ -85,10 +85,10 @@ public Request<Client> create(Client client) {
8585
}
8686

8787
/**
88-
* Delete an existing Client. A token with scope delete:clients is needed.
88+
* Delete an existing Application. A token with scope delete:clients is needed.
8989
* See https://auth0.com/docs/api/management/v2#!/Clients/delete_clients_by_id
9090
*
91-
* @param clientId the client id.
91+
* @param clientId the application's client id.
9292
* @return a Request to execute.
9393
*/
9494
public Request delete(String clientId) {
@@ -106,11 +106,11 @@ public Request delete(String clientId) {
106106
}
107107

108108
/**
109-
* Update an existing Client. A token with scope update:clients is needed. If you also need to update the client_secret and encryption_key attributes the token must have update:client_keys scope.
109+
* Update an existing Application. A token with scope update:clients is needed. If you also need to update the client_secret and encryption_key attributes the token must have update:client_keys scope.
110110
* See https://auth0.com/docs/api/management/v2#!/Clients/patch_clients_by_id
111111
*
112-
* @param clientId the client id.
113-
* @param client the client data to set.
112+
* @param clientId the application's client id.
113+
* @param client the application data to set.
114114
* @return a Request to execute.
115115
*/
116116
public Request<Client> update(String clientId, Client client) {
@@ -131,10 +131,10 @@ public Request<Client> update(String clientId, Client client) {
131131
}
132132

133133
/**
134-
* Rotates a Client secret. A token with scope update:client_keys is needed. Note that the generated secret is NOT base64 encoded.
134+
* Rotates an Application's client secret. A token with scope update:client_keys is needed. Note that the generated secret is NOT base64 encoded.
135135
* See https://auth0.com/docs/api/management/v2#!/Clients/post_rotate_secret
136136
*
137-
* @param clientId the client id.
137+
* @param clientId the application's client id.
138138
* @return a Request to execute.
139139
*/
140140
public Request<Client> rotateSecret(String clientId) {

src/main/java/com/auth0/client/mgmt/ConnectionsEntity.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
import java.util.Map;
1515

1616
/**
17-
* Class that provides an implementation of the Clients methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/Connections
17+
* Class that provides an implementation of the Connections methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/Connections
1818
*/
1919
@SuppressWarnings("WeakerAccess")
2020
public class ConnectionsEntity extends BaseManagementEntity {

src/main/java/com/auth0/client/mgmt/ManagementAPI.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,9 @@ public ClientGrantsEntity clientGrants() {
8989
}
9090

9191
/**
92-
* Getter for the Clients entity.
92+
* Getter for the Applications entity.
9393
*
94-
* @return the Clients entity.
94+
* @return the Applications entity.
9595
*/
9696
public ClientsEntity clients() {
9797
return new ClientsEntity(client, baseUrl, apiToken);

src/main/java/com/auth0/client/mgmt/filter/DeviceCredentialsFilter.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public DeviceCredentialsFilter withUserId(String userId) {
1717
}
1818

1919
/**
20-
* Filter by client id
20+
* Filter by application's client id
2121
*
2222
* @param clientId only retrieve items with this client id.
2323
* @return this filter instance.

src/main/java/com/auth0/json/mgmt/ClientGrant.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,19 +34,19 @@ public String getId() {
3434
}
3535

3636
/**
37-
* Getter for the id of the client.
37+
* Getter for the client id of the application.
3838
*
39-
* @return the client id.
39+
* @return the application's client id.
4040
*/
4141
@JsonProperty("client_id")
4242
public String getClientId() {
4343
return clientId;
4444
}
4545

4646
/**
47-
* Setter for the client id.
47+
* Setter for the application's client id.
4848
*
49-
* @param clientId the client id to set.
49+
* @param clientId the application's client id to set.
5050
*/
5151
@JsonProperty("client_id")
5252
public void setClientId(String clientId) {

0 commit comments

Comments
 (0)