IdentityProofingProvider¶
- class oci.identity_domains.models.IdentityProofingProvider(**kwargs)¶
Bases:
objectManage Identity Proofing Providers. Oracle Identity Cloud Service provides cross-domain SSO capabilities via the OASIS SAML 2.0 SSO protocol and implements two modes of operation for Federation SSO–as an IdP where the user is authenticated on behalf of remote Service Providers (SP), and as an SP where Oracle Identity Cloud Service delegates authentication to a remote IdP. As an IdP, Oracle Identity Cloud Service can integrate with multiple SPs at the same time. As an SP, This REST API is SCIM compliant.
Attributes:
A constant which can be used with the idcs_locked_operations property of a IdentityProofingProvider.
A constant which can be used with the idcs_locked_operations property of a IdentityProofingProvider.
A constant which can be used with the idcs_locked_operations property of a IdentityProofingProvider.
A constant which can be used with the idcs_prevented_operations property of a IdentityProofingProvider.
A constant which can be used with the idcs_prevented_operations property of a IdentityProofingProvider.
A constant which can be used with the idcs_prevented_operations property of a IdentityProofingProvider.
A constant which can be used with the status property of a IdentityProofingProvider.
A constant which can be used with the status property of a IdentityProofingProvider.
[Required] Gets the claim_mapping of this IdentityProofingProvider.
Gets the compartment_ocid of this IdentityProofingProvider.
[Required] Gets the configuration of this IdentityProofingProvider.
Gets the delete_in_progress of this IdentityProofingProvider.
Gets the description of this IdentityProofingProvider.
Gets the domain_ocid of this IdentityProofingProvider.
Gets the id of this IdentityProofingProvider.
Gets the idcs_created_by of this IdentityProofingProvider.
Gets the idcs_last_modified_by of this IdentityProofingProvider.
Gets the idcs_last_upgraded_in_release of this IdentityProofingProvider.
Gets the idcs_locked_by of this IdentityProofingProvider.
Gets the idcs_locked_on of this IdentityProofingProvider.
Gets the idcs_locked_operations of this IdentityProofingProvider.
Gets the idcs_prevented_operations of this IdentityProofingProvider.
Gets the meta of this IdentityProofingProvider.
[Required] Gets the name of this IdentityProofingProvider.
Gets the ocid of this IdentityProofingProvider.
[Required] Gets the provider of this IdentityProofingProvider.
Gets the runtime_data of this IdentityProofingProvider.
[Required] Gets the schemas of this IdentityProofingProvider.
Gets the status of this IdentityProofingProvider.
Gets the tags of this IdentityProofingProvider.
Gets the tenancy_ocid of this IdentityProofingProvider.
Methods:
__init__(**kwargs)Initializes a new IdentityProofingProvider object with values from keyword arguments.
- IDCS_LOCKED_OPERATIONS_DELETE = 'delete'¶
A constant which can be used with the idcs_locked_operations property of a IdentityProofingProvider. This constant has a value of “delete”
- IDCS_LOCKED_OPERATIONS_REPLACE = 'replace'¶
A constant which can be used with the idcs_locked_operations property of a IdentityProofingProvider. This constant has a value of “replace”
- IDCS_LOCKED_OPERATIONS_UPDATE = 'update'¶
A constant which can be used with the idcs_locked_operations property of a IdentityProofingProvider. This constant has a value of “update”
- IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'¶
A constant which can be used with the idcs_prevented_operations property of a IdentityProofingProvider. This constant has a value of “delete”
- IDCS_PREVENTED_OPERATIONS_REPLACE = 'replace'¶
A constant which can be used with the idcs_prevented_operations property of a IdentityProofingProvider. This constant has a value of “replace”
- IDCS_PREVENTED_OPERATIONS_UPDATE = 'update'¶
A constant which can be used with the idcs_prevented_operations property of a IdentityProofingProvider. This constant has a value of “update”
- STATUS_ACTIVE = 'ACTIVE'¶
A constant which can be used with the status property of a IdentityProofingProvider. This constant has a value of “ACTIVE”
- STATUS_INACTIVE = 'INACTIVE'¶
A constant which can be used with the status property of a IdentityProofingProvider. This constant has a value of “INACTIVE”
- __init__(**kwargs)¶
Initializes a new IdentityProofingProvider object with values from keyword arguments. 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 IdentityProofingProvider.
ocid (str) – The value to assign to the ocid property of this IdentityProofingProvider.
schemas (list[str]) – The value to assign to the schemas property of this IdentityProofingProvider.
meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this IdentityProofingProvider.
idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this IdentityProofingProvider.
idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this IdentityProofingProvider.
idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this IdentityProofingProvider. Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
tags (list[oci.identity_domains.models.Tags]) – The value to assign to the tags property of this IdentityProofingProvider.
idcs_locked_operations (list[str]) – The value to assign to the idcs_locked_operations property of this IdentityProofingProvider. Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
idcs_locked_by (oci.identity_domains.models.IdentityProofingProviderIdcsLockedBy) – The value to assign to the idcs_locked_by property of this IdentityProofingProvider.
idcs_locked_on (str) – The value to assign to the idcs_locked_on property of this IdentityProofingProvider.
delete_in_progress (bool) – The value to assign to the delete_in_progress property of this IdentityProofingProvider.
idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this IdentityProofingProvider.
domain_ocid (str) – The value to assign to the domain_ocid property of this IdentityProofingProvider.
compartment_ocid (str) – The value to assign to the compartment_ocid property of this IdentityProofingProvider.
tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this IdentityProofingProvider.
provider (str) – The value to assign to the provider property of this IdentityProofingProvider.
name (str) – The value to assign to the name property of this IdentityProofingProvider.
description (str) – The value to assign to the description property of this IdentityProofingProvider.
status (str) – The value to assign to the status property of this IdentityProofingProvider. Allowed values for this property are: “INACTIVE”, “ACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
runtime_data (list[oci.identity_domains.models.IdentityProofingProviderRuntimeData]) – The value to assign to the runtime_data property of this IdentityProofingProvider.
configuration (list[oci.identity_domains.models.IdentityProofingProviderConfiguration]) – The value to assign to the configuration property of this IdentityProofingProvider.
claim_mapping (list[oci.identity_domains.models.IdentityProofingProviderClaimMapping]) – The value to assign to the claim_mapping property of this IdentityProofingProvider.
- property claim_mapping¶
[Required] Gets the claim_mapping of this IdentityProofingProvider. Configure the verification claims and IAM Domain user attribute mapping.
- SCIM++ Properties:
idcsSearchable: false
multiValued: true
mutability: immutable
required: true
returned: always
idcsCompositeKey: [verifiableClaim]
type: complex
uniqueness: server
- Returns
The claim_mapping of this IdentityProofingProvider.
- Return type
list[oci.identity_domains.models.IdentityProofingProviderClaimMapping]
- property compartment_ocid¶
Gets the compartment_ocid of this IdentityProofingProvider. OCI Compartment Id (OCID) in which the resource lives.
- SCIM++ Properties:
caseExact: false
idcsSearchable: false
multiValued: false
mutability: readOnly
required: false
returned: default
type: string
uniqueness: none
- Returns
The compartment_ocid of this IdentityProofingProvider.
- Return type
str
- property configuration¶
[Required] Gets the configuration of this IdentityProofingProvider. Configure the verification provider.
- SCIM++ Properties:
idcsSearchable: false
multiValued: true
mutability: immutable
required: true
returned: always
idcsCompositeKey: [name]
type: complex
uniqueness: server
- Returns
The configuration of this IdentityProofingProvider.
- Return type
list[oci.identity_domains.models.IdentityProofingProviderConfiguration]
- property delete_in_progress¶
Gets the delete_in_progress of this IdentityProofingProvider. A boolean flag indicating this resource in the process of being deleted. Usually set to true when synchronous deletion of the resource would take too long.
- SCIM++ Properties:
caseExact: false
idcsSearchable: true
multiValued: false
mutability: readOnly
required: false
returned: default
type: boolean
uniqueness: none
- Returns
The delete_in_progress of this IdentityProofingProvider.
- Return type
bool
- property description¶
Gets the description of this IdentityProofingProvider. Description field to add comments and additional information about the Identity Proofing Provider.
- SCIM++ Properties:
idcsSearchable: false
multiValued: false
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none
- Returns
The description of this IdentityProofingProvider.
- Return type
str
- property domain_ocid¶
Gets the domain_ocid of this IdentityProofingProvider. OCI Domain Id (OCID) in which the resource lives.
- SCIM++ Properties:
caseExact: false
idcsSearchable: false
multiValued: false
mutability: readOnly
required: false
returned: default
type: string
uniqueness: none
- Returns
The domain_ocid of this IdentityProofingProvider.
- Return type
str
- property id¶
Gets the id of this IdentityProofingProvider. Unique identifier for the SCIM Resource as defined by the Service Provider. Each representation of the Resource MUST include a non-empty id value. This identifier MUST be unique across the Service Provider’s entire set of Resources. It MUST be a stable, non-reassignable identifier that does not change when the same Resource is returned in subsequent requests. The value of the id attribute is always issued by the Service Provider and MUST never be specified by the Service Consumer. bulkId: is a reserved keyword and MUST NOT be used in the unique identifier.
- SCIM++ Properties:
caseExact: true
idcsSearchable: true
multiValued: false
mutability: readOnly
required: false
returned: always
type: string
uniqueness: global
- Returns
The id of this IdentityProofingProvider.
- Return type
str
- property idcs_created_by¶
Gets the idcs_created_by of this IdentityProofingProvider.
- Returns
The idcs_created_by of this IdentityProofingProvider.
- Return type
- property idcs_last_modified_by¶
Gets the idcs_last_modified_by of this IdentityProofingProvider.
- Returns
The idcs_last_modified_by of this IdentityProofingProvider.
- Return type
- property idcs_last_upgraded_in_release¶
Gets the idcs_last_upgraded_in_release of this IdentityProofingProvider. The release number when the resource was upgraded.
- SCIM++ Properties:
caseExact: false
idcsSearchable: false
multiValued: false
mutability: readOnly
required: false
returned: request
type: string
uniqueness: none
- Returns
The idcs_last_upgraded_in_release of this IdentityProofingProvider.
- Return type
str
- property idcs_locked_by¶
Gets the idcs_locked_by of this IdentityProofingProvider.
- Returns
The idcs_locked_by of this IdentityProofingProvider.
- Return type
oci.identity_domains.models.IdentityProofingProviderIdcsLockedBy
- property idcs_locked_on¶
Gets the idcs_locked_on of this IdentityProofingProvider. The most recent DateTime the resource was locked.
- SCIM++ Properties:
caseExact: false
idcsSearchable: false
multiValued: false
mutability: readOnly
required: false
returned: default
type: dateTime
uniqueness: none
- Returns
The idcs_locked_on of this IdentityProofingProvider.
- Return type
str
- property idcs_locked_operations¶
Gets the idcs_locked_operations of this IdentityProofingProvider. Operations that are locked on the resource.
- SCIM++ Properties:
idcsSearchable: false
idcsCsvAttributeNameMappings: [[columnHeaderName:Locked Operations, multiValueDelimiter:;]]
multiValued: true
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none
Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The idcs_locked_operations of this IdentityProofingProvider.
- Return type
list[str]
- property idcs_prevented_operations¶
Gets the idcs_prevented_operations of this IdentityProofingProvider. Each value of this attribute specifies an operation that only an internal client may perform on this particular resource.
- SCIM++ Properties:
idcsSearchable: false
multiValued: true
mutability: readOnly
required: false
returned: request
type: string
uniqueness: none
Allowed values for items in this list are: “replace”, “update”, “delete”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The idcs_prevented_operations of this IdentityProofingProvider.
- Return type
list[str]
- property meta¶
Gets the meta of this IdentityProofingProvider.
- Returns
The meta of this IdentityProofingProvider.
- Return type
- property name¶
[Required] Gets the name of this IdentityProofingProvider. Name of the Identity Proofing Provider.
- SCIM++ Properties:
idcsSearchable: false
multiValued: false
mutability: readWrite
required: true
returned: always
type: string
uniqueness: global
- Returns
The name of this IdentityProofingProvider.
- Return type
str
- property ocid¶
Gets the ocid of this IdentityProofingProvider. Unique OCI identifier (OCID) for the SCIM Resource.
- SCIM++ Properties:
caseExact: true
idcsSearchable: true
multiValued: false
mutability: immutable
required: false
returned: default
type: string
uniqueness: global
- Returns
The ocid of this IdentityProofingProvider.
- Return type
str
- property provider¶
[Required] Gets the provider of this IdentityProofingProvider. The Identity Proofing Provider.
- SCIM++ Properties:
idcsSearchable: true
multiValued: false
mutability: readWrite
idcsCanonicalValueSourceFilter: provider eq “$(provider)”
idcsCanonicalValueSourceResourceType: IdentityProofingProviderTemplate
caseExact: true
required: true
returned: always
type: string
uniqueness: none
- Returns
The provider of this IdentityProofingProvider.
- Return type
str
- property runtime_data¶
Gets the runtime_data of this IdentityProofingProvider. Identity Proofing runtime custom data.
Added In: 2505161800
- SCIM++ Properties:
idcsCompositeKey: [attrName]
multiValued: true
mutability: readWrite
required: false
returned: default
type: complex
- Returns
The runtime_data of this IdentityProofingProvider.
- Return type
list[oci.identity_domains.models.IdentityProofingProviderRuntimeData]
- property schemas¶
[Required] Gets the schemas of this IdentityProofingProvider. REQUIRED. The schemas attribute is an array of Strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each String value must be a unique URI. This specification defines URIs for User, Group, and a standard “enterprise” extension. All representations of SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.
- SCIM++ Properties:
caseExact: false
idcsSearchable: false
multiValued: true
mutability: readWrite
required: true
returned: default
type: string
uniqueness: none
- Returns
The schemas of this IdentityProofingProvider.
- Return type
list[str]
- property status¶
Gets the status of this IdentityProofingProvider. Status of the Identity Proofing Provider.
- SCIM++ Properties:
idcsSearchable: true
multiValued: false
caseExact: true
mutability: readWrite
required: false
returned: default
type: string
uniqueness: none
Allowed values for this property are: “INACTIVE”, “ACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The status of this IdentityProofingProvider.
- Return type
str
- property tags¶
Gets the tags of this IdentityProofingProvider. A list of tags on this resource.
- SCIM++ Properties:
idcsCompositeKey: [key, value]
idcsCsvAttributeNameMappings: [[columnHeaderName:Tag Key, mapsTo:tags.key], [columnHeaderName:Tag Value, mapsTo:tags.value]]
idcsSearchable: true
multiValued: true
mutability: readWrite
required: false
returned: request
type: complex
uniqueness: none
- Returns
The tags of this IdentityProofingProvider.
- Return type
- property tenancy_ocid¶
Gets the tenancy_ocid of this IdentityProofingProvider. OCI Tenant Id (OCID) in which the resource lives.
- SCIM++ Properties:
caseExact: false
idcsSearchable: false
multiValued: false
mutability: readOnly
required: false
returned: default
type: string
uniqueness: none
- Returns
The tenancy_ocid of this IdentityProofingProvider.
- Return type
str