Package com.oracle.bmc.identity.model

Class IdentityProvider

  • Direct Known Subclasses:
    Saml2IdentityProvider
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public class IdentityProvider
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The resulting base object when you add an identity provider to your tenancy.

    A Saml2IdentityProvider is a specific type of IdentityProvider that supports the SAML 2.0 protocol. Each IdentityProvider object has its own OCID. For more information, see Identity Providers and Federation.

    To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Get Started with Policies](https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).

    *Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
    Note: Objects should always be created or deserialized using the 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 Builder, which maintain a set of all explicitly set fields called 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()
        The OCID of the IdentityProvider.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the tenancy containing the IdentityProvider.
        Returns:
        the value

      • getName

        public String getName()
        The name you assign to the IdentityProvider during creation.

        The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed. This is the name federated users see when choosing which identity provider to use when signing in to the Oracle Cloud Infrastructure Console.

        Returns:
        the value

      • getDescription

        public String getDescription()
        The description you assign to the IdentityProvider during creation.

        Does not have to be unique, and it’s changeable.

        Returns:
        the value

      • getProductType

        public String getProductType()
        The identity provider service or product.

        Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS).

        Allowed values are: - ADFS - IDCS

        Example: IDCS

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        Date and time the IdentityProvider was created, in the format defined by RFC3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getLifecycleState

        public IdentityProvider.LifecycleState getLifecycleState()
        The current state.

        After creating an IdentityProvider, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

        Returns:
        the value

      • getInactiveStatus

        public Long getInactiveStatus()
        The detailed status of INACTIVE lifecycleState.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

        Returns:
        the value

      • 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