Class IdentityProvider


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: v1")
    public final class IdentityProvider
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Federation trusted partner Identity Provider
    Note: Objects should always be created or deserialized using the IdentityProvider.Builder.

    This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the IdentityProvider.Builder, which maintain a set of all explicitly set fields called IdentityProvider.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        Unique identifier for the SCIM Resource as defined by the Service Provider.

        Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider’s entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.

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

        Returns:
        the value
      • getOcid

        public String getOcid()
        Unique OCI identifier for the SCIM Resource.

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

        Returns:
        the value
      • getSchemas

        public List<String> getSchemas()
        REQUIRED.

        The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard \“enterprise\” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

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

        Returns:
        the value
      • getMeta

        public Meta getMeta()
      • getIdcsPreventedOperations

        public List<IdcsPreventedOperations> getIdcsPreventedOperations()
        Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.

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

        Returns:
        the value
      • getTags

        public List<Tags> getTags()
        A list of tags on this resource.

        *SCIM++ Properties:** - idcsCompositeKey: [key, value] - idcsSearchable: true - multiValued: true - mutability: readWrite - required: false - returned: request - type: complex - uniqueness: none

        Returns:
        the value
      • getDeleteInProgress

        public Boolean getDeleteInProgress()
        A boolean flag indicating this resource in the process of being deleted.

        Usually set to true when synchronous deletion of the resource would take too long.

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

        Returns:
        the value
      • getIdcsLastUpgradedInRelease

        public String getIdcsLastUpgradedInRelease()
        The release number when the resource was upgraded.

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

        Returns:
        the value
      • getDomainOcid

        public String getDomainOcid()
        OCI Domain Id (ocid) in which the resource lives.

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

        Returns:
        the value
      • getCompartmentOcid

        public String getCompartmentOcid()
        OCI Compartment Id (ocid) in which the resource lives.

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

        Returns:
        the value
      • getTenancyOcid

        public String getTenancyOcid()
        OCI Tenant Id (ocid) in which the resource lives.

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

        Returns:
        the value
      • getExternalId

        public String getExternalId()
        An identifier for the Resource as defined by the Service Consumer.

        The externalId may simplify identification of the Resource between Service Consumer and Service Provider by allowing the Consumer to refer to the Resource with its own identifier, obviating the need to store a local mapping between the local identifier of the Resource and the identifier used by the Service Provider. Each Resource MAY include a non-empty externalId value. The value of the externalId attribute is always issued by the Service Consumer and can never be specified by the Service Provider. The Service Provider MUST always interpret the externalId as scoped to the Service Consumer’s tenant.

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

        Returns:
        the value
      • getPartnerName

        public String getPartnerName()
        Unique name of the trusted Identity Provider.

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

        Returns:
        the value
      • getDescription

        public String getDescription()
        Description

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

        Returns:
        the value
      • getMetadata

        public String getMetadata()
        Metadata

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

        Returns:
        the value
      • getPartnerProviderId

        public String getPartnerProviderId()
        Provider ID

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

        Returns:
        the value
      • getTenantProviderId

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

        *Added In:** 19.2.1

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

        Returns:
        the value
      • getSuccinctId

        public String getSuccinctId()
        Succinct ID

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

        Returns:
        the value
      • getIdpSsoUrl

        public String getIdpSsoUrl()
        Identity Provider SSO URL

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

        Returns:
        the value
      • getLogoutRequestUrl

        public String getLogoutRequestUrl()
        Logout request URL

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

        Returns:
        the value
      • getLogoutResponseUrl

        public String getLogoutResponseUrl()
        Logout response URL

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

        Returns:
        the value
      • getSigningCertificate

        public String getSigningCertificate()
        Signing certificate

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

        Returns:
        the value
      • getEncryptionCertificate

        public String getEncryptionCertificate()
        Encryption certificate

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

        Returns:
        the value
      • getNameIdFormat

        public String getNameIdFormat()
        Default authentication request name ID format.

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

        Returns:
        the value
      • getIncludeSigningCertInSignature

        public Boolean getIncludeSigningCertInSignature()
        Set to true to include the signing certificate in the signature.

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

        Returns:
        the value
      • getAuthnRequestBinding

        public IdentityProvider.AuthnRequestBinding getAuthnRequestBinding()
        HTTP binding to use for authentication requests.

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

        Returns:
        the value
      • getLogoutBinding

        public IdentityProvider.LogoutBinding getLogoutBinding()
        HTTP binding to use for logout.

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

        Returns:
        the value
      • getLogoutEnabled

        public Boolean getLogoutEnabled()
        Set to true to enable logout.

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

        Returns:
        the value
      • getSignatureHashAlgorithm

        public IdentityProvider.SignatureHashAlgorithm getSignatureHashAlgorithm()
        Signature hash algorithm.

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

        Returns:
        the value
      • getEnabled

        public Boolean getEnabled()
        Set to true to indicate Partner enabled.

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

        Returns:
        the value
      • getIconUrl

        public String getIconUrl()
        Identity Provider Icon URL.

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

        Returns:
        the value
      • getShownOnLoginPage

        public Boolean getShownOnLoginPage()
        Set to true to indicate whether to show IdP in login page or not.

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

        Returns:
        the value
      • getJitUserProvEnabled

        public Boolean getJitUserProvEnabled()
        Set to true to indicate JIT User Provisioning is enabled

        *Added In:** 20.1.3

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

        Returns:
        the value
      • getJitUserProvGroupAssertionAttributeEnabled

        public Boolean getJitUserProvGroupAssertionAttributeEnabled()
        Set to true to indicate JIT User Provisioning Groups should be assigned based on assertion attribute

        *Added In:** 20.1.3

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

        Returns:
        the value
      • getJitUserProvGroupStaticListEnabled

        public Boolean getJitUserProvGroupStaticListEnabled()
        Set to true to indicate JIT User Provisioning Groups should be assigned from a static list

        *Added In:** 20.1.3

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

        Returns:
        the value
      • getJitUserProvCreateUserEnabled

        public Boolean getJitUserProvCreateUserEnabled()
        Set to true to indicate JIT User Creation is enabled

        *Added In:** 20.1.3

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

        Returns:
        the value
      • getJitUserProvAttributeUpdateEnabled

        public Boolean getJitUserProvAttributeUpdateEnabled()
        Set to true to indicate JIT User Creation is enabled

        *Added In:** 20.1.3

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

        Returns:
        the value
      • getJitUserProvGroupAssignmentMethod

        public IdentityProvider.JitUserProvGroupAssignmentMethod getJitUserProvGroupAssignmentMethod()
        The default value is ‘Overwrite’, which tells Just-In-Time user-provisioning to replace any current group-assignments for a User with those assigned by assertions and/or those assigned statically.

        Specify ‘Merge’ if you want Just-In-Time user-provisioning to combine its group-assignments with those the user already has.

        *Added In:** 20.1.3

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

        Returns:
        the value
      • getJitUserProvGroupMappingMode

        public IdentityProvider.JitUserProvGroupMappingMode getJitUserProvGroupMappingMode()
        Property to indicate the mode of group mapping

        *Added In:** 2205120021

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

        Returns:
        the value
      • getJitUserProvGroupSAMLAttributeName

        public String getJitUserProvGroupSAMLAttributeName()
        Name of the assertion attribute containing the users groups

        *Added In:** 20.1.3

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

        Returns:
        the value
      • getServiceInstanceIdentifier

        public String getServiceInstanceIdentifier()
        The serviceInstanceIdentifier of the App that hosts this IdP.

        This value will match the opcServiceInstanceGUID of any service-instance that the IdP represents.

        *Added In:** 18.2.6

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

        Returns:
        the value
      • getUserMappingMethod

        public IdentityProvider.UserMappingMethod getUserMappingMethod()
        User mapping method.

        *Deprecated Since: 20.1.3**

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

        Returns:
        the value
      • getUserMappingStoreAttribute

        public String getUserMappingStoreAttribute()
        This property specifies the userstore attribute value that must match the incoming assertion attribute value or the incoming nameid attribute value in order to identify the user during SSO.
        You can construct the userMappingStoreAttribute value by specifying attributes from the Oracle Identity Cloud Service Core Users schema.

        For examples of how to construct the userMappingStoreAttribute value, see the Example of a Request Body section of the Examples tab for the POST and PUT methods of the /IdentityProviders endpoint.

        *Deprecated Since: 20.1.3**

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

        Returns:
        the value
      • getAssertionAttribute

        public String getAssertionAttribute()
        Assertion attribute name.

        *Deprecated Since: 20.1.3**

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

        Returns:
        the value
      • getType

        public IdentityProvider.Type getType()
        Identity Provider Type

        *Added In:** 20.1.3

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

        Returns:
        the value
      • getRequireForceAuthn

        public Boolean getRequireForceAuthn()
        This SP requires requests SAML IdP to enforce re-authentication.

        *Added In:** 2102181953

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

        Returns:
        the value
      • getRequiresEncryptedAssertion

        public Boolean getRequiresEncryptedAssertion()
        SAML SP must accept encrypted assertion only.

        *Added In:** 2102181953

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

        Returns:
        the value
      • getSamlHoKRequired

        public Boolean getSamlHoKRequired()
        SAML SP HoK Enabled.

        *Added In:** 2102181953

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

        Returns:
        the value
      • getRequestedAuthenticationContext

        public List<String> getRequestedAuthenticationContext()
        SAML SP authentication type.

        *Added In:** 2102181953

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

        Returns:
        the value
      • getJitUserProvIgnoreErrorOnAbsentGroups

        public Boolean getJitUserProvIgnoreErrorOnAbsentGroups()
        Set to true to indicate ignoring absence of group while provisioning

        *Added In:** 2111112015

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

        Returns:
        the value
      • getLastNotificationSentTime

        public String getLastNotificationSentTime()
        Records the notification timestamp for the IdP 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

        Returns:
        the value
      • getJitUserProvGroupMappings

        public List<IdentityProviderJitUserProvGroupMappings> getJitUserProvGroupMappings()
        The list of mappings between the Identity Domain Group and the IDP group.

        *Added In:** 2205120021

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

        Returns:
        the value
      • getJitUserProvAssignedGroups

        public List<IdentityProviderJitUserProvAssignedGroups> getJitUserProvAssignedGroups()
        Refers to every group of which a JIT-provisioned User should be a member.

        Just-in-Time user-provisioning applies this static list when jitUserProvGroupStaticListEnabled:true.

        *Added In:** 20.1.3

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

        Returns:
        the value
      • getUrnIetfParamsScimSchemasOracleIdcsExtensionSocialIdentityProvider

        public ExtensionSocialIdentityProvider getUrnIetfParamsScimSchemasOracleIdcsExtensionSocialIdentityProvider()
      • getUrnIetfParamsScimSchemasOracleIdcsExtensionX509IdentityProvider

        public ExtensionX509IdentityProvider getUrnIetfParamsScimSchemasOracleIdcsExtensionX509IdentityProvider()
      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation
      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel