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="2024-09-23T16:19:57.008753975Z[Etc/UTC]", comments="Generator version: 7.8.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:

  • Field Details

  • Constructor Details

    • SamlApplicationSettingsSignOn

      public SamlApplicationSettingsSignOn()

  • Method Details

    • acsEndpoints

      public SamlApplicationSettingsSignOn acsEndpoints(List<AcsEndpoint> acsEndpoints)

    • addacsEndpointsItem

      public SamlApplicationSettingsSignOn addacsEndpointsItem(AcsEndpoint acsEndpointsItem)

    • getAcsEndpoints

      @Nullable public List<AcsEndpoint> getAcsEndpoints()
      An array of ACS endpoints. You can configure a maximum of 100 endpoints.
      Returns:
      acsEndpoints

    • setAcsEndpoints

      public void setAcsEndpoints(List<AcsEndpoint> acsEndpoints)

    • allowMultipleAcsEndpoints

      public SamlApplicationSettingsSignOn allowMultipleAcsEndpoints(Boolean allowMultipleAcsEndpoints)

    • getAllowMultipleAcsEndpoints

      @Nonnull public Boolean getAllowMultipleAcsEndpoints()
      Determines whether the app allows you to configure multiple ACS URIs
      Returns:
      allowMultipleAcsEndpoints

    • setAllowMultipleAcsEndpoints

      public void setAllowMultipleAcsEndpoints(Boolean allowMultipleAcsEndpoints)

    • assertionSigned

      public SamlApplicationSettingsSignOn assertionSigned(Boolean assertionSigned)

    • getAssertionSigned

      @Nonnull public Boolean getAssertionSigned()
      Determines whether the SAML assertion is digitally signed
      Returns:
      assertionSigned

    • setAssertionSigned

      public void setAssertionSigned(Boolean assertionSigned)

    • attributeStatements

      public SamlApplicationSettingsSignOn attributeStatements(List<SamlAttributeStatement> attributeStatements)

    • addattributeStatementsItem

      public SamlApplicationSettingsSignOn addattributeStatementsItem(SamlAttributeStatement attributeStatementsItem)

    • getAttributeStatements

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

      public void setAttributeStatements(List<SamlAttributeStatement> attributeStatements)

    • audience

      public SamlApplicationSettingsSignOn audience(String audience)

    • getAudience

      @Nonnull public String getAudience()
      The entity ID of the SP. Use the entity ID value exactly as provided by the SP.
      Returns:
      audience

    • setAudience

      public void setAudience(String audience)

    • audienceOverride

      public SamlApplicationSettingsSignOn audienceOverride(String audienceOverride)

    • getAudienceOverride

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

      public void setAudienceOverride(String audienceOverride)

    • authnContextClassRef

      public SamlApplicationSettingsSignOn authnContextClassRef(String authnContextClassRef)

    • getAuthnContextClassRef

      @Nonnull public String getAuthnContextClassRef()
      Identifies the SAML authentication context class for the assertion's authentication statement
      Returns:
      authnContextClassRef

    • setAuthnContextClassRef

      public void setAuthnContextClassRef(String authnContextClassRef)

    • configuredAttributeStatements

      public SamlApplicationSettingsSignOn configuredAttributeStatements(List<SamlAttributeStatement> configuredAttributeStatements)

    • addconfiguredAttributeStatementsItem

      public SamlApplicationSettingsSignOn addconfiguredAttributeStatementsItem(SamlAttributeStatement configuredAttributeStatementsItem)

    • getConfiguredAttributeStatements

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

      public SamlApplicationSettingsSignOn defaultRelayState(String defaultRelayState)

    • getDefaultRelayState

      @Nullable public String getDefaultRelayState()
      Identifies a specific application resource in an IdP-initiated SSO scenario
      Returns:
      defaultRelayState

    • setDefaultRelayState

      public void setDefaultRelayState(String defaultRelayState)

    • destination

      public SamlApplicationSettingsSignOn destination(String destination)

    • getDestination

      @Nonnull public String getDestination()
      Identifies the location inside the SAML assertion where the SAML response should be sent
      Returns:
      destination

    • setDestination

      public void setDestination(String destination)

    • destinationOverride

      public SamlApplicationSettingsSignOn destinationOverride(String destinationOverride)

    • getDestinationOverride

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

      public void setDestinationOverride(String destinationOverride)

    • digestAlgorithm

      public SamlApplicationSettingsSignOn digestAlgorithm(String digestAlgorithm)

    • getDigestAlgorithm

      @Nonnull public String getDigestAlgorithm()
      Determines the digest algorithm used to digitally sign the SAML assertion and response
      Returns:
      digestAlgorithm

    • setDigestAlgorithm

      public void setDigestAlgorithm(String digestAlgorithm)

    • honorForceAuthn

      public SamlApplicationSettingsSignOn honorForceAuthn(Boolean honorForceAuthn)

    • getHonorForceAuthn

      @Nonnull public Boolean getHonorForceAuthn()
      Set to `true` to prompt users for their credentials when a SAML request has the `ForceAuthn` attribute set to `true`
      Returns:
      honorForceAuthn

    • setHonorForceAuthn

      public void setHonorForceAuthn(Boolean honorForceAuthn)

    • idpIssuer

      public SamlApplicationSettingsSignOn idpIssuer(String idpIssuer)

    • getIdpIssuer

      @Nonnull public String getIdpIssuer()
      SAML Issuer ID
      Returns:
      idpIssuer

    • setIdpIssuer

      public void setIdpIssuer(String idpIssuer)

    • inlineHooks

      public SamlApplicationSettingsSignOn inlineHooks(List<SignOnInlineHook> inlineHooks)

    • addinlineHooksItem

      public SamlApplicationSettingsSignOn addinlineHooksItem(SignOnInlineHook inlineHooksItem)

    • getInlineHooks

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

      public void setInlineHooks(List<SignOnInlineHook> inlineHooks)

    • participateSlo

      public SamlApplicationSettingsSignOn participateSlo(SloParticipate participateSlo)

    • getParticipateSlo

      @Nullable public SloParticipate getParticipateSlo()
      Get participateSlo
      Returns:
      participateSlo

    • setParticipateSlo

      public void setParticipateSlo(SloParticipate participateSlo)

    • recipient

      public SamlApplicationSettingsSignOn recipient(String recipient)

    • getRecipient

      @Nonnull public String getRecipient()
      The location where the app may present the SAML assertion
      Returns:
      recipient

    • setRecipient

      public void setRecipient(String recipient)

    • recipientOverride

      public SamlApplicationSettingsSignOn recipientOverride(String recipientOverride)

    • getRecipientOverride

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

      public void setRecipientOverride(String recipientOverride)

    • requestCompressed

      public SamlApplicationSettingsSignOn requestCompressed(Boolean requestCompressed)

    • getRequestCompressed

      @Nonnull public Boolean getRequestCompressed()
      Determines whether the SAML request is expected to be compressed
      Returns:
      requestCompressed

    • setRequestCompressed

      public void setRequestCompressed(Boolean requestCompressed)

    • responseSigned

      public SamlApplicationSettingsSignOn responseSigned(Boolean responseSigned)

    • getResponseSigned

      @Nonnull public Boolean 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

      public void setResponseSigned(Boolean responseSigned)

    • samlAssertionLifetimeSeconds

      public SamlApplicationSettingsSignOn samlAssertionLifetimeSeconds(Integer samlAssertionLifetimeSeconds)

    • getSamlAssertionLifetimeSeconds

      @Nullable public Integer getSamlAssertionLifetimeSeconds()
      Determines the SAML app session lifetimes with Okta
      Returns:
      samlAssertionLifetimeSeconds

    • setSamlAssertionLifetimeSeconds

      public void setSamlAssertionLifetimeSeconds(Integer samlAssertionLifetimeSeconds)

    • signatureAlgorithm

      public SamlApplicationSettingsSignOn signatureAlgorithm(String signatureAlgorithm)

    • getSignatureAlgorithm

      @Nonnull public String getSignatureAlgorithm()
      Determines the signing algorithm used to digitally sign the SAML assertion and response
      Returns:
      signatureAlgorithm

    • setSignatureAlgorithm

      public void setSignatureAlgorithm(String signatureAlgorithm)

    • slo

      public SamlApplicationSettingsSignOn slo(SingleLogout slo)

    • getSlo

      @Nullable public SingleLogout getSlo()
      Get slo
      Returns:
      slo

    • setSlo

      public void setSlo(SingleLogout slo)

    • spCertificate

      public SamlApplicationSettingsSignOn spCertificate(SamlSpCertificate spCertificate)

    • getSpCertificate

      @Nullable public SamlSpCertificate getSpCertificate()
      Get spCertificate
      Returns:
      spCertificate

    • setSpCertificate

      public void setSpCertificate(SamlSpCertificate spCertificate)

    • spIssuer

      public SamlApplicationSettingsSignOn spIssuer(String spIssuer)

    • getSpIssuer

      @Nullable public String getSpIssuer()
      The issuer ID for the Service Provider. This property appears when SLO is enabled.
      Returns:
      spIssuer

    • setSpIssuer

      public void setSpIssuer(String spIssuer)

    • ssoAcsUrl

      public SamlApplicationSettingsSignOn ssoAcsUrl(String ssoAcsUrl)

    • getSsoAcsUrl

      @Nonnull public String getSsoAcsUrl()
      Single Sign-On Assertion Consumer Service (ACS) URL
      Returns:
      ssoAcsUrl

    • setSsoAcsUrl

      public void setSsoAcsUrl(String ssoAcsUrl)

    • ssoAcsUrlOverride

      public SamlApplicationSettingsSignOn ssoAcsUrlOverride(String ssoAcsUrlOverride)

    • getSsoAcsUrlOverride

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

      public void setSsoAcsUrlOverride(String ssoAcsUrlOverride)

    • subjectNameIdFormat

      public SamlApplicationSettingsSignOn subjectNameIdFormat(String subjectNameIdFormat)

    • getSubjectNameIdFormat

      @Nonnull public String getSubjectNameIdFormat()
      Get subjectNameIdFormat
      Returns:
      subjectNameIdFormat

    • setSubjectNameIdFormat

      public void setSubjectNameIdFormat(String subjectNameIdFormat)

    • subjectNameIdTemplate

      public SamlApplicationSettingsSignOn subjectNameIdTemplate(String subjectNameIdTemplate)

    • getSubjectNameIdTemplate

      @Nonnull public String getSubjectNameIdTemplate()
      Template for app user's username when a user is assigned to the app
      Returns:
      subjectNameIdTemplate

    • setSubjectNameIdTemplate

      public void setSubjectNameIdTemplate(String subjectNameIdTemplate)

    • 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