IdentityProvider

class oci.identity.models.IdentityProvider(**kwargs)

Bases: object

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 Getting Started with Policies.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a IdentityProvider. This constant has a value of "ACTIVE"

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a IdentityProvider. This constant has a value of "CREATING"

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a IdentityProvider. This constant has a value of "DELETED"

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a IdentityProvider. This constant has a value of "DELETING"

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a IdentityProvider. This constant has a value of "INACTIVE"

__init__(**kwargs)

Initializes a new IdentityProvider object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • id (str) -- The value to assign to the id property of this IdentityProvider.
  • compartment_id (str) -- The value to assign to the compartment_id property of this IdentityProvider.
  • name (str) -- The value to assign to the name property of this IdentityProvider.
  • description (str) -- The value to assign to the description property of this IdentityProvider.
  • product_type (str) -- The value to assign to the product_type property of this IdentityProvider.
  • time_created (datetime) -- The value to assign to the time_created property of this IdentityProvider.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this IdentityProvider. Allowed values for this property are: "CREATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
  • inactive_status (int) -- The value to assign to the inactive_status property of this IdentityProvider.
  • protocol (str) -- The value to assign to the protocol property of this IdentityProvider.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this IdentityProvider.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this IdentityProvider.
compartment_id

[Required] Gets the compartment_id of this IdentityProvider. The OCID of the tenancy containing the IdentityProvider.

Returns:The compartment_id of this IdentityProvider.
Return type:str
defined_tags

Gets the defined_tags of this IdentityProvider. 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 defined_tags of this IdentityProvider.
Return type:dict(str, dict(str, object))
description

[Required] Gets the description of this IdentityProvider. The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.

Returns:The description of this IdentityProvider.
Return type:str
freeform_tags

Gets the freeform_tags of this IdentityProvider. 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 freeform_tags of this IdentityProvider.
Return type:dict(str, str)
static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

id

[Required] Gets the id of this IdentityProvider. The OCID of the IdentityProvider.

Returns:The id of this IdentityProvider.
Return type:str
inactive_status

Gets the inactive_status of this IdentityProvider. The detailed status of INACTIVE lifecycleState.

Returns:The inactive_status of this IdentityProvider.
Return type:int
lifecycle_state

[Required] Gets the lifecycle_state of this IdentityProvider. The current state. After creating an IdentityProvider, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Allowed values for this property are: "CREATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.

Returns:The lifecycle_state of this IdentityProvider.
Return type:str
name

[Required] Gets the name of this IdentityProvider. 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 name of this IdentityProvider.
Return type:str
product_type

[Required] Gets the product_type of this IdentityProvider. 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 product_type of this IdentityProvider.
Return type:str
protocol

[Required] Gets the protocol of this IdentityProvider. The protocol used for federation. Allowed value: SAML2.

Example: SAML2

Returns:The protocol of this IdentityProvider.
Return type:str
time_created

[Required] Gets the time_created of this IdentityProvider. Date and time the IdentityProvider was created, in the format defined by RFC3339.

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

Returns:The time_created of this IdentityProvider.
Return type:datetime