Package com.auth0.json.mgmt.client
Class Client
java.lang.Object
com.auth0.json.mgmt.client.Client
Class that represents an Auth0 Application object. Related to the
ClientsEntity
entity.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGetter for the addons or plugins associated with an application in Auth0.Getter for the list of applications that will be allowed to make a delegation request.Getter for the application list of URLs that are valid to redirect to after logout from Auth0.Getter for the list of allowed origins for the application.Getter for the type that this application represents.Getter for the list of allowed callback urls for the application.Getter for the list of application aliases.Getter for the application's client id.Getter for the metadata associated with the application.Getter for the application's client secret.Getter for the custom login page HTML code.Getter for the custom login page preview HTML code.Getter for the description of the application.Getter for the encryption Key.Getter for the WS federation form template.Getter for the list of grant types for the application.Getter for the initiate login URI.Getter for the JWT configuration object.Getter for the URI of the application logo.Getter for the configuration related to native mobile apps.getName()
Getter for the name of the application.Getter for the configuration related to refresh tokens.Getter for the application signing keys.Getter for the requested authentication method for the token endpoint.Getter for the list of web origins for the application.Whether this application is a first party client or not.Whether this application is a Heroku application or not.Whether this application will conform to strict Open ID Connect specifications or not.Whether Single Sign On is disabled or not for this application.void
Setter for the addons or plugins associated with an application in Auth0.void
setAllowedClients(List<String> allowedClients)
Setter for the list of applications that will be allowed to make a delegation request.void
setAllowedLogoutUrls(List<String> allowedLogoutUrls)
Setter for the application list of URLs that are valid to redirect to after logout from Auth0.void
setAllowedOrigins(List<String> allowedOrigins)
Setter for the list of allowed origins for the application.void
setAppType(String appType)
Setter for the type that this application represents.void
setCallbacks(List<String> callbacks)
Setter for the list of allowed callback urls for the application.void
setClientAliases(List<String> clientAliases)
Setter for the list of application aliases.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).void
setClientSecret(String clientSecret)
Setter for the application's client secret.void
setCustomLoginPage(String customLoginPage)
Setter for the custom login page HTML code.void
setCustomLoginPagePreview(String customLoginPagePreview)
Setter for the custom login page preview HTML code.void
setDescription(String description)
Setter for the description of the application.void
setEncryptionKey(EncryptionKey encryptionKey)
Setter for the encryption Key.void
setFormTemplate(String formTemplate)
Setter for the WS federation form template.void
setGrantTypes(List<String> grantTypes)
Setter for the list of grant types for the application.void
setInitiateLoginUri(String initiateLoginUri)
Setter for the initiate login URI.void
setIsFirstParty(Boolean isFirstParty)
Setter for whether this application is a first party client or not.void
setJWTConfiguration(JWTConfiguration jwtConfiguration)
Setter for the JWT configuration object.void
setLogoUri(String logoUri)
Setter for the application logo URI.void
Setter for the configuration related to native mobile apps.void
Setter for the application name.void
setOIDCConformant(Boolean oidcConformant)
Setter for the strict conform to the Open ID Connect specifications.void
setOrganizationRequireBehavior(String organizationRequireBehavior)
Sets the value of the organization_require_behavior fieldvoid
setOrganizationUsage(String organizationUsage)
Sets the value of the organization_usage fieldvoid
setRefreshToken(RefreshToken refreshToken)
Setter for the configuration related to refresh tokens.void
setSSODisabled(Boolean ssoDisabled)
Sets if Single Sign On is disabled for this application or not.void
setTokenEndpointAuthMethod(String authMethod)
Setter for the requested authentication method for the token endpoint.void
setUseAuth0SSO(Boolean useAuth0SSO)
Sets if Auth0 will do Single Sign On instead of the Identity Provider.void
setUseCustomLoginPage(Boolean useCustomLoginPage)
Sets if this application should use a custom login page or the default one.void
setWebOrigins(List<String> webOrigins)
Setter for the list of web origins for the application.Whether to use Auth0 instead of the Identity Provider to do Single Sign On or not.Whether to use a custom login page or the default one.
-
Constructor Details
-
Client
Creates a new Application instance setting the name property.- Parameters:
name
- of the application.
-
-
Method Details
-
getName
Getter for the name of the application.- Returns:
- the name.
-
setName
Setter for the application name.- Parameters:
name
- the name to use.
-
getDescription
Getter for the description of the application.- Returns:
- the description.
-
setDescription
Setter for the description of the application.- Parameters:
description
- the description to use.
-
getClientId
Getter for the application's client id.- Returns:
- the application's client id.
-
getClientSecret
Getter for the application's client secret.- Returns:
- the application's client secret.
-
setClientSecret
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
Getter for the type that this application represents.- Returns:
- the application's type.
-
setAppType
Setter for the type that this application represents.- Parameters:
appType
- the application type to set.
-
getLogoUri
Getter for the URI of the application logo.- Returns:
- the application's logo URI.
-
setLogoUri
Setter for the application logo URI. An image with size 150x150 is recommended.- Parameters:
logoUri
- the logo URI to set.
-
isFirstParty
Whether this application is a first party client or not.- Returns:
- true if the application is first party, false otherwise.
-
setIsFirstParty
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
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
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
Getter for the list of allowed callback urls for the application.- Returns:
- the list of callback urls.
-
setCallbacks
Setter for the list of allowed callback urls for the application.- Parameters:
callbacks
- the allowed callback urls to set.
-
getAllowedOrigins
Getter for the list of allowed origins for the application.- Returns:
- the list of allowed origins.
-
setAllowedOrigins
Setter for the list of allowed origins for the application.- Parameters:
allowedOrigins
- the allowed callback urls to set.
-
setWebOrigins
Setter for the list of web origins for the application.- Parameters:
webOrigins
- the web origins to set.
-
getWebOrigins
Getter for the list of web origins for the application.- Returns:
- the list of web origins.
-
setGrantTypes
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
Getter for the list of grant types for the application.- Returns:
- the list of grant types.
-
getClientAliases
Getter for the list of application aliases.- Returns:
- the list of application aliases.
-
setClientAliases
Setter for the list of application aliases.- Parameters:
clientAliases
- the application aliases to set.
-
getAllowedClients
Getter for the list of applications that will be allowed to make a delegation request.- Returns:
- the list of allowed applications.
-
setAllowedClients
Setter for the list of applications that will be allowed to make a delegation request.- Parameters:
allowedClients
- the list of allowed application.
-
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
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
Getter for the JWT configuration object.- Returns:
- the JWT Configuration.
-
setJWTConfiguration
Setter for the JWT configuration object.- Parameters:
jwtConfiguration
- the JWT configuration to set.
-
getSigningKeys
Getter for the application signing keys.- Returns:
- the application signing keys.
-
getEncryptionKey
Getter for the encryption Key.- Returns:
- the encryption key.
-
setEncryptionKey
Setter for the encryption Key.- Parameters:
encryptionKey
- the encryption key.
-
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
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
Whether Single Sign On is disabled or not for this application.- Returns:
- true is SSO is disabled for this application, false otherwise.
-
setSSODisabled
Sets if Single Sign On is disabled for this application or not.- Parameters:
ssoDisabled
- whether SSO is disabled for this application or not.
-
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
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
Getter for the initiate login URI.- Returns:
- the initiate login URI.
-
setInitiateLoginUri
Setter for the initiate login URI.- Parameters:
initiateLoginUri
- the initiate login URI to set.
-
isHerokuApp
Whether this application is a Heroku application or not.- Returns:
- true if this application is a Heroku application, false otherwise.
-
getCustomLoginPage
Getter for the custom login page HTML code.- Returns:
- the custom login page HTML code.
-
setCustomLoginPage
Setter for the custom login page HTML code.- Parameters:
customLoginPage
- the custom login page HTML code.
-
getCustomLoginPagePreview
Getter for the custom login page preview HTML code.- Returns:
- the custom login page preview HTML code.
-
setCustomLoginPagePreview
Setter for the custom login page preview HTML code.- Parameters:
customLoginPagePreview
- the custom login page preview HTML code.
-
getFormTemplate
Getter for the WS federation form template.- Returns:
- the form template
-
setFormTemplate
Setter for the WS federation form template.- Parameters:
formTemplate
- the form template to set.
-
getAddons
Getter for the addons or plugins associated with an application in Auth0.- Returns:
- the addons for this application.
-
setAddons
Setter for the addons or plugins associated with an application in Auth0.- Parameters:
addons
- the addons to set for this application.
-
getTokenEndpointAuthMethod
Getter for the requested authentication method for the token endpoint.- Returns:
- the requested authentication method.
-
setTokenEndpointAuthMethod
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
Getter for the metadata associated with the application.- Returns:
- the application metadata.
-
setClientMetadata
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
Getter for the configuration related to native mobile apps.- Returns:
- the mobile configuration.
-
setMobile
Setter for the configuration related to native mobile apps.- Parameters:
mobile
- the mobile configuration to set.
-
getRefreshToken
Getter for the configuration related to refresh tokens.- Returns:
- the refresh token configuration.
-
setRefreshToken
Setter for the configuration related to refresh tokens.- Parameters:
refreshToken
- the refresh token configuration to set.
-
getOrganizationUsage
- Returns:
- the organization usage value
-
setOrganizationUsage
Sets the value of the organization_usage field- Parameters:
organizationUsage
- the organization_usage value
-
getOrganizationRequireBehavior
- Returns:
- the organization require behavior value
-
setOrganizationRequireBehavior
Sets the value of the organization_require_behavior field- Parameters:
organizationRequireBehavior
- the organization_require_behavior value
-