Class IdentityProvider

The resulting base object when you add an identity provider to your tenancy. A {@link 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.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Inheritance

object

IdentityProvider

Saml2IdentityProvider

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.IdentityService.Models

Assembly: OCI.DotNetSDK.Identity.dll

Syntax

[JsonConverter(typeof(IdentityProviderModelConverter))]
public class IdentityProvider

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the tenancy containing the `IdentityProvider`.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration

[Required(ErrorMessage = "Description is required.")]
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	The description you assign to the `IdentityProvider` during creation. Does not have to be unique, and it's changeable.

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	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"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the `IdentityProvider`.

Remarks

Required

InactiveStatus

Declaration

[JsonProperty(PropertyName = "inactiveStatus")]
public long? InactiveStatus { get; set; }

Property Value

Type	Description
long?	The detailed status of INACTIVE lifecycleState.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public IdentityProvider.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
IdentityProvider.LifecycleStateEnum?	The current state. After creating an `IdentityProvider`, make sure its `lifecycleState` changes from CREATING to ACTIVE before using it.

Remarks

Required

Name

Declaration

[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }

Property Value

Type	Description
string	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.

Remarks

Required

ProductType

Declaration

[Required(ErrorMessage = "ProductType is required.")]
[JsonProperty(PropertyName = "productType")]
public string ProductType { get; set; }

Property Value

Type Description

Type	Description
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: `ADFS` `IDCS` Example: IDCS

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:

ADFS
IDCS
Example: IDCS

Remarks

Required

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	Date and time the `IdentityProvider` was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Remarks

Required