Package com.auth0.json.mgmt.client

Class Client

java.lang.Object
com.auth0.json.mgmt.client.Client
public class Client extends Object
Class that represents an Auth0 Application object. Related to the ClientsEntity entity.

  • Constructor Details

    • Client

      public Client(String name)
      Creates a new Application instance setting the name property.
      Parameters:
      name - of the application.

  • Method Details

    • getTenant

      public String getTenant()
      Getter for the name of the tenant this client belongs to.
      Returns:
      the tenant name

    • setTenant

      public void setTenant(String tenant)
      Setter for the name of the tenant this client belongs to.
      Parameters:
      tenant - the name of the tenant

    • setGlobal

      public void setGlobal(Boolean global)
      Setter whether this is a global 'All Applications' client representing legacy tenant settings (true) or a regular client (false).
      Parameters:
      global - whether legacy tenant or regular client

    • getGlobal

      public Boolean getGlobal()
      Whether this is a global 'All Applications' client representing legacy tenant settings (true) or a regular client (false).
      Returns:
      client representing legacy tenant settings (true) or a regular client (false).

    • getName

      public String getName()
      Getter for the name of the application.
      Returns:
      the name.

    • setName

      public void setName(String name)
      Setter for the application name.
      Parameters:
      name - the name to use.

    • getDescription

      public String getDescription()
      Getter for the description of the application.
      Returns:
      the description.

    • setDescription

      public void setDescription(String description)
      Setter for the description of the application.
      Parameters:
      description - the description to use.

    • getClientId

      public String getClientId()
      Getter for the application's client id.
      Returns:
      the application's client id.

    • getClientSecret

      public String getClientSecret()
      Getter for the application's client secret.
      Returns:
      the application's client secret.

    • setClientSecret

      public void setClientSecret(String clientSecret)
      Setter for the application's client secret. If no secret is provided, it will be generated by the Auth0 Server upon Application creation.
      Parameters:
      clientSecret - the secret to use.

    • getAppType

      public String getAppType()
      Getter for the type that this application represents.
      Returns:
      the application's type.

    • setAppType

      public void setAppType(String appType)
      Setter for the type that this application represents.
      Parameters:
      appType - the application type to set.

    • getLogoUri

      public String getLogoUri()
      Getter for the URI of the application logo.
      Returns:
      the application's logo URI.

    • setLogoUri

      public void setLogoUri(String logoUri)
      Setter for the application logo URI. An image with size 150x150 is recommended.
      Parameters:
      logoUri - the logo URI to set.

    • isFirstParty

      public Boolean isFirstParty()
      Whether this application is a first party client or not.
      Returns:
      true if the application is first party, false otherwise.

    • setIsFirstParty

      public void setIsFirstParty(Boolean isFirstParty)
      Setter for whether this application is a first party client or not.
      Parameters:
      isFirstParty - whether the application is a first party client or not.

    • isOIDCConformant

      public Boolean isOIDCConformant()
      Whether this application will conform to strict Open ID Connect specifications or not.
      Returns:
      true if the application will conform to strict OIDC specifications, false otherwise.

    • setOIDCConformant

      public void setOIDCConformant(Boolean oidcConformant)
      Setter for the strict conform to the Open ID Connect specifications.
      Parameters:
      oidcConformant - whether the application will conform to strict OIDC specifications or not.

    • getCallbacks

      public List<String> getCallbacks()
      Getter for the list of allowed callback urls for the application.
      Returns:
      the list of callback urls.

    • setCallbacks

      public void setCallbacks(List<String> callbacks)
      Setter for the list of allowed callback urls for the application.
      Parameters:
      callbacks - the allowed callback urls to set.

    • getAllowedOrigins

      public List<String> getAllowedOrigins()
      Getter for the list of allowed origins for the application.
      Returns:
      the list of allowed origins.

    • setAllowedOrigins

      public void setAllowedOrigins(List<String> allowedOrigins)
      Setter for the list of allowed origins for the application.
      Parameters:
      allowedOrigins - the allowed callback urls to set.

    • setWebOrigins

      public void setWebOrigins(List<String> webOrigins)
      Setter for the list of web origins for the application.
      Parameters:
      webOrigins - the web origins to set.

    • getWebOrigins

      public List<String> getWebOrigins()
      Getter for the list of web origins for the application.
      Returns:
      the list of web origins.

    • setGrantTypes

      public void setGrantTypes(List<String> grantTypes)
      Setter for the list of grant types for the application. See allowed values at https://auth0.com/docs/applications/application-grant-types.
      Parameters:
      grantTypes - the list of grant types to set.

    • getGrantTypes

      public List<String> getGrantTypes()
      Getter for the list of grant types for the application.
      Returns:
      the list of grant types.

    • getClientAliases

      public List<String> getClientAliases()
      Getter for the list of application aliases.
      Returns:
      the list of application aliases.

    • setClientAliases

      public void setClientAliases(List<String> clientAliases)
      Setter for the list of application aliases.
      Parameters:
      clientAliases - the application aliases to set.

    • getAllowedClients

      public List<String> getAllowedClients()
      Getter for the list of applications that will be allowed to make a delegation request.
      Returns:
      the list of allowed applications.

    • setAllowedClients

      public void setAllowedClients(List<String> allowedClients)
      Setter for the list of applications that will be allowed to make a delegation request.
      Parameters:
      allowedClients - the list of allowed application.

    • getAllowedLogoutUrls

      public List<String> getAllowedLogoutUrls()
      Getter for the application list of URLs that are valid to redirect to after logout from Auth0.
      Returns:
      the list of logout urls.

    • setAllowedLogoutUrls

      public void setAllowedLogoutUrls(List<String> allowedLogoutUrls)
      Setter for the application list of URLs that are valid to redirect to after logout from Auth0.
      Parameters:
      allowedLogoutUrls - the allowed logout urls to set.

    • getJWTConfiguration

      public JWTConfiguration getJWTConfiguration()
      Getter for the JWT configuration object.
      Returns:
      the JWT Configuration.

    • setJWTConfiguration

      public void setJWTConfiguration(JWTConfiguration jwtConfiguration)
      Setter for the JWT configuration object.
      Parameters:
      jwtConfiguration - the JWT configuration to set.

    • getSigningKeys

      public List<SigningKey> getSigningKeys()
      Getter for the application signing keys.
      Returns:
      the application signing keys.

    • getEncryptionKey

      public EncryptionKey getEncryptionKey()
      Getter for the encryption Key.
      Returns:
      the encryption key.

    • setEncryptionKey

      public void setEncryptionKey(EncryptionKey encryptionKey)
      Setter for the encryption Key.
      Parameters:
      encryptionKey - the encryption key.

    • useAuth0SSO

      public Boolean useAuth0SSO()
      Whether to use Auth0 instead of the Identity Provider to do Single Sign On or not.
      Returns:
      true if this application will use Auth0 for SSO instead of the Identity Provider or not.

    • setUseAuth0SSO

      public void setUseAuth0SSO(Boolean useAuth0SSO)
      Sets if Auth0 will do Single Sign On instead of the Identity Provider.
      Parameters:
      useAuth0SSO - whether to use Auth0 instead of the Identity Provider to do Single Sign On or not.

    • isSSODisabled

      public Boolean isSSODisabled()
      Whether Single Sign On is disabled or not for this application.
      Returns:
      true is SSO is disabled for this application, false otherwise.

    • setSSODisabled

      public void setSSODisabled(Boolean ssoDisabled)
      Sets if Single Sign On is disabled for this application or not.
      Parameters:
      ssoDisabled - whether SSO is disabled for this application or not.

    • useCustomLoginPage

      public Boolean useCustomLoginPage()
      Whether to use a custom login page or the default one.
      Returns:
      true if this application uses a custom login page, false otherwise.

    • setUseCustomLoginPage

      public void setUseCustomLoginPage(Boolean useCustomLoginPage)
      Sets if this application should use a custom login page or the default one.
      Parameters:
      useCustomLoginPage - true if this application uses a custom login page, false otherwise.

    • getInitiateLoginUri

      public String getInitiateLoginUri()
      Getter for the initiate login URI.
      Returns:
      the initiate login URI.

    • setInitiateLoginUri

      public void setInitiateLoginUri(String initiateLoginUri)
      Setter for the initiate login URI.
      Parameters:
      initiateLoginUri - the initiate login URI to set.

    • isHerokuApp

      public Boolean isHerokuApp()
      Whether this application is a Heroku application or not.
      Returns:
      true if this application is a Heroku application, false otherwise.

    • getCustomLoginPage

      public String getCustomLoginPage()
      Getter for the custom login page HTML code.
      Returns:
      the custom login page HTML code.

    • setCustomLoginPage

      public void setCustomLoginPage(String customLoginPage)
      Setter for the custom login page HTML code.
      Parameters:
      customLoginPage - the custom login page HTML code.

    • getCustomLoginPagePreview

      public String getCustomLoginPagePreview()
      Getter for the custom login page preview HTML code.
      Returns:
      the custom login page preview HTML code.

    • setCustomLoginPagePreview

      public void setCustomLoginPagePreview(String customLoginPagePreview)
      Setter for the custom login page preview HTML code.
      Parameters:
      customLoginPagePreview - the custom login page preview HTML code.

    • getFormTemplate

      public String getFormTemplate()
      Getter for the WS federation form template.
      Returns:
      the form template

    • setFormTemplate

      public void setFormTemplate(String formTemplate)
      Setter for the WS federation form template.
      Parameters:
      formTemplate - the form template to set.

    • getAddons

      public Addons getAddons()
      Getter for the addons or plugins associated with an application in Auth0.
      Returns:
      the addons for this application.

    • setAddons

      public void setAddons(Addons addons)
      Setter for the addons or plugins associated with an application in Auth0.
      Parameters:
      addons - the addons to set for this application.

    • getTokenEndpointAuthMethod

      public String getTokenEndpointAuthMethod()
      Getter for the requested authentication method for the token endpoint.
      Returns:
      the requested authentication method.

    • setTokenEndpointAuthMethod

      public void setTokenEndpointAuthMethod(String authMethod)
      Setter for the requested authentication method for the token endpoint. Possible values are 'none' (public application without a client secret), 'client_secret_post' (application uses HTTP POST parameters) or 'client_secret_basic' (application uses HTTP Basic).
      Parameters:
      authMethod - the authentication method to set.

    • getClientMetadata

      public Map<String,Object> getClientMetadata()
      Getter for the metadata associated with the application.
      Returns:
      the application metadata.

    • setClientMetadata

      public void setClientMetadata(Map<String,Object> clientMetadata)
      Setter for the metadata associated with the application, in the form of an object with string values (max 255 chars). Maximum of 10 metadata properties allowed.
      Parameters:
      clientMetadata - the application metadata to set.

    • getMobile

      public Mobile getMobile()
      Getter for the configuration related to native mobile apps.
      Returns:
      the mobile configuration.

    • setMobile

      public void setMobile(Mobile mobile)
      Setter for the configuration related to native mobile apps.
      Parameters:
      mobile - the mobile configuration to set.

    • getRefreshToken

      public RefreshToken getRefreshToken()
      Getter for the configuration related to refresh tokens.
      Returns:
      the refresh token configuration.

    • setRefreshToken

      public void setRefreshToken(RefreshToken refreshToken)
      Setter for the configuration related to refresh tokens.
      Parameters:
      refreshToken - the refresh token configuration to set.

    • getOrganizationUsage

      public String getOrganizationUsage()
      Returns:
      the organization usage value

    • setOrganizationUsage

      public void setOrganizationUsage(String organizationUsage)
      Sets the value of the organization_usage field
      Parameters:
      organizationUsage - the organization_usage value

    • getOrganizationRequireBehavior

      public String getOrganizationRequireBehavior()
      Returns:
      the organization require behavior value

    • setOrganizationRequireBehavior

      public void setOrganizationRequireBehavior(String organizationRequireBehavior)
      Sets the value of the organization_require_behavior field
      Parameters:
      organizationRequireBehavior - the organization_require_behavior value

    • setCrossOriginAuth

      public void setCrossOriginAuth(Boolean crossOriginAuth)
      Setter whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false).
      Parameters:
      crossOriginAuth - whether an application can make cross-origin authentication requests or not

    • getCrossOriginAuth

      public Boolean getCrossOriginAuth()
      Whether this client can be used to make cross-origin authentication requests (true) or it is not allowed to make such requests (false).
      Returns:
      true if application can make cross-origin authentication requests, false otherwise

    • setCrossOriginLoc

      public void setCrossOriginLoc(String crossOriginLoc)
      URL of the location in your site where the cross-origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page.
      Parameters:
      crossOriginLoc - url location for cross-origin verification

    • getCrossOriginLoc

      public String getCrossOriginLoc()
      Getter for the URL of the location in your site where the cross-origin verification takes place for the cross-origin auth flow when performing Auth in your own domain instead of Auth0 hosted login page.
      Returns:
      URL of the location in your site where the cross-origin verification takes place