Package com.oracle.bmc.identitydomains.model

Class AppExtensionSamlServiceProviderApp.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • metadata

        public AppExtensionSamlServiceProviderApp.Builder metadata​(String metadata)
        This attribute represents the metadata of a Security Provider in the Security Assertion Markup Language protocol.

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        metadata - the value to set
        Returns:
        this builder

      • partnerProviderId

        public AppExtensionSamlServiceProviderApp.Builder partnerProviderId​(String partnerProviderId)
        The ID of the Provider.

        This value corresponds to the entityID from the Service Provider metadata.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        partnerProviderId - the value to set
        Returns:
        this builder

      • partnerProviderPattern

        public AppExtensionSamlServiceProviderApp.Builder partnerProviderPattern​(String partnerProviderPattern)
        The pattern of the Provider.

        This value corresponds to the entityID from the Service Provider metadata.

        *Added In:** 2202230830

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: request - type: string - uniqueness: none

        Parameters:
        partnerProviderPattern - the value to set
        Returns:
        this builder

      • tenantProviderId

        public AppExtensionSamlServiceProviderApp.Builder tenantProviderId​(String tenantProviderId)
        The alternate Provider ID to be used as the Oracle Identity Cloud Service providerID (instead of the one in SamlSettings) when interacting with this SP.

        *Added In:** 19.2.1

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        tenantProviderId - the value to set
        Returns:
        this builder

      • succinctId

        public AppExtensionSamlServiceProviderApp.Builder succinctId​(String succinctId)
        This attribute represents the Succinct ID.

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: server

        Parameters:
        succinctId - the value to set
        Returns:
        this builder

      • assertionConsumerUrl

        public AppExtensionSamlServiceProviderApp.Builder assertionConsumerUrl​(String assertionConsumerUrl)
        The attribute represents the URL to which the SAML Assertions will be sent by the SAML IdP.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        assertionConsumerUrl - the value to set
        Returns:
        this builder

      • logoutRequestUrl

        public AppExtensionSamlServiceProviderApp.Builder logoutRequestUrl​(String logoutRequestUrl)
        The URL to which the partner sends the logout request.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        logoutRequestUrl - the value to set
        Returns:
        this builder

      • logoutResponseUrl

        public AppExtensionSamlServiceProviderApp.Builder logoutResponseUrl​(String logoutResponseUrl)
        The URL to which the partner sends the logout response.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        logoutResponseUrl - the value to set
        Returns:
        this builder

      • nameIdFormat

        public AppExtensionSamlServiceProviderApp.Builder nameIdFormat​(String nameIdFormat)
        This can be any string, but there are a set of standard nameIdFormats.

        If a nameIdFormat other than the standard list is chosen, it will be considered a custom nameidformat. The standard nameidformats include: saml-x509, saml-emailaddress, saml-windowsnamequalifier, saml-kerberos, saml-persistent, saml-transient, saml-unspecified, saml-none, and saml-persistent-opaque.

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        nameIdFormat - the value to set
        Returns:
        this builder

      • signingCertificate

        public AppExtensionSamlServiceProviderApp.Builder signingCertificate​(String signingCertificate)
        This attribute represents the signing certificate that an App uses to verify the signed authentication request.

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        signingCertificate - the value to set
        Returns:
        this builder

      • encryptionCertificate

        public AppExtensionSamlServiceProviderApp.Builder encryptionCertificate​(String encryptionCertificate)
        This attribute represents the encryption certificate that an App uses to encrypt the Security Assertion Markup Language (SAML) assertion.

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        encryptionCertificate - the value to set
        Returns:
        this builder

      • encryptionAlgorithm

        public AppExtensionSamlServiceProviderApp.Builder encryptionAlgorithm​(AppExtensionSamlServiceProviderApp.EncryptionAlgorithm encryptionAlgorithm)
        This attribute indicates the encryption algorithm used to encrypt the SAML assertion.

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        encryptionAlgorithm - the value to set
        Returns:
        this builder

      • keyEncryptionAlgorithm

        public AppExtensionSamlServiceProviderApp.Builder keyEncryptionAlgorithm​(AppExtensionSamlServiceProviderApp.KeyEncryptionAlgorithm keyEncryptionAlgorithm)
        This attribute indicates the key encryption algorithm.

        *Added In:** 18.4.2

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        keyEncryptionAlgorithm - the value to set
        Returns:
        this builder

      • encryptAssertion

        public AppExtensionSamlServiceProviderApp.Builder encryptAssertion​(Boolean encryptAssertion)
        If true, indicates that the system must encrypt the Security Assertion Markup Language (SAML) assertion.

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        encryptAssertion - the value to set
        Returns:
        this builder

      • signResponseOrAssertion

        public AppExtensionSamlServiceProviderApp.Builder signResponseOrAssertion​(AppExtensionSamlServiceProviderApp.SignResponseOrAssertion signResponseOrAssertion)
        Indicates which part of the response should be signed.

        A value of \“Assertion\” indicates that the Assertion should be signed. A value of \“Response\” indicates that the SSO Response should be signed. A value of \“AssertionAndResponse\” indicates that both the Assertion and the SSO Response should be signed.

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        signResponseOrAssertion - the value to set
        Returns:
        this builder

      • includeSigningCertInSignature

        public AppExtensionSamlServiceProviderApp.Builder includeSigningCertInSignature​(Boolean includeSigningCertInSignature)
        If true, then the signing certificate is included in the signature.

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        includeSigningCertInSignature - the value to set
        Returns:
        this builder

      • logoutBinding

        public AppExtensionSamlServiceProviderApp.Builder logoutBinding​(AppExtensionSamlServiceProviderApp.LogoutBinding logoutBinding)
        This attribute represents the HTTP binding that would be used while logout.

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        logoutBinding - the value to set
        Returns:
        this builder

      • logoutEnabled

        public AppExtensionSamlServiceProviderApp.Builder logoutEnabled​(Boolean logoutEnabled)
        If true, then the SAML Service supports logout for this App.

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        logoutEnabled - the value to set
        Returns:
        this builder

      • signatureHashAlgorithm

        public AppExtensionSamlServiceProviderApp.Builder signatureHashAlgorithm​(AppExtensionSamlServiceProviderApp.SignatureHashAlgorithm signatureHashAlgorithm)
        This attribute represents the algorithm used to hash the signature.

        *SCIM++ Properties:** - caseExact: true - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        signatureHashAlgorithm - the value to set
        Returns:
        this builder

      • federationProtocol

        public AppExtensionSamlServiceProviderApp.Builder federationProtocol​(AppExtensionSamlServiceProviderApp.FederationProtocol federationProtocol)
        Specifies the preferred federation protocol (SAML2.0 or WS-Fed1.1).

        *Added In:** 18.2.6

        *SCIM++ Properties:** - caseExact: true - idcsDefaultValue: SAML2.0 - idcsSearchable: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        federationProtocol - the value to set
        Returns:
        this builder

      • nameIdUserstoreAttribute

        public AppExtensionSamlServiceProviderApp.Builder nameIdUserstoreAttribute​(String nameIdUserstoreAttribute)
        Deprecated Since: 18.2.2

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: true - idcsValuePersistedInOtherAttribute: true - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none This property specifies which user attribute is used as the NameID value in the SAML assertion. This attribute can be constructed by using attributes from the Oracle Identity Cloud Service Core Users schema.

        Parameters:
        nameIdUserstoreAttribute - the value to set
        Returns:
        this builder

      • hokRequired

        public AppExtensionSamlServiceProviderApp.Builder hokRequired​(Boolean hokRequired)
        If enabled, then the SAML Service supports Hok for this App.

        *Added In:** 2101262133

        *SCIM++ Properties:** - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: boolean - uniqueness: none

        Parameters:
        hokRequired - the value to set
        Returns:
        this builder

      • hokAcsUrl

        public AppExtensionSamlServiceProviderApp.Builder hokAcsUrl​(String hokAcsUrl)
        Hok Assertion Consumer Service Url

        *Added In:** 2101262133

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readWrite - required: false - returned: default - type: string - uniqueness: none

        Parameters:
        hokAcsUrl - the value to set
        Returns:
        this builder

      • lastNotificationSentTime

        public AppExtensionSamlServiceProviderApp.Builder lastNotificationSentTime​(String lastNotificationSentTime)
        Records the notification timestamp for the SP whose signing certificate is about to expire.

        *Added In:** 2302092332

        *SCIM++ Properties:** - caseExact: false - idcsSearchable: false - multiValued: false - mutability: readOnly - required: false - returned: default - type: dateTime - uniqueness: none

        Parameters:
        lastNotificationSentTime - the value to set
        Returns:
        this builder

      • userAssertionAttributes

        public AppExtensionSamlServiceProviderApp.Builder userAssertionAttributes​(List<AppUserAssertionAttributes> userAssertionAttributes)
        Each value of this attribute describes an attribute of User that will be sent in a Security Assertion Markup Language (SAML) assertion.

        *Deprecated Since: 18.2.2**

        *SCIM++ Properties:** - caseExact: false - idcsCompositeKey: [name] - idcsSearchable: false - idcsValuePersistedInOtherAttribute: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

        Parameters:
        userAssertionAttributes - the value to set
        Returns:
        this builder

      • groupAssertionAttributes

        public AppExtensionSamlServiceProviderApp.Builder groupAssertionAttributes​(List<AppGroupAssertionAttributes> groupAssertionAttributes)
        Each value of this attribute describes an attribute of Group that will be sent in a Security Assertion Markup Language (SAML) assertion.

        *Deprecated Since: 18.2.2**

        *SCIM++ Properties:** - caseExact: false - idcsCompositeKey: [name] - idcsSearchable: false - idcsValuePersistedInOtherAttribute: true - multiValued: true - mutability: readWrite - required: false - returned: default - type: complex - uniqueness: none

        Parameters:
        groupAssertionAttributes - the value to set
        Returns:
        this builder