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-08-09T14:20:25.727262-05:00[America/Chicago]",
           comments="Generator version: 7.7.0")
public class Client
extends Object
implements Serializable

Client

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_APPLICATION_TYPE
static final String	JSON_PROPERTY_CLIENT_ID
static final String	JSON_PROPERTY_CLIENT_ID_ISSUED_AT
static final String	JSON_PROPERTY_CLIENT_NAME
static final String	JSON_PROPERTY_CLIENT_SECRET
static final String	JSON_PROPERTY_CLIENT_SECRET_EXPIRES_AT
static final String	JSON_PROPERTY_FRONTCHANNEL_LOGOUT_SESSION_REQUIRED
static final String	JSON_PROPERTY_FRONTCHANNEL_LOGOUT_URI
static final String	JSON_PROPERTY_GRANT_TYPES
static final String	JSON_PROPERTY_INITIATE_LOGIN_URI
static final String	JSON_PROPERTY_JWKS_URI
static final String	JSON_PROPERTY_LOGO_URI
static final String	JSON_PROPERTY_POLICY_URI
static final String	JSON_PROPERTY_POST_LOGOUT_REDIRECT_URIS
static final String	JSON_PROPERTY_REDIRECT_URIS
static final String	JSON_PROPERTY_REQUEST_OBJECT_SIGNING_ALG
static final String	JSON_PROPERTY_RESPONSE_TYPES
static final String	JSON_PROPERTY_TOKEN_ENDPOINT_AUTH_METHOD
static final String	JSON_PROPERTY_TOS_URI

Constructor Summary

Constructors

Constructor	Description
Client()

Method Summary

Modifier and Type	Method	Description
Client	addgrantTypesItem(GrantType grantTypesItem)
Client	addpostLogoutRedirectUrisItem(String postLogoutRedirectUrisItem)
Client	addredirectUrisItem(String redirectUrisItem)
Client	addrequestObjectSigningAlgItem(SigningAlgorithm requestObjectSigningAlgItem)
Client	addresponseTypesItem(ResponseType responseTypesItem)
Client	applicationType(ApplicationType applicationType)
Client	clientName(String clientName)
boolean	equals(Object o)
Client	frontchannelLogoutSessionRequired(Boolean frontchannelLogoutSessionRequired)
Client	frontchannelLogoutUri(String frontchannelLogoutUri)
ApplicationType	getApplicationType()	Get applicationType
String	getClientId()	Unique key for the client application.
Integer	getClientIdIssuedAt()	Time at which the `client_id` was issued (measured in unix seconds)
String	getClientName()	Human-readable string name of the client application
String	getClientSecret()	OAuth 2.0 client secret string (used for confidential clients).
org.openapitools.jackson.nullable.JsonNullable<String>	getClientSecret_JsonNullable()
Integer	getClientSecretExpiresAt()	Time at which the `client_secret` expires or 0 if it doesn't expire (measured in unix seconds) minimum: 0
org.openapitools.jackson.nullable.JsonNullable<Integer>	getClientSecretExpiresAt_JsonNullable()
Boolean	getFrontchannelLogoutSessionRequired()	Include user session details
String	getFrontchannelLogoutUri()	URL where Okta sends the logout request
org.openapitools.jackson.nullable.JsonNullable<String>	getFrontchannelLogoutUri_JsonNullable()
List<GrantType>	getGrantTypes()	Array of OAuth 2.0 grant type strings.
String	getInitiateLoginUri()	URL that a third party can use to initiate a login by the client
String	getJwksUri()	URL string that references a [JSON Web Key Set](https://tools.ietf.org/html/rfc7517#section-5) for validating JWTs presented to Okta
String	getLogoUri()	URL string that references a logo for the client consent dialog (not the sign-in dialog)
org.openapitools.jackson.nullable.JsonNullable<String>	getLogoUri_JsonNullable()
String	getPolicyUri()	URL string of a web page providing the client's policy document
org.openapitools.jackson.nullable.JsonNullable<String>	getPolicyUri_JsonNullable()
List<String>	getPostLogoutRedirectUris()	Array of redirection URI strings for use for relying party initiated logouts
List<String>	getRedirectUris()	Array of redirection URI strings for use in redirect-based flows.
List<SigningAlgorithm>	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
List<ResponseType>	getResponseTypes()	Array of OAuth 2.0 response type strings.
EndpointAuthMethod	getTokenEndpointAuthMethod()	Get tokenEndpointAuthMethod
String	getTosUri()	URL string of a web page providing the client's terms of service document
org.openapitools.jackson.nullable.JsonNullable<String>	getTosUri_JsonNullable()
Client	grantTypes(List<GrantType> grantTypes)
int	hashCode()
Client	initiateLoginUri(String initiateLoginUri)
Client	jwksUri(String jwksUri)
Client	logoUri(String logoUri)
Client	policyUri(String policyUri)
Client	postLogoutRedirectUris(List<String> postLogoutRedirectUris)
Client	redirectUris(List<String> redirectUris)
Client	requestObjectSigningAlg(List<SigningAlgorithm> requestObjectSigningAlg)
Client	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	setTosUri(String tosUri)
void	setTosUri_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> tosUri)
Client	tokenEndpointAuthMethod(EndpointAuthMethod tokenEndpointAuthMethod)
String	toString()
Client	tosUri(String tosUri)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_APPLICATION_TYPE

public static final String JSON_PROPERTY_APPLICATION_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_CLIENT_ID

public static final String JSON_PROPERTY_CLIENT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_CLIENT_ID_ISSUED_AT

public static final String JSON_PROPERTY_CLIENT_ID_ISSUED_AT

See Also:

• Constant Field Values

JSON_PROPERTY_CLIENT_NAME

public static final String JSON_PROPERTY_CLIENT_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_CLIENT_SECRET

public static final String JSON_PROPERTY_CLIENT_SECRET

See Also:

• Constant Field Values

JSON_PROPERTY_CLIENT_SECRET_EXPIRES_AT

public static final String JSON_PROPERTY_CLIENT_SECRET_EXPIRES_AT

See Also:

• Constant Field Values

JSON_PROPERTY_FRONTCHANNEL_LOGOUT_SESSION_REQUIRED

public static final String JSON_PROPERTY_FRONTCHANNEL_LOGOUT_SESSION_REQUIRED

See Also:

• Constant Field Values

JSON_PROPERTY_FRONTCHANNEL_LOGOUT_URI

public static final String JSON_PROPERTY_FRONTCHANNEL_LOGOUT_URI

See Also:

• Constant Field Values

JSON_PROPERTY_GRANT_TYPES

public static final String JSON_PROPERTY_GRANT_TYPES

See Also:

• Constant Field Values

JSON_PROPERTY_INITIATE_LOGIN_URI

public static final String JSON_PROPERTY_INITIATE_LOGIN_URI

See Also:

• Constant Field Values

JSON_PROPERTY_JWKS_URI

public static final String JSON_PROPERTY_JWKS_URI

See Also:

• Constant Field Values

JSON_PROPERTY_LOGO_URI

public static final String JSON_PROPERTY_LOGO_URI

See Also:

• Constant Field Values

JSON_PROPERTY_POLICY_URI

public static final String JSON_PROPERTY_POLICY_URI

See Also:

• Constant Field Values

JSON_PROPERTY_POST_LOGOUT_REDIRECT_URIS

public static final String JSON_PROPERTY_POST_LOGOUT_REDIRECT_URIS

See Also:

• Constant Field Values

JSON_PROPERTY_REDIRECT_URIS

public static final String JSON_PROPERTY_REDIRECT_URIS

See Also:

• Constant Field Values

JSON_PROPERTY_REQUEST_OBJECT_SIGNING_ALG

public static final String JSON_PROPERTY_REQUEST_OBJECT_SIGNING_ALG

See Also:

• Constant Field Values

JSON_PROPERTY_RESPONSE_TYPES

public static final String JSON_PROPERTY_RESPONSE_TYPES

See Also:

• Constant Field Values

JSON_PROPERTY_TOKEN_ENDPOINT_AUTH_METHOD

public static final String JSON_PROPERTY_TOKEN_ENDPOINT_AUTH_METHOD

See Also:

• Constant Field Values

JSON_PROPERTY_TOS_URI

public static final String JSON_PROPERTY_TOS_URI

See Also:

• Constant Field Values

Constructor Details

Client

public Client()

Method Details

applicationType

public Client applicationType(ApplicationType applicationType)

getApplicationType

@Nullable
public ApplicationType getApplicationType()

Get applicationType

Returns:

applicationType

setApplicationType

public void setApplicationType(ApplicationType applicationType)

getClientId

@Nullable
public String 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

@Nullable
public Integer getClientIdIssuedAt()

Time at which the `client_id` was issued (measured in unix seconds)

Returns:

clientIdIssuedAt

clientName

public Client clientName(String clientName)

getClientName

@Nullable
public String getClientName()

Human-readable string name of the client application

Returns:

clientName

setClientName

public void setClientName(String clientName)

getClientSecret

@Nullable
public String 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

public org.openapitools.jackson.nullable.JsonNullable<String> getClientSecret_JsonNullable()

getClientSecretExpiresAt

@Nullable
public Integer 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

public Client frontchannelLogoutSessionRequired(Boolean frontchannelLogoutSessionRequired)

getFrontchannelLogoutSessionRequired

@Nullable
public Boolean getFrontchannelLogoutSessionRequired()

Include user session details

Returns:

frontchannelLogoutSessionRequired

setFrontchannelLogoutSessionRequired

public void setFrontchannelLogoutSessionRequired(Boolean frontchannelLogoutSessionRequired)

frontchannelLogoutUri

public Client frontchannelLogoutUri(String frontchannelLogoutUri)

getFrontchannelLogoutUri

@Nullable
public String 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

public void setFrontchannelLogoutUri(String frontchannelLogoutUri)

grantTypes

public Client grantTypes(List<GrantType> grantTypes)

addgrantTypesItem

public Client addgrantTypesItem(GrantType grantTypesItem)

getGrantTypes

@Nullable
public List<GrantType> getGrantTypes()

Array of OAuth 2.0 grant type strings. Default value: `[authorization_code]`

Returns:

grantTypes

setGrantTypes

public void setGrantTypes(List<GrantType> grantTypes)

initiateLoginUri

public Client initiateLoginUri(String initiateLoginUri)

getInitiateLoginUri

@Nullable
public String getInitiateLoginUri()

URL that a third party can use to initiate a login by the client

Returns:

initiateLoginUri

setInitiateLoginUri

public void setInitiateLoginUri(String initiateLoginUri)

jwksUri

public Client jwksUri(String jwksUri)

getJwksUri

@Nullable
public String 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

public void setJwksUri(String jwksUri)

logoUri

public Client logoUri(String logoUri)

getLogoUri

@Nullable
public String getLogoUri()

URL string that references a logo for the client consent dialog (not the sign-in dialog)

Returns:

logoUri

getLogoUri_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<String> getLogoUri_JsonNullable()

setLogoUri_JsonNullable

public void setLogoUri_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> logoUri)

setLogoUri

public void setLogoUri(String logoUri)

policyUri

public Client policyUri(String policyUri)

getPolicyUri

@Nullable
public String getPolicyUri()

URL string of a web page providing the client's policy document

Returns:

policyUri

getPolicyUri_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<String> getPolicyUri_JsonNullable()

setPolicyUri_JsonNullable

public void setPolicyUri_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> policyUri)

setPolicyUri

public void setPolicyUri(String policyUri)

postLogoutRedirectUris

public Client postLogoutRedirectUris(List<String> postLogoutRedirectUris)

addpostLogoutRedirectUrisItem

public Client addpostLogoutRedirectUrisItem(String postLogoutRedirectUrisItem)

getPostLogoutRedirectUris

@Nullable
public List<String> getPostLogoutRedirectUris()

Array of redirection URI strings for use for relying party initiated logouts

Returns:

postLogoutRedirectUris

setPostLogoutRedirectUris

public void setPostLogoutRedirectUris(List<String> postLogoutRedirectUris)

redirectUris

public Client redirectUris(List<String> redirectUris)

addredirectUrisItem

public Client addredirectUrisItem(String redirectUrisItem)

getRedirectUris

@Nullable
public List<String> 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

public void setRedirectUris(List<String> redirectUris)

requestObjectSigningAlg

public Client requestObjectSigningAlg(List<SigningAlgorithm> requestObjectSigningAlg)

addrequestObjectSigningAlgItem

public Client addrequestObjectSigningAlgItem(SigningAlgorithm requestObjectSigningAlgItem)

getRequestObjectSigningAlg

@Nullable
public List<SigningAlgorithm> 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

public void setRequestObjectSigningAlg(List<SigningAlgorithm> requestObjectSigningAlg)

responseTypes

public Client responseTypes(List<ResponseType> responseTypes)

addresponseTypesItem

public Client addresponseTypesItem(ResponseType responseTypesItem)

getResponseTypes

@Nullable
public List<ResponseType> getResponseTypes()

Array of OAuth 2.0 response type strings. Default value: `[code]`

Returns:

responseTypes

setResponseTypes

public void setResponseTypes(List<ResponseType> responseTypes)

tokenEndpointAuthMethod

public Client tokenEndpointAuthMethod(EndpointAuthMethod tokenEndpointAuthMethod)

getTokenEndpointAuthMethod

@Nullable
public EndpointAuthMethod getTokenEndpointAuthMethod()

Get tokenEndpointAuthMethod

Returns:

tokenEndpointAuthMethod

setTokenEndpointAuthMethod

public void setTokenEndpointAuthMethod(EndpointAuthMethod tokenEndpointAuthMethod)

tosUri

public Client tosUri(String tosUri)

getTosUri

@Nullable
public String getTosUri()

URL string of a web page providing the client's terms of service document

Returns:

tosUri

getTosUri_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<String> getTosUri_JsonNullable()

setTosUri_JsonNullable

public void setTosUri_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<String> tosUri)

setTosUri

public void setTosUri(String tosUri)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object