Merge pull request #116 from auth0/rename-clients

rename clients to applications

Author: cocojoe

README.md

@@ -36,15 +36,15 @@ The Auth0 Authentication API and User's Management API are available for Android
 
 The implementation is based on the [Authentication API Docs](https://auth0.com/docs/api/authentication).
 
-Create an `AuthAPI` instance by providing the client data from the [dashboard](https://manage.auth0.com/#/clients).
+Create an `AuthAPI` instance by providing the Application details from the [dashboard](https://manage.auth0.com/#/applications).
 
 ```java
 AuthAPI auth = new AuthAPI("{YOUR_DOMAIN}", "{YOUR_CLIENT_ID}", "{YOUR_CLIENT_SECRET}");
 ```
 
 ### Authorize - /authorize
 
-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.
+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.
 
 ```AuthorizeUrlBuilder authorizeUrl(String redirectUri)```
 
@@ -59,7 +59,7 @@ String url = auth.authorizeUrl("https://me.auth0.com/callback")
 ```
 
 ### Logout - /v2/logout
-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.
+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.
 
 `LogoutUrlBuilder logoutUrl(String returnToUrl, boolean setClientId)`
 
@@ -249,13 +249,13 @@ try {
 
 The implementation is based on the [Management API Docs](https://auth0.com/docs/api/management/v2). 
 
-Create a `ManagementAPI` instance by providing the domain from the [client dashboard](https://manage.auth0.com/#/clients) and a valid API Token.
+Create a `ManagementAPI` instance by providing the domain from the [Application dashboard](https://manage.auth0.com/#/applications) and a valid API Token.
 
 ```java
 ManagementAPI mgmt = new ManagementAPI("{YOUR_DOMAIN}", "{YOUR_API_TOKEN}");
 ```
 
-You can use the Authentication API to obtain a token for a previously authorized client:
+You can use the Authentication API to obtain a token for a previously authorized Application:
 
 ```java
 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
 
 Auth0 helps you to:
 
-* 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**.
+* 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**.
 * Add authentication through more traditional **[username/password databases](https://docs.auth0.com/mysql-connection-tutorial)**.
 * Add support for **[linking different user accounts](https://docs.auth0.com/link-accounts)** with the same user.
 * 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

@@ -11,7 +11,7 @@
 
 /**
  * Class that provides an implementation of some of the Authentication and Authorization API methods defined in https://auth0.com/docs/api/authentication.
- * To begin create a new instance of {@link #AuthAPI(String, String, String)} using the tenant domain, client id and client secret.
+ * 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.
  */
 @SuppressWarnings("WeakerAccess")
 public class AuthAPI {
@@ -40,11 +40,11 @@ public class AuthAPI {
     private final HttpLoggingInterceptor logging;
 
     /**
-     * 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.
+     * 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.
      *
      * @param domain       tenant's domain.
-     * @param clientId     the client's id.
-     * @param clientSecret the client's secret.
+     * @param clientId     the application's client id.
+     * @param clientSecret the application's client secret.
      */
     public AuthAPI(String domain, String clientId, String clientSecret) {
         Asserts.assertNotNull(domain, "domain");
@@ -116,7 +116,7 @@ private HttpUrl createBaseUrl(String domain) {
      * }
      * </pre>
      *
-     * @param redirectUri the redirect_uri value to set, white-listed in the client settings. Must be already URL Encoded.
+     * @param redirectUri the redirect_uri value to set, white-listed in the Application settings. Must be already URL Encoded.
      * @return a new instance of the {@link AuthorizeUrlBuilder} to configure.
      */
     public AuthorizeUrlBuilder authorizeUrl(String redirectUri) {
@@ -137,7 +137,7 @@ public AuthorizeUrlBuilder authorizeUrl(String redirectUri) {
      * }
      * </pre>
      *
-     * @param returnToUrl the redirect_uri value to set, white-listed in the client settings. Must be already URL Encoded.
+     * @param returnToUrl the redirect_uri value to set, white-listed in the Application settings. Must be already URL Encoded.
      * @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.
      * @return a new instance of the {@link LogoutUrlBuilder} to configure.
      */

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

@@ -20,7 +20,7 @@ public class AuthorizeUrlBuilder {
      * Creates an instance of the {@link AuthorizeUrlBuilder} using the given domain and base parameters.
      *
      * @param baseUrl         the base url constructed from a valid domain.
-     * @param clientId    the client_id value to set
+     * @param clientId    the application's client_id value to set
      * @param redirectUri the redirect_uri value to set. Must be already URL Encoded and must be white-listed in your Auth0's dashboard.
      * @return a new instance of the {@link AuthorizeUrlBuilder} to configure.
      */

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

@@ -20,10 +20,10 @@ public class LogoutUrlBuilder {
      * Creates a instance of the {@link LogoutUrlBuilder} using the given domain and base parameters.
      *
      * @param baseUrl     the base url constructed from a valid domain.
-     * @param clientId    the client_id value to set
+     * @param clientId    the application's client_id value to set
      * @param returnToUrl the returnTo value to set. Must be already URL Encoded and must be white-listed in your Auth0's dashboard.
      * @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.
-     *                    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.
+     *                    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.
      * @return a new instance of the {@link LogoutUrlBuilder} to configure.
      */
     static LogoutUrlBuilder newInstance(HttpUrl baseUrl, String clientId, String returnToUrl, boolean setClientId) {

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

@@ -43,7 +43,7 @@ public Request<List<ClientGrant>> list() {
      * Create a Client Grant. A token with scope create:client_grants is needed.
      * See https://auth0.com/docs/api/management/v2#!/Client_Grants/post_client_grants
      *
-     * @param clientId the client id to associate this grant with.
+     * @param clientId the application's client id to associate this grant with.
      * @param audience the audience of the grant.
      * @param scope    the scope to grant.
      * @return a Request to execute.

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

@@ -13,7 +13,7 @@
 import java.util.List;
 
 /**
- * Class that provides an implementation of the Clients methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/Clients
+ * Class that provides an implementation of the Application methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/Clients
  */
 @SuppressWarnings("WeakerAccess")
 public class ClientsEntity extends BaseManagementEntity {
@@ -23,7 +23,7 @@ public class ClientsEntity extends BaseManagementEntity {
     }
 
     /**
-     * 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.
+     * 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.
      * See https://auth0.com/docs/api/management/v2#!/Clients/get_clients
      *
      * @return a Request to execute.
@@ -41,10 +41,10 @@ public Request<List<Client>> list() {
     }
 
     /**
-     * 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.
+     * 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.
      * See https://auth0.com/docs/api/management/v2#!/Clients/get_clients_by_id
      *
-     * @param clientId the client id.
+     * @param clientId the application's client id.
      * @return a Request to execute.
      */
     public Request<Client> get(String clientId) {
@@ -63,10 +63,10 @@ public Request<Client> get(String clientId) {
     }
 
     /**
-     * Create a new Client. A token with scope create:clients is needed.
+     * Create a new Application. A token with scope create:clients is needed.
      * See https://auth0.com/docs/api/management/v2#!/Clients/post_clients
      *
-     * @param client the client data to set.
+     * @param client the application data to set.
      * @return a Request to execute.
      */
     public Request<Client> create(Client client) {
@@ -85,10 +85,10 @@ public Request<Client> create(Client client) {
     }
 
     /**
-     * Delete an existing Client. A token with scope delete:clients is needed.
+     * Delete an existing Application. A token with scope delete:clients is needed.
      * See https://auth0.com/docs/api/management/v2#!/Clients/delete_clients_by_id
      *
-     * @param clientId the client id.
+     * @param clientId the application's client id.
      * @return a Request to execute.
      */
     public Request delete(String clientId) {
@@ -106,11 +106,11 @@ public Request delete(String clientId) {
     }
 
     /**
-     * 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.
+     * 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.
      * See https://auth0.com/docs/api/management/v2#!/Clients/patch_clients_by_id
      *
-     * @param clientId the client id.
-     * @param client   the client data to set.
+     * @param clientId the application's client id.
+     * @param client   the application data to set.
      * @return a Request to execute.
      */
     public Request<Client> update(String clientId, Client client) {
@@ -131,10 +131,10 @@ public Request<Client> update(String clientId, Client client) {
     }
 
     /**
-     * Rotates a Client secret. A token with scope update:client_keys is needed. Note that the generated secret is NOT base64 encoded.
+     * Rotates an Application's client secret. A token with scope update:client_keys is needed. Note that the generated secret is NOT base64 encoded.
      * See https://auth0.com/docs/api/management/v2#!/Clients/post_rotate_secret
      *
-     * @param clientId the client id.
+     * @param clientId the application's client id.
      * @return a Request to execute.
      */
     public Request<Client> rotateSecret(String clientId) {

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

@@ -14,7 +14,7 @@
 import java.util.Map;
 
 /**
- * Class that provides an implementation of the Clients methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/Connections
+ * Class that provides an implementation of the Connections methods of the Management API as defined in https://auth0.com/docs/api/management/v2#!/Connections
  */
 @SuppressWarnings("WeakerAccess")
 public class ConnectionsEntity extends BaseManagementEntity {

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

@@ -89,9 +89,9 @@ public ClientGrantsEntity clientGrants() {
     }
 
     /**
-     * Getter for the Clients entity.
+     * Getter for the Applications entity.
      *
-     * @return the Clients entity.
+     * @return the Applications entity.
      */
     public ClientsEntity clients() {
         return new ClientsEntity(client, baseUrl, apiToken);

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

@@ -17,7 +17,7 @@ public DeviceCredentialsFilter withUserId(String userId) {
     }
 
     /**
-     * Filter by client id
+     * Filter by application's client id
      *
      * @param clientId only retrieve items with this client id.
      * @return this filter instance.

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

@@ -34,19 +34,19 @@ public String getId() {
     }
 
     /**
-     * Getter for the id of the client.
+     * Getter for the client id of the application.
      *
-     * @return the client id.
+     * @return the application's client id.
      */
     @JsonProperty("client_id")
     public String getClientId() {
         return clientId;
     }
 
     /**
-     * Setter for the client id.
+     * Setter for the application's client id.
      *
-     * @param clientId the client id to set.
+     * @param clientId the application's client id to set.
      */
     @JsonProperty("client_id")
     public void setClientId(String clientId) {