Package com.okta.sdk.resource.model
Class Client
java.lang.Object
com.okta.sdk.resource.model.Client
- All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2024-09-23T16:19:57.008753975Z[Etc/UTC]",
comments="Generator version: 7.8.0")
public class Client
extends Object
implements Serializable
Client
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddgrantTypesItem
(GrantType grantTypesItem) addpostLogoutRedirectUrisItem
(String postLogoutRedirectUrisItem) addredirectUrisItem
(String redirectUrisItem) addrequestObjectSigningAlgItem
(SigningAlgorithm requestObjectSigningAlgItem) addresponseTypesItem
(ResponseType responseTypesItem) applicationType
(ApplicationType applicationType) clientName
(String clientName) boolean
frontchannelLogoutSessionRequired
(Boolean frontchannelLogoutSessionRequired) frontchannelLogoutUri
(String frontchannelLogoutUri) Get applicationTypeUnique key for the client application.Time at which the `client_id` was issued (measured in unix seconds)Human-readable string name of the client applicationOAuth 2.0 client secret string (used for confidential clients).org.openapitools.jackson.nullable.JsonNullable
<String> Time at which the `client_secret` expires or 0 if it doesn't expire (measured in unix seconds) minimum: 0org.openapitools.jackson.nullable.JsonNullable
<Integer> Include user session detailsURL where Okta sends the logout requestorg.openapitools.jackson.nullable.JsonNullable
<String> Array of OAuth 2.0 grant type strings.URL that a third party can use to initiate a login by the clientURL string that references a [JSON Web Key Set](https://tools.ietf.org/html/rfc7517#section-5) for validating JWTs presented to OktaURL string that references a logo for the client consent dialog (not the sign-in dialog)org.openapitools.jackson.nullable.JsonNullable
<String> URL string of a web page providing the client's policy documentorg.openapitools.jackson.nullable.JsonNullable
<String> Array of redirection URI strings for use for relying party initiated logoutsArray of redirection URI strings for use in redirect-based flows.The type of [JSON Web Key Set](https://tools.ietf.org/html/rfc7517#section-5) algorithm that must be used for signing request objectsArray of OAuth 2.0 response type strings.Get tokenEndpointAuthMethodURL string of a web page providing the client's terms of service documentorg.openapitools.jackson.nullable.JsonNullable
<String> grantTypes
(List<GrantType> grantTypes) int
hashCode()
initiateLoginUri
(String initiateLoginUri) postLogoutRedirectUris
(List<String> postLogoutRedirectUris) redirectUris
(List<String> redirectUris) requestObjectSigningAlg
(List<SigningAlgorithm> requestObjectSigningAlg) responseTypes
(List<ResponseType> responseTypes) void
setApplicationType
(ApplicationType applicationType) void
setClientName
(String clientName) void
setFrontchannelLogoutSessionRequired
(Boolean frontchannelLogoutSessionRequired) void
setFrontchannelLogoutUri
(String frontchannelLogoutUri) void
setFrontchannelLogoutUri_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> frontchannelLogoutUri) void
setGrantTypes
(List<GrantType> grantTypes) void
setInitiateLoginUri
(String initiateLoginUri) void
setJwksUri
(String jwksUri) void
setLogoUri
(String logoUri) void
setLogoUri_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> logoUri) void
setPolicyUri
(String policyUri) void
setPolicyUri_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> policyUri) void
setPostLogoutRedirectUris
(List<String> postLogoutRedirectUris) void
setRedirectUris
(List<String> redirectUris) void
setRequestObjectSigningAlg
(List<SigningAlgorithm> requestObjectSigningAlg) void
setResponseTypes
(List<ResponseType> responseTypes) void
setTokenEndpointAuthMethod
(EndpointAuthMethod tokenEndpointAuthMethod) void
void
setTosUri_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<String> tosUri) tokenEndpointAuthMethod
(EndpointAuthMethod tokenEndpointAuthMethod) toString()
-
Field Details
-
JSON_PROPERTY_APPLICATION_TYPE
- See Also:
-
JSON_PROPERTY_CLIENT_ID
- See Also:
-
JSON_PROPERTY_CLIENT_ID_ISSUED_AT
- See Also:
-
JSON_PROPERTY_CLIENT_NAME
- See Also:
-
JSON_PROPERTY_CLIENT_SECRET
- See Also:
-
JSON_PROPERTY_CLIENT_SECRET_EXPIRES_AT
- See Also:
-
JSON_PROPERTY_FRONTCHANNEL_LOGOUT_SESSION_REQUIRED
- See Also:
-
JSON_PROPERTY_FRONTCHANNEL_LOGOUT_URI
- See Also:
-
JSON_PROPERTY_GRANT_TYPES
- See Also:
-
JSON_PROPERTY_INITIATE_LOGIN_URI
- See Also:
-
JSON_PROPERTY_JWKS_URI
- See Also:
-
JSON_PROPERTY_LOGO_URI
- See Also:
-
JSON_PROPERTY_POLICY_URI
- See Also:
-
JSON_PROPERTY_POST_LOGOUT_REDIRECT_URIS
- See Also:
-
JSON_PROPERTY_REDIRECT_URIS
- See Also:
-
JSON_PROPERTY_REQUEST_OBJECT_SIGNING_ALG
- See Also:
-
JSON_PROPERTY_RESPONSE_TYPES
- See Also:
-
JSON_PROPERTY_TOKEN_ENDPOINT_AUTH_METHOD
- See Also:
-
JSON_PROPERTY_TOS_URI
- See Also:
-
-
Constructor Details
-
Client
public Client()
-
-
Method Details
-
applicationType
-
getApplicationType
Get applicationType- Returns:
- applicationType
-
setApplicationType
-
getClientId
Unique key for the client application. The `client_id` is immutable. When you create a client Application, you can't specify the `client_id` because Okta uses the application ID for the `client_id`.- Returns:
- clientId
-
getClientIdIssuedAt
Time at which the `client_id` was issued (measured in unix seconds)- Returns:
- clientIdIssuedAt
-
clientName
-
getClientName
Human-readable string name of the client application- Returns:
- clientName
-
setClientName
-
getClientSecret
OAuth 2.0 client secret string (used for confidential clients). The `client_secret` is shown only on the response of the creation or update of a client Application (and only if the `token_endpoint_auth_method` is one that requires a client secret). You can't specify the `client_secret`. If the `token_endpoint_auth_method` requires one, Okta generates a random `client_secret` for the client Application.- Returns:
- clientSecret
-
getClientSecret_JsonNullable
-
getClientSecretExpiresAt
Time at which the `client_secret` expires or 0 if it doesn't expire (measured in unix seconds) minimum: 0- Returns:
- clientSecretExpiresAt
-
getClientSecretExpiresAt_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<Integer> getClientSecretExpiresAt_JsonNullable() -
frontchannelLogoutSessionRequired
-
getFrontchannelLogoutSessionRequired
Include user session details- Returns:
- frontchannelLogoutSessionRequired
-
setFrontchannelLogoutSessionRequired
-
frontchannelLogoutUri
-
getFrontchannelLogoutUri
URL where Okta sends the logout request- Returns:
- frontchannelLogoutUri
-
getFrontchannelLogoutUri_JsonNullable
public org.openapitools.jackson.nullable.JsonNullable<String> getFrontchannelLogoutUri_JsonNullable() -
setFrontchannelLogoutUri_JsonNullable
public void setFrontchannelLogoutUri_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> frontchannelLogoutUri) -
setFrontchannelLogoutUri
-
grantTypes
-
addgrantTypesItem
-
getGrantTypes
Array of OAuth 2.0 grant type strings. Default value: `[authorization_code]`- Returns:
- grantTypes
-
setGrantTypes
-
initiateLoginUri
-
getInitiateLoginUri
URL that a third party can use to initiate a login by the client- Returns:
- initiateLoginUri
-
setInitiateLoginUri
-
jwksUri
-
getJwksUri
URL string that references a [JSON Web Key Set](https://tools.ietf.org/html/rfc7517#section-5) for validating JWTs presented to Okta- Returns:
- jwksUri
-
setJwksUri
-
logoUri
-
getLogoUri
URL string that references a logo for the client consent dialog (not the sign-in dialog)- Returns:
- logoUri
-
getLogoUri_JsonNullable
-
setLogoUri_JsonNullable
-
setLogoUri
-
policyUri
-
getPolicyUri
URL string of a web page providing the client's policy document- Returns:
- policyUri
-
getPolicyUri_JsonNullable
-
setPolicyUri_JsonNullable
public void setPolicyUri_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> policyUri) -
setPolicyUri
-
postLogoutRedirectUris
-
addpostLogoutRedirectUrisItem
-
getPostLogoutRedirectUris
Array of redirection URI strings for use for relying party initiated logouts- Returns:
- postLogoutRedirectUris
-
setPostLogoutRedirectUris
-
redirectUris
-
addredirectUrisItem
-
getRedirectUris
Array of redirection URI strings for use in redirect-based flows. All redirect URIs must be absolute URIs and must not include a fragment component. At least one redirect URI and response type is required for all client types, with the following exceptions: If the client uses the Resource Owner Password flow (if `grant_type` contains the value password) or the Client Credentials flow (if `grant_type` contains the value `client_credentials`), then no redirect URI or response type is necessary. In these cases, you can pass either null or an empty array for these attributes.- Returns:
- redirectUris
-
setRedirectUris
-
requestObjectSigningAlg
-
addrequestObjectSigningAlgItem
-
getRequestObjectSigningAlg
The type of [JSON Web Key Set](https://tools.ietf.org/html/rfc7517#section-5) algorithm that must be used for signing request objects- Returns:
- requestObjectSigningAlg
-
setRequestObjectSigningAlg
-
responseTypes
-
addresponseTypesItem
-
getResponseTypes
Array of OAuth 2.0 response type strings. Default value: `[code]`- Returns:
- responseTypes
-
setResponseTypes
-
tokenEndpointAuthMethod
-
getTokenEndpointAuthMethod
Get tokenEndpointAuthMethod- Returns:
- tokenEndpointAuthMethod
-
setTokenEndpointAuthMethod
-
tosUri
-
getTosUri
URL string of a web page providing the client's terms of service document- Returns:
- tosUri
-
getTosUri_JsonNullable
-
setTosUri_JsonNullable
-
setTosUri
-
equals
-
hashCode
public int hashCode() -
toString
-