Package com.okta.sdk.resource.model
Class SamlApplicationSettingsSignOn
java.lang.Object
com.okta.sdk.resource.model.SamlApplicationSettingsSignOn
- All Implemented Interfaces:
Serializable
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]",
comments="Generator version: 7.15.0")
public class SamlApplicationSettingsSignOn
extends Object
implements Serializable
SAML 2.0 sign-on attributes. > **Note:** Set either `destinationOverride` or `ssoAcsUrl` to
configure any other SAML 2.0 attributes in this section.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumIdentifies the SAML authentication context class for the assertion's authentication statementstatic enumDetermines the digest algorithm used to digitally sign the SAML assertion and responsestatic enumDetermines the signing algorithm used to digitally sign the SAML assertion and responsestatic enumIdentifies the SAML processing rules. -
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 Stringstatic final Stringstatic final Stringstatic final String -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionacsEndpoints(List<AcsEndpoint> acsEndpoints) addacsEndpointsItem(AcsEndpoint acsEndpointsItem) addattributeStatementsItem(SamlAttributeStatement attributeStatementsItem) addconfiguredAttributeStatementsItem(SamlAttributeStatement configuredAttributeStatementsItem) addinlineHooksItem(SignOnInlineHook inlineHooksItem) allowMultipleAcsEndpoints(Boolean allowMultipleAcsEndpoints) assertionEncryption(SamlAssertionEncryption assertionEncryption) assertionSigned(Boolean assertionSigned) attributeStatements(List<SamlAttributeStatement> attributeStatements) audienceOverride(String audienceOverride) authnContextClassRef(SamlApplicationSettingsSignOn.AuthnContextClassRefEnum authnContextClassRef) configuredAttributeStatements(List<SamlAttributeStatement> configuredAttributeStatements) defaultRelayState(String defaultRelayState) destination(String destination) destinationOverride(String destinationOverride) digestAlgorithm(SamlApplicationSettingsSignOn.DigestAlgorithmEnum digestAlgorithm) booleanAn array of ACS endpoints.Determines whether the app allows you to configure multiple ACS URIsGet assertionEncryptionDetermines whether the SAML assertion is digitally signedA list of custom attribute statements for the app's SAML assertion.The entity ID of the SP.Audience override for CASB configuration.Identifies the SAML authentication context class for the assertion's authentication statementThe list of dynamic attribute statements for the SAML assertion inherited from app metadata (apps from the OIN) during app creation.Identifies a specific application resource in an IdP-initiated SSO scenarioIdentifies the location inside the SAML assertion where the SAML response should be sentDestination override for CASB configuration.Determines the digest algorithm used to digitally sign the SAML assertion and responseSet to `true` to prompt users for their credentials when a SAML request has the `ForceAuthn` attribute set to `true`SAML Issuer IDAssociates the app with SAML inline hooks.Get participateSloThe location where the app may present the SAML assertionRecipient override for CASB configuration.Determines whether the SAML request is expected to be compressedDetermines whether the SAML authentication response message is digitally signed by the IdP > **Note:** Either (or both) `responseSigned` or `assertionSigned` must be `TRUE`.Determines the SAML app session lifetimes with OktaDetermines the signing algorithm used to digitally sign the SAML assertion and responsegetSlo()Get sloGet spCertificateThe issuer ID for the Service Provider.Single Sign-On Assertion Consumer Service (ACS) URLAssertion Consumer Service (ACS) URL override for CASB configuration.Identifies the SAML processing rules.Template for app user's username when a user is assigned to the appinthashCode()honorForceAuthn(Boolean honorForceAuthn) inlineHooks(List<SignOnInlineHook> inlineHooks) participateSlo(SloParticipate participateSlo) recipientOverride(String recipientOverride) requestCompressed(Boolean requestCompressed) responseSigned(Boolean responseSigned) samlAssertionLifetimeSeconds(Integer samlAssertionLifetimeSeconds) voidsetAcsEndpoints(List<AcsEndpoint> acsEndpoints) voidsetAllowMultipleAcsEndpoints(Boolean allowMultipleAcsEndpoints) voidsetAssertionEncryption(SamlAssertionEncryption assertionEncryption) voidsetAssertionSigned(Boolean assertionSigned) voidsetAttributeStatements(List<SamlAttributeStatement> attributeStatements) voidsetAudience(String audience) voidsetAudienceOverride(String audienceOverride) voidsetAuthnContextClassRef(SamlApplicationSettingsSignOn.AuthnContextClassRefEnum authnContextClassRef) voidsetConfiguredAttributeStatements(List<SamlAttributeStatement> configuredAttributeStatements) voidsetDefaultRelayState(String defaultRelayState) voidsetDestination(String destination) voidsetDestinationOverride(String destinationOverride) voidsetDigestAlgorithm(SamlApplicationSettingsSignOn.DigestAlgorithmEnum digestAlgorithm) voidsetHonorForceAuthn(Boolean honorForceAuthn) voidsetIdpIssuer(String idpIssuer) voidsetInlineHooks(List<SignOnInlineHook> inlineHooks) voidsetParticipateSlo(SloParticipate participateSlo) voidsetRecipient(String recipient) voidsetRecipientOverride(String recipientOverride) voidsetRequestCompressed(Boolean requestCompressed) voidsetResponseSigned(Boolean responseSigned) voidsetSamlAssertionLifetimeSeconds(Integer samlAssertionLifetimeSeconds) voidsetSignatureAlgorithm(SamlApplicationSettingsSignOn.SignatureAlgorithmEnum signatureAlgorithm) voidsetSlo(SingleLogout slo) voidsetSpCertificate(SamlSpCertificate spCertificate) voidsetSpIssuer(String spIssuer) voidsetSsoAcsUrl(String ssoAcsUrl) voidsetSsoAcsUrlOverride(String ssoAcsUrlOverride) voidsetSubjectNameIdFormat(SamlApplicationSettingsSignOn.SubjectNameIdFormatEnum subjectNameIdFormat) voidsetSubjectNameIdTemplate(String subjectNameIdTemplate) signatureAlgorithm(SamlApplicationSettingsSignOn.SignatureAlgorithmEnum signatureAlgorithm) slo(SingleLogout slo) spCertificate(SamlSpCertificate spCertificate) ssoAcsUrlOverride(String ssoAcsUrlOverride) subjectNameIdFormat(SamlApplicationSettingsSignOn.SubjectNameIdFormatEnum subjectNameIdFormat) subjectNameIdTemplate(String subjectNameIdTemplate) toString()
-
Field Details
-
JSON_PROPERTY_ACS_ENDPOINTS
- See Also:
-
JSON_PROPERTY_ALLOW_MULTIPLE_ACS_ENDPOINTS
- See Also:
-
JSON_PROPERTY_ASSERTION_ENCRYPTION
- See Also:
-
JSON_PROPERTY_ASSERTION_SIGNED
- See Also:
-
JSON_PROPERTY_ATTRIBUTE_STATEMENTS
- See Also:
-
JSON_PROPERTY_AUDIENCE
- See Also:
-
JSON_PROPERTY_AUDIENCE_OVERRIDE
- See Also:
-
JSON_PROPERTY_AUTHN_CONTEXT_CLASS_REF
- See Also:
-
JSON_PROPERTY_CONFIGURED_ATTRIBUTE_STATEMENTS
- See Also:
-
JSON_PROPERTY_DEFAULT_RELAY_STATE
- See Also:
-
JSON_PROPERTY_DESTINATION
- See Also:
-
JSON_PROPERTY_DESTINATION_OVERRIDE
- See Also:
-
JSON_PROPERTY_DIGEST_ALGORITHM
- See Also:
-
JSON_PROPERTY_HONOR_FORCE_AUTHN
- See Also:
-
JSON_PROPERTY_IDP_ISSUER
- See Also:
-
JSON_PROPERTY_INLINE_HOOKS
- See Also:
-
JSON_PROPERTY_PARTICIPATE_SLO
- See Also:
-
JSON_PROPERTY_RECIPIENT
- See Also:
-
JSON_PROPERTY_RECIPIENT_OVERRIDE
- See Also:
-
JSON_PROPERTY_REQUEST_COMPRESSED
- See Also:
-
JSON_PROPERTY_RESPONSE_SIGNED
- See Also:
-
JSON_PROPERTY_SAML_ASSERTION_LIFETIME_SECONDS
- See Also:
-
JSON_PROPERTY_SIGNATURE_ALGORITHM
- See Also:
-
JSON_PROPERTY_SLO
- See Also:
-
JSON_PROPERTY_SP_CERTIFICATE
- See Also:
-
JSON_PROPERTY_SP_ISSUER
- See Also:
-
JSON_PROPERTY_SSO_ACS_URL
- See Also:
-
JSON_PROPERTY_SSO_ACS_URL_OVERRIDE
- See Also:
-
JSON_PROPERTY_SUBJECT_NAME_ID_FORMAT
- See Also:
-
JSON_PROPERTY_SUBJECT_NAME_ID_TEMPLATE
- See Also:
-
-
Constructor Details
-
SamlApplicationSettingsSignOn
public SamlApplicationSettingsSignOn()
-
-
Method Details
-
acsEndpoints
-
addacsEndpointsItem
-
getAcsEndpoints
An array of ACS endpoints. You can configure a maximum of 100 endpoints.- Returns:
- acsEndpoints
-
setAcsEndpoints
-
allowMultipleAcsEndpoints
-
getAllowMultipleAcsEndpoints
Determines whether the app allows you to configure multiple ACS URIs- Returns:
- allowMultipleAcsEndpoints
-
setAllowMultipleAcsEndpoints
-
assertionEncryption
public SamlApplicationSettingsSignOn assertionEncryption(SamlAssertionEncryption assertionEncryption) -
getAssertionEncryption
Get assertionEncryption- Returns:
- assertionEncryption
-
setAssertionEncryption
-
assertionSigned
-
getAssertionSigned
Determines whether the SAML assertion is digitally signed- Returns:
- assertionSigned
-
setAssertionSigned
-
attributeStatements
public SamlApplicationSettingsSignOn attributeStatements(List<SamlAttributeStatement> attributeStatements) -
addattributeStatementsItem
public SamlApplicationSettingsSignOn addattributeStatementsItem(SamlAttributeStatement attributeStatementsItem) -
getAttributeStatements
A list of custom attribute statements for the app's SAML assertion. See [SAML 2.0 Technical Overview](https://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0-cd-02.html). There are two types of attribute statements: | Type | Description | | ---- | ----------- | | EXPRESSION | Generic attribute statement that can be dynamic and supports [Okta Expression Language](https://developer.okta.com/docs/reference/okta-expression-language/) | | GROUP | Group attribute statement |- Returns:
- attributeStatements
-
setAttributeStatements
-
audience
-
getAudience
The entity ID of the SP. Use the entity ID value exactly as provided by the SP.- Returns:
- audience
-
setAudience
-
audienceOverride
-
getAudienceOverride
Audience override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm).- Returns:
- audienceOverride
-
setAudienceOverride
-
authnContextClassRef
public SamlApplicationSettingsSignOn authnContextClassRef(SamlApplicationSettingsSignOn.AuthnContextClassRefEnum authnContextClassRef) -
getAuthnContextClassRef
Identifies the SAML authentication context class for the assertion's authentication statement- Returns:
- authnContextClassRef
-
setAuthnContextClassRef
public void setAuthnContextClassRef(SamlApplicationSettingsSignOn.AuthnContextClassRefEnum authnContextClassRef) -
configuredAttributeStatements
public SamlApplicationSettingsSignOn configuredAttributeStatements(List<SamlAttributeStatement> configuredAttributeStatements) -
addconfiguredAttributeStatementsItem
public SamlApplicationSettingsSignOn addconfiguredAttributeStatementsItem(SamlAttributeStatement configuredAttributeStatementsItem) -
getConfiguredAttributeStatements
The list of dynamic attribute statements for the SAML assertion inherited from app metadata (apps from the OIN) during app creation. There are two types of attribute statements: `EXPRESSION` and `GROUP`.- Returns:
- configuredAttributeStatements
-
setConfiguredAttributeStatements
public void setConfiguredAttributeStatements(List<SamlAttributeStatement> configuredAttributeStatements) -
defaultRelayState
-
getDefaultRelayState
Identifies a specific application resource in an IdP-initiated SSO scenario- Returns:
- defaultRelayState
-
setDefaultRelayState
-
destination
-
getDestination
Identifies the location inside the SAML assertion where the SAML response should be sent- Returns:
- destination
-
setDestination
-
destinationOverride
-
getDestinationOverride
Destination override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm).- Returns:
- destinationOverride
-
setDestinationOverride
-
digestAlgorithm
public SamlApplicationSettingsSignOn digestAlgorithm(SamlApplicationSettingsSignOn.DigestAlgorithmEnum digestAlgorithm) -
getDigestAlgorithm
Determines the digest algorithm used to digitally sign the SAML assertion and response- Returns:
- digestAlgorithm
-
setDigestAlgorithm
-
honorForceAuthn
-
getHonorForceAuthn
Set to `true` to prompt users for their credentials when a SAML request has the `ForceAuthn` attribute set to `true`- Returns:
- honorForceAuthn
-
setHonorForceAuthn
-
idpIssuer
-
getIdpIssuer
SAML Issuer ID- Returns:
- idpIssuer
-
setIdpIssuer
-
inlineHooks
-
addinlineHooksItem
-
getInlineHooks
Associates the app with SAML inline hooks. See [the SAML assertion inline hook reference](https://developer.okta.com/docs/reference/saml-hook/).- Returns:
- inlineHooks
-
setInlineHooks
-
participateSlo
-
getParticipateSlo
Get participateSlo- Returns:
- participateSlo
-
setParticipateSlo
-
recipient
-
getRecipient
The location where the app may present the SAML assertion- Returns:
- recipient
-
setRecipient
-
recipientOverride
-
getRecipientOverride
Recipient override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm).- Returns:
- recipientOverride
-
setRecipientOverride
-
requestCompressed
-
getRequestCompressed
Determines whether the SAML request is expected to be compressed- Returns:
- requestCompressed
-
setRequestCompressed
-
responseSigned
-
getResponseSigned
Determines whether the SAML authentication response message is digitally signed by the IdP > **Note:** Either (or both) `responseSigned` or `assertionSigned` must be `TRUE`.- Returns:
- responseSigned
-
setResponseSigned
-
samlAssertionLifetimeSeconds
public SamlApplicationSettingsSignOn samlAssertionLifetimeSeconds(Integer samlAssertionLifetimeSeconds) -
getSamlAssertionLifetimeSeconds
Determines the SAML app session lifetimes with Okta- Returns:
- samlAssertionLifetimeSeconds
-
setSamlAssertionLifetimeSeconds
-
signatureAlgorithm
public SamlApplicationSettingsSignOn signatureAlgorithm(SamlApplicationSettingsSignOn.SignatureAlgorithmEnum signatureAlgorithm) -
getSignatureAlgorithm
Determines the signing algorithm used to digitally sign the SAML assertion and response- Returns:
- signatureAlgorithm
-
setSignatureAlgorithm
public void setSignatureAlgorithm(SamlApplicationSettingsSignOn.SignatureAlgorithmEnum signatureAlgorithm) -
slo
-
getSlo
Get slo- Returns:
- slo
-
setSlo
-
spCertificate
-
getSpCertificate
Get spCertificate- Returns:
- spCertificate
-
setSpCertificate
-
spIssuer
-
getSpIssuer
The issuer ID for the Service Provider. This property appears when SLO is enabled.- Returns:
- spIssuer
-
setSpIssuer
-
ssoAcsUrl
-
getSsoAcsUrl
Single Sign-On Assertion Consumer Service (ACS) URL- Returns:
- ssoAcsUrl
-
setSsoAcsUrl
-
ssoAcsUrlOverride
-
getSsoAcsUrlOverride
Assertion Consumer Service (ACS) URL override for CASB configuration. See [CASB config guide](https://help.okta.com/en-us/Content/Topics/Apps/CASB-config-guide.htm).- Returns:
- ssoAcsUrlOverride
-
setSsoAcsUrlOverride
-
subjectNameIdFormat
public SamlApplicationSettingsSignOn subjectNameIdFormat(SamlApplicationSettingsSignOn.SubjectNameIdFormatEnum subjectNameIdFormat) -
getSubjectNameIdFormat
Identifies the SAML processing rules. Supported values:- Returns:
- subjectNameIdFormat
-
setSubjectNameIdFormat
public void setSubjectNameIdFormat(SamlApplicationSettingsSignOn.SubjectNameIdFormatEnum subjectNameIdFormat) -
subjectNameIdTemplate
-
getSubjectNameIdTemplate
Template for app user's username when a user is assigned to the app- Returns:
- subjectNameIdTemplate
-
setSubjectNameIdTemplate
-
equals
-
hashCode
public int hashCode() -
toString
-