Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace IdentityProvider

The resulting base object when you add an identity provider to your tenancy. A Saml2IdentityProvider is a specific type of {@code IdentityProvider} that supports the SAML 2.0 protocol. Each {@code 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.cloud.oracle.com/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.

Properties

compartmentId

compartmentId: string

The OCID of the tenancy containing the {@code IdentityProvider}.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

description

description: string

The description you assign to the {@code IdentityProvider} during creation. Does not have to be unique, and it's changeable.

Optional freeformTags

freeformTags: undefined | object

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: {@code {"Department": "Finance"}}

id

id: string

The OCID of the {@code IdentityProvider}.

Optional inactiveStatus

inactiveStatus: undefined | number

The detailed status of INACTIVE lifecycleState. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

lifecycleState

lifecycleState: LifecycleState

The current state. After creating an {@code IdentityProvider}, make sure its {@code lifecycleState} changes from CREATING to ACTIVE before using it.

name

name: string

The name you assign to the {@code IdentityProvider} during creation. The name must be unique across all {@code 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.

productType

productType: string

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: - {@code ADFS} - {@code IDCS}

Example: {@code IDCS}

protocol

protocol: string

timeCreated

timeCreated: Date

Date and time the {@code IdentityProvider} was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Functions

getDeserializedJsonObj

getJsonObj