CreateSaml2IdentityProviderDetails¶
- class oci.identity.models.CreateSaml2IdentityProviderDetails(**kwargs)¶
Bases:
CreateIdentityProviderDetailsCreateSaml2IdentityProviderDetails model.
Attributes:
A constant which can be used with the product_type property of a CreateIdentityProviderDetails.
A constant which can be used with the product_type property of a CreateIdentityProviderDetails.
A constant which can be used with the protocol property of a CreateIdentityProviderDetails.
A constant which can be used with the protocol property of a CreateIdentityProviderDetails.
[Required] Gets the compartment_id of this CreateIdentityProviderDetails.
Gets the defined_tags of this CreateIdentityProviderDetails.
[Required] Gets the description of this CreateIdentityProviderDetails.
Gets the freeform_attributes of this CreateSaml2IdentityProviderDetails.
Gets the freeform_tags of this CreateIdentityProviderDetails.
[Required] Gets the metadata of this CreateSaml2IdentityProviderDetails.
[Required] Gets the metadata_url of this CreateSaml2IdentityProviderDetails.
[Required] Gets the name of this CreateIdentityProviderDetails.
[Required] Gets the product_type of this CreateIdentityProviderDetails.
[Required] Gets the protocol of this CreateIdentityProviderDetails.
Methods:
__init__(**kwargs)Initializes a new CreateSaml2IdentityProviderDetails object with values from keyword arguments.
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.
- PRODUCT_TYPE_ADFS = 'ADFS'¶
A constant which can be used with the product_type property of a CreateIdentityProviderDetails. This constant has a value of “ADFS”
- PRODUCT_TYPE_IDCS = 'IDCS'¶
A constant which can be used with the product_type property of a CreateIdentityProviderDetails. This constant has a value of “IDCS”
- PROTOCOL_ADFS = 'ADFS'¶
A constant which can be used with the protocol property of a CreateIdentityProviderDetails. This constant has a value of “ADFS”
- PROTOCOL_SAML2 = 'SAML2'¶
A constant which can be used with the protocol property of a CreateIdentityProviderDetails. This constant has a value of “SAML2”
- __init__(**kwargs)¶
Initializes a new CreateSaml2IdentityProviderDetails object with values from keyword arguments. The default value of the
protocolattribute of this class isSAML2and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):- Parameters
compartment_id (str) – The value to assign to the compartment_id property of this CreateSaml2IdentityProviderDetails.
name (str) – The value to assign to the name property of this CreateSaml2IdentityProviderDetails.
description (str) – The value to assign to the description property of this CreateSaml2IdentityProviderDetails.
product_type (str) – The value to assign to the product_type property of this CreateSaml2IdentityProviderDetails. Allowed values for this property are: “IDCS”, “ADFS”
protocol (str) – The value to assign to the protocol property of this CreateSaml2IdentityProviderDetails. Allowed values for this property are: “SAML2”, “ADFS”
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateSaml2IdentityProviderDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateSaml2IdentityProviderDetails.
metadata_url (str) – The value to assign to the metadata_url property of this CreateSaml2IdentityProviderDetails.
metadata (str) – The value to assign to the metadata property of this CreateSaml2IdentityProviderDetails.
freeform_attributes (dict(str, str)) – The value to assign to the freeform_attributes property of this CreateSaml2IdentityProviderDetails.
- property compartment_id¶
[Required] Gets the compartment_id of this CreateIdentityProviderDetails. The OCID of your tenancy.
- Returns
The compartment_id of this CreateIdentityProviderDetails.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CreateIdentityProviderDetails. 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 CreateIdentityProviderDetails.
- Return type
dict(str, dict(str, object))
- property description¶
[Required] Gets the description of this CreateIdentityProviderDetails. The description you assign to the IdentityProvider during creation. Does not have to be unique, and it’s changeable.
- Returns
The description of this CreateIdentityProviderDetails.
- Return type
str
- property freeform_attributes¶
Gets the freeform_attributes of this CreateSaml2IdentityProviderDetails. Extra name value pairs associated with this identity provider. Example: {“clientId”: “app_sf3kdjf3”}
- Returns
The freeform_attributes of this CreateSaml2IdentityProviderDetails.
- Return type
dict(str, str)
- property freeform_tags¶
Gets the freeform_tags of this CreateIdentityProviderDetails. 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 CreateIdentityProviderDetails.
- 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.
- property metadata¶
[Required] Gets the metadata of this CreateSaml2IdentityProviderDetails. The XML that contains the information required for federating.
- Returns
The metadata of this CreateSaml2IdentityProviderDetails.
- Return type
str
- property metadata_url¶
[Required] Gets the metadata_url of this CreateSaml2IdentityProviderDetails. The URL for retrieving the identity provider’s metadata, which contains information required for federating.
- Returns
The metadata_url of this CreateSaml2IdentityProviderDetails.
- Return type
str
- property name¶
[Required] Gets the name of this CreateIdentityProviderDetails. 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.
- Returns
The name of this CreateIdentityProviderDetails.
- Return type
str
- property product_type¶
[Required] Gets the product_type of this CreateIdentityProviderDetails. The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS).
Example: IDCS
Allowed values for this property are: “IDCS”, “ADFS”
- Returns
The product_type of this CreateIdentityProviderDetails.
- Return type
str
- property protocol¶
[Required] Gets the protocol of this CreateIdentityProviderDetails. The protocol used for federation.
Example: SAML2
Allowed values for this property are: “SAML2”, “ADFS”
- Returns
The protocol of this CreateIdentityProviderDetails.
- Return type
str