Package com.okta.sdk.resource.model
Class OpenIdConnectApplicationSettingsClient
java.lang.Object
com.okta.sdk.resource.model.OpenIdConnectApplicationSettingsClient
- 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 OpenIdConnectApplicationSettingsClient
extends Object
implements Serializable
OpenIdConnectApplicationSettingsClient
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumThe signing algorithm for Client-Initiated Backchannel Authentication (CIBA) signed requests using JWT.static enumThe delivery mode for Client-Initiated Backchannel Authentication (CIBA).static enumThe type of JSON Web Key Set (JWKS) algorithm that must be used for signing request objectsstatic enumType of the subjectstatic enumIndicates if the client is allowed to use wildcard matching of `redirect_uris` -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddgrantTypesItem(OAuthGrantType grantTypesItem) addpostLogoutRedirectUrisItem(String postLogoutRedirectUrisItem) addredirectUrisItem(String redirectUrisItem) addresponseTypesItem(OAuthResponseType responseTypesItem) applicationType(OpenIdConnectApplicationType applicationType) backchannelAuthenticationRequestSigningAlg(OpenIdConnectApplicationSettingsClient.BackchannelAuthenticationRequestSigningAlgEnum backchannelAuthenticationRequestSigningAlg) backchannelCustomAuthenticatorId(String backchannelCustomAuthenticatorId) backchannelTokenDeliveryMode(OpenIdConnectApplicationSettingsClient.BackchannelTokenDeliveryModeEnum backchannelTokenDeliveryMode) consentMethod(OpenIdConnectApplicationConsentMethod consentMethod) dpopBoundAccessTokens(Boolean dpopBoundAccessTokens) booleanfrontchannelLogoutSessionRequired(Boolean frontchannelLogoutSessionRequired) frontchannelLogoutUri(String frontchannelLogoutUri) Get applicationTypeThe signing algorithm for Client-Initiated Backchannel Authentication (CIBA) signed requests using JWT.The ID of the custom authenticator that authenticates the user > **Note:** This property appears for clients with `urn:openid:params:grant-type:ciba` defined as one of the `grant_types`.The delivery mode for Client-Initiated Backchannel Authentication (CIBA).URL string of a web page providing information about the clientGet consentMethodIndicates that the client application uses Demonstrating Proof-of-Possession (DPoP) for token requests.<div class=\"x-lifecycle-container\"><x-lifecycle class=\"ea\"></x-lifecycle> <x-lifecycle class=\"oie\"></x-lifecycle></div>Determines whether Okta sends `sid` and `iss` in the logout request<div class=\"x-lifecycle-container\"><x-lifecycle class=\"ea\"></x-lifecycle> <x-lifecycle class=\"oie\"></x-lifecycle></div>URL where Okta sends the logout requestGet grantTypesGet idpInitiatedLoginURL string that a third party can use to initiate the sign-in flow by the clientGet issuerModegetJwks()Get jwksURL string that references a JSON Web Key Set for validating JWTs presented to OktaThe URL string that references a logo for the client.<div class=\"x-lifecycle-container\"><x-lifecycle class=\"ea\"></x-lifecycle> <x-lifecycle class=\"oie\"></x-lifecycle></div>Allows the app to participate in front-channel Single Logout > **Note:** You can only enable `participate_slo` for `web` and `browser` application types (`application_type`).URL string of a web page providing the client's policy documentArray of redirection URI strings for relying party-initiated logoutsArray of redirection URI strings for use in redirect-based flows.Get refreshTokenThe type of JSON Web Key Set (JWKS) algorithm that must be used for signing request objectsArray of OAuth 2.0 response type stringsThe sector identifier used for pairwise `subject_type`.Type of the subjectURL string of a web page providing the client's terms of service documentIndicates if the client is allowed to use wildcard matching of `redirect_uris`grantTypes(List<OAuthGrantType> grantTypes) inthashCode()idpInitiatedLogin(OpenIdConnectApplicationIdpInitiatedLogin idpInitiatedLogin) initiateLoginUri(String initiateLoginUri) issuerMode(OpenIdConnectApplicationIssuerMode issuerMode) participateSlo(Boolean participateSlo) postLogoutRedirectUris(List<String> postLogoutRedirectUris) redirectUris(List<String> redirectUris) refreshToken(OpenIdConnectApplicationSettingsRefreshToken refreshToken) requestObjectSigningAlg(OpenIdConnectApplicationSettingsClient.RequestObjectSigningAlgEnum requestObjectSigningAlg) responseTypes(List<OAuthResponseType> responseTypes) sectorIdentifierUri(String sectorIdentifierUri) voidsetApplicationType(OpenIdConnectApplicationType applicationType) voidsetBackchannelAuthenticationRequestSigningAlg(OpenIdConnectApplicationSettingsClient.BackchannelAuthenticationRequestSigningAlgEnum backchannelAuthenticationRequestSigningAlg) voidsetBackchannelCustomAuthenticatorId(String backchannelCustomAuthenticatorId) voidsetBackchannelTokenDeliveryMode(OpenIdConnectApplicationSettingsClient.BackchannelTokenDeliveryModeEnum backchannelTokenDeliveryMode) voidsetClientUri(String clientUri) voidsetConsentMethod(OpenIdConnectApplicationConsentMethod consentMethod) voidsetDpopBoundAccessTokens(Boolean dpopBoundAccessTokens) voidsetFrontchannelLogoutSessionRequired(Boolean frontchannelLogoutSessionRequired) voidsetFrontchannelLogoutUri(String frontchannelLogoutUri) voidsetGrantTypes(List<OAuthGrantType> grantTypes) voidsetIdpInitiatedLogin(OpenIdConnectApplicationIdpInitiatedLogin idpInitiatedLogin) voidsetInitiateLoginUri(String initiateLoginUri) voidsetIssuerMode(OpenIdConnectApplicationIssuerMode issuerMode) voidvoidsetJwksUri(String jwksUri) voidsetLogoUri(String logoUri) voidsetParticipateSlo(Boolean participateSlo) voidsetPolicyUri(String policyUri) voidsetPostLogoutRedirectUris(List<String> postLogoutRedirectUris) voidsetRedirectUris(List<String> redirectUris) voidsetRefreshToken(OpenIdConnectApplicationSettingsRefreshToken refreshToken) voidsetRequestObjectSigningAlg(OpenIdConnectApplicationSettingsClient.RequestObjectSigningAlgEnum requestObjectSigningAlg) voidsetResponseTypes(List<OAuthResponseType> responseTypes) voidsetSectorIdentifierUri(String sectorIdentifierUri) voidvoidvoidtoString()wildcardRedirect(OpenIdConnectApplicationSettingsClient.WildcardRedirectEnum wildcardRedirect)
-
Field Details
-
JSON_PROPERTY_APPLICATION_TYPE
- See Also:
-
JSON_PROPERTY_BACKCHANNEL_AUTHENTICATION_REQUEST_SIGNING_ALG
- See Also:
-
JSON_PROPERTY_BACKCHANNEL_CUSTOM_AUTHENTICATOR_ID
- See Also:
-
JSON_PROPERTY_BACKCHANNEL_TOKEN_DELIVERY_MODE
- See Also:
-
JSON_PROPERTY_CLIENT_URI
- See Also:
-
JSON_PROPERTY_CONSENT_METHOD
- See Also:
-
JSON_PROPERTY_DPOP_BOUND_ACCESS_TOKENS
- 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_IDP_INITIATED_LOGIN
- See Also:
-
JSON_PROPERTY_INITIATE_LOGIN_URI
- See Also:
-
JSON_PROPERTY_ISSUER_MODE
- See Also:
-
JSON_PROPERTY_JWKS
- See Also:
-
JSON_PROPERTY_JWKS_URI
- See Also:
-
JSON_PROPERTY_LOGO_URI
- See Also:
-
JSON_PROPERTY_PARTICIPATE_SLO
- See Also:
-
JSON_PROPERTY_POLICY_URI
- See Also:
-
JSON_PROPERTY_POST_LOGOUT_REDIRECT_URIS
- See Also:
-
JSON_PROPERTY_REDIRECT_URIS
- See Also:
-
JSON_PROPERTY_REFRESH_TOKEN
- See Also:
-
JSON_PROPERTY_REQUEST_OBJECT_SIGNING_ALG
- See Also:
-
JSON_PROPERTY_RESPONSE_TYPES
- See Also:
-
JSON_PROPERTY_SECTOR_IDENTIFIER_URI
- See Also:
-
JSON_PROPERTY_SUBJECT_TYPE
- See Also:
-
JSON_PROPERTY_TOS_URI
- See Also:
-
JSON_PROPERTY_WILDCARD_REDIRECT
- See Also:
-
-
Constructor Details
-
OpenIdConnectApplicationSettingsClient
public OpenIdConnectApplicationSettingsClient()
-
-
Method Details
-
applicationType
public OpenIdConnectApplicationSettingsClient applicationType(OpenIdConnectApplicationType applicationType) -
getApplicationType
Get applicationType- Returns:
- applicationType
-
setApplicationType
-
backchannelAuthenticationRequestSigningAlg
public OpenIdConnectApplicationSettingsClient backchannelAuthenticationRequestSigningAlg(OpenIdConnectApplicationSettingsClient.BackchannelAuthenticationRequestSigningAlgEnum backchannelAuthenticationRequestSigningAlg) -
getBackchannelAuthenticationRequestSigningAlg
@Nullable public OpenIdConnectApplicationSettingsClient.BackchannelAuthenticationRequestSigningAlgEnum getBackchannelAuthenticationRequestSigningAlg()The signing algorithm for Client-Initiated Backchannel Authentication (CIBA) signed requests using JWT. If this value isn't set and a JWT-signed request is sent, the request fails. > **Note:** This property appears for clients with `urn:openid:params:grant-type:ciba` defined as one of the `grant_types`.- Returns:
- backchannelAuthenticationRequestSigningAlg
-
setBackchannelAuthenticationRequestSigningAlg
public void setBackchannelAuthenticationRequestSigningAlg(OpenIdConnectApplicationSettingsClient.BackchannelAuthenticationRequestSigningAlgEnum backchannelAuthenticationRequestSigningAlg) -
backchannelCustomAuthenticatorId
public OpenIdConnectApplicationSettingsClient backchannelCustomAuthenticatorId(String backchannelCustomAuthenticatorId) -
getBackchannelCustomAuthenticatorId
The ID of the custom authenticator that authenticates the user > **Note:** This property appears for clients with `urn:openid:params:grant-type:ciba` defined as one of the `grant_types`.- Returns:
- backchannelCustomAuthenticatorId
-
setBackchannelCustomAuthenticatorId
-
backchannelTokenDeliveryMode
public OpenIdConnectApplicationSettingsClient backchannelTokenDeliveryMode(OpenIdConnectApplicationSettingsClient.BackchannelTokenDeliveryModeEnum backchannelTokenDeliveryMode) -
getBackchannelTokenDeliveryMode
@Nullable public OpenIdConnectApplicationSettingsClient.BackchannelTokenDeliveryModeEnum getBackchannelTokenDeliveryMode()The delivery mode for Client-Initiated Backchannel Authentication (CIBA). Currently, only `poll` is supported. > **Note:** This property appears for clients with `urn:openid:params:grant-type:ciba` defined as one of the `grant_types`.- Returns:
- backchannelTokenDeliveryMode
-
setBackchannelTokenDeliveryMode
public void setBackchannelTokenDeliveryMode(OpenIdConnectApplicationSettingsClient.BackchannelTokenDeliveryModeEnum backchannelTokenDeliveryMode) -
clientUri
-
getClientUri
URL string of a web page providing information about the client- Returns:
- clientUri
-
setClientUri
-
consentMethod
public OpenIdConnectApplicationSettingsClient consentMethod(OpenIdConnectApplicationConsentMethod consentMethod) -
getConsentMethod
Get consentMethod- Returns:
- consentMethod
-
setConsentMethod
-
dpopBoundAccessTokens
-
getDpopBoundAccessTokens
Indicates that the client application uses Demonstrating Proof-of-Possession (DPoP) for token requests. If `true`, the authorization server rejects token requests from this client that don't contain the DPoP header. > **Note:** If `dpop_bound_access_tokens` is true, then `client_credentials` and `implicit` aren't allowed in `grant_types`.- Returns:
- dpopBoundAccessTokens
-
setDpopBoundAccessTokens
-
frontchannelLogoutSessionRequired
public OpenIdConnectApplicationSettingsClient frontchannelLogoutSessionRequired(Boolean frontchannelLogoutSessionRequired) -
getFrontchannelLogoutSessionRequired
<div class=\"x-lifecycle-container\"><x-lifecycle class=\"ea\"></x-lifecycle> <x-lifecycle class=\"oie\"></x-lifecycle></div>Determines whether Okta sends `sid` and `iss` in the logout request- Returns:
- frontchannelLogoutSessionRequired
-
setFrontchannelLogoutSessionRequired
-
frontchannelLogoutUri
-
getFrontchannelLogoutUri
<div class=\"x-lifecycle-container\"><x-lifecycle class=\"ea\"></x-lifecycle> <x-lifecycle class=\"oie\"></x-lifecycle></div>URL where Okta sends the logout request- Returns:
- frontchannelLogoutUri
-
setFrontchannelLogoutUri
-
grantTypes
-
addgrantTypesItem
-
getGrantTypes
Get grantTypes- Returns:
- grantTypes
-
setGrantTypes
-
idpInitiatedLogin
public OpenIdConnectApplicationSettingsClient idpInitiatedLogin(OpenIdConnectApplicationIdpInitiatedLogin idpInitiatedLogin) -
getIdpInitiatedLogin
Get idpInitiatedLogin- Returns:
- idpInitiatedLogin
-
setIdpInitiatedLogin
-
initiateLoginUri
-
getInitiateLoginUri
URL string that a third party can use to initiate the sign-in flow by the client- Returns:
- initiateLoginUri
-
setInitiateLoginUri
-
issuerMode
public OpenIdConnectApplicationSettingsClient issuerMode(OpenIdConnectApplicationIssuerMode issuerMode) -
getIssuerMode
Get issuerMode- Returns:
- issuerMode
-
setIssuerMode
-
jwks
-
getJwks
Get jwks- Returns:
- jwks
-
setJwks
-
jwksUri
-
getJwksUri
URL string that references a JSON Web Key Set for validating JWTs presented to Okta- Returns:
- jwksUri
-
setJwksUri
-
logoUri
-
getLogoUri
The URL string that references a logo for the client. This logo appears on the client tile in the End-User Dashboard. It also appears on the client consent dialog during the client consent flow.- Returns:
- logoUri
-
setLogoUri
-
participateSlo
-
getParticipateSlo
<div class=\"x-lifecycle-container\"><x-lifecycle class=\"ea\"></x-lifecycle> <x-lifecycle class=\"oie\"></x-lifecycle></div>Allows the app to participate in front-channel Single Logout > **Note:** You can only enable `participate_slo` for `web` and `browser` application types (`application_type`).- Returns:
- participateSlo
-
setParticipateSlo
-
policyUri
-
getPolicyUri
URL string of a web page providing the client's policy document- Returns:
- policyUri
-
setPolicyUri
-
postLogoutRedirectUris
public OpenIdConnectApplicationSettingsClient postLogoutRedirectUris(List<String> postLogoutRedirectUris) -
addpostLogoutRedirectUrisItem
public OpenIdConnectApplicationSettingsClient addpostLogoutRedirectUrisItem(String postLogoutRedirectUrisItem) -
getPostLogoutRedirectUris
Array of redirection URI strings for relying party-initiated logouts- Returns:
- postLogoutRedirectUris
-
setPostLogoutRedirectUris
-
redirectUris
-
addredirectUrisItem
-
getRedirectUris
Array of redirection URI strings for use in redirect-based flows. > **Note:** At least one `redirect_uris` and `response_types` are required for all client types, with exceptions: if the client uses the [Resource Owner Password ](https://tools.ietf.org/html/rfc6749#section-4.3)flow (`grant_types` contains `password`) or [Client Credentials](https://tools.ietf.org/html/rfc6749#section-4.4)flow (`grant_types` contains `client_credentials`), then no `redirect_uris` or `response_types` is necessary. In these cases, you can pass either null or an empty array for these attributes.- Returns:
- redirectUris
-
setRedirectUris
-
refreshToken
public OpenIdConnectApplicationSettingsClient refreshToken(OpenIdConnectApplicationSettingsRefreshToken refreshToken) -
getRefreshToken
Get refreshToken- Returns:
- refreshToken
-
setRefreshToken
-
requestObjectSigningAlg
public OpenIdConnectApplicationSettingsClient requestObjectSigningAlg(OpenIdConnectApplicationSettingsClient.RequestObjectSigningAlgEnum requestObjectSigningAlg) -
getRequestObjectSigningAlg
@Nullable public OpenIdConnectApplicationSettingsClient.RequestObjectSigningAlgEnum getRequestObjectSigningAlg()The type of JSON Web Key Set (JWKS) algorithm that must be used for signing request objects- Returns:
- requestObjectSigningAlg
-
setRequestObjectSigningAlg
public void setRequestObjectSigningAlg(OpenIdConnectApplicationSettingsClient.RequestObjectSigningAlgEnum requestObjectSigningAlg) -
responseTypes
-
addresponseTypesItem
public OpenIdConnectApplicationSettingsClient addresponseTypesItem(OAuthResponseType responseTypesItem) -
getResponseTypes
Array of OAuth 2.0 response type strings- Returns:
- responseTypes
-
setResponseTypes
-
sectorIdentifierUri
-
getSectorIdentifierUri
The sector identifier used for pairwise `subject_type`. See [OIDC Pairwise Identifier Algorithm](https://openid.net/specs/openid-connect-messages-1_0-20.html#idtype.pairwise.alg)- Returns:
- sectorIdentifierUri
-
setSectorIdentifierUri
-
subjectType
public OpenIdConnectApplicationSettingsClient subjectType(OpenIdConnectApplicationSettingsClient.SubjectTypeEnum subjectType) -
getSubjectType
Type of the subject- Returns:
- subjectType
-
setSubjectType
-
tosUri
-
getTosUri
URL string of a web page providing the client's terms of service document- Returns:
- tosUri
-
setTosUri
-
wildcardRedirect
public OpenIdConnectApplicationSettingsClient wildcardRedirect(OpenIdConnectApplicationSettingsClient.WildcardRedirectEnum wildcardRedirect) -
getWildcardRedirect
Indicates if the client is allowed to use wildcard matching of `redirect_uris`- Returns:
- wildcardRedirect
-
setWildcardRedirect
public void setWildcardRedirect(OpenIdConnectApplicationSettingsClient.WildcardRedirectEnum wildcardRedirect) -
equals
-
hashCode
public int hashCode() -
toString
-