CustomerSecretKey

class oci.identity_domains.models.CustomerSecretKey(**kwargs)

Bases: object

The user’s customer secret key.

Attributes:

IDCS_PREVENTED_OPERATIONS_DELETE

A constant which can be used with the idcs_prevented_operations property of a CustomerSecretKey.

IDCS_PREVENTED_OPERATIONS_REPLACE

A constant which can be used with the idcs_prevented_operations property of a CustomerSecretKey.

IDCS_PREVENTED_OPERATIONS_UPDATE

A constant which can be used with the idcs_prevented_operations property of a CustomerSecretKey.

STATUS_ACTIVE

A constant which can be used with the status property of a CustomerSecretKey.

STATUS_INACTIVE

A constant which can be used with the status property of a CustomerSecretKey.

access_key

Gets the access_key of this CustomerSecretKey.

compartment_ocid

Gets the compartment_ocid of this CustomerSecretKey.

delete_in_progress

Gets the delete_in_progress of this CustomerSecretKey.

description

Gets the description of this CustomerSecretKey.

display_name

Gets the display_name of this CustomerSecretKey.

domain_ocid

Gets the domain_ocid of this CustomerSecretKey.

expires_on

Gets the expires_on of this CustomerSecretKey.

id

Gets the id of this CustomerSecretKey.

idcs_created_by

Gets the idcs_created_by of this CustomerSecretKey.

idcs_last_modified_by

Gets the idcs_last_modified_by of this CustomerSecretKey.

idcs_last_upgraded_in_release

Gets the idcs_last_upgraded_in_release of this CustomerSecretKey.

idcs_prevented_operations

Gets the idcs_prevented_operations of this CustomerSecretKey.

meta

Gets the meta of this CustomerSecretKey.

ocid

Gets the ocid of this CustomerSecretKey.

schemas

[Required] Gets the schemas of this CustomerSecretKey.

secret_key

Gets the secret_key of this CustomerSecretKey.

status

Gets the status of this CustomerSecretKey.

tags

Gets the tags of this CustomerSecretKey.

tenancy_ocid

Gets the tenancy_ocid of this CustomerSecretKey.

urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user

Gets the urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user of this CustomerSecretKey.

user

Gets the user of this CustomerSecretKey.

Methods:

__init__(**kwargs)

Initializes a new CustomerSecretKey object with values from keyword arguments.

IDCS_PREVENTED_OPERATIONS_DELETE = 'delete'

A constant which can be used with the idcs_prevented_operations property of a CustomerSecretKey. 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 CustomerSecretKey. 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 CustomerSecretKey. This constant has a value of “update”

STATUS_ACTIVE = 'ACTIVE'

A constant which can be used with the status property of a CustomerSecretKey. This constant has a value of “ACTIVE”

STATUS_INACTIVE = 'INACTIVE'

A constant which can be used with the status property of a CustomerSecretKey. This constant has a value of “INACTIVE”

__init__(**kwargs)

Initializes a new CustomerSecretKey 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 CustomerSecretKey.

  • ocid (str) – The value to assign to the ocid property of this CustomerSecretKey.

  • schemas (list[str]) – The value to assign to the schemas property of this CustomerSecretKey.

  • meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this CustomerSecretKey.

  • idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this CustomerSecretKey.

  • idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this CustomerSecretKey.

  • idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this CustomerSecretKey. 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 CustomerSecretKey.

  • delete_in_progress (bool) – The value to assign to the delete_in_progress property of this CustomerSecretKey.

  • idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this CustomerSecretKey.

  • domain_ocid (str) – The value to assign to the domain_ocid property of this CustomerSecretKey.

  • compartment_ocid (str) – The value to assign to the compartment_ocid property of this CustomerSecretKey.

  • tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this CustomerSecretKey.

  • display_name (str) – The value to assign to the display_name property of this CustomerSecretKey.

  • description (str) – The value to assign to the description property of this CustomerSecretKey.

  • status (str) – The value to assign to the status property of this CustomerSecretKey. Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • expires_on (str) – The value to assign to the expires_on property of this CustomerSecretKey.

  • access_key (str) – The value to assign to the access_key property of this CustomerSecretKey.

  • secret_key (str) – The value to assign to the secret_key property of this CustomerSecretKey.

  • user (oci.identity_domains.models.CustomerSecretKeyUser) – The value to assign to the user property of this CustomerSecretKey.

  • urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user (oci.identity_domains.models.ExtensionSelfChangeUser) – The value to assign to the urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user property of this CustomerSecretKey.

property access_key

Gets the access_key of this CustomerSecretKey. The access key.

SCIM++ Properties:
  • caseExact: true

  • type: string

  • mutability: readOnly

  • required: false

  • returned: default

Returns

The access_key of this CustomerSecretKey.

Return type

str

property compartment_ocid

Gets the compartment_ocid of this CustomerSecretKey. 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 CustomerSecretKey.

Return type

str

property delete_in_progress

Gets the delete_in_progress of this CustomerSecretKey. 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 CustomerSecretKey.

Return type

bool

property description

Gets the description of this CustomerSecretKey. Description

SCIM++ Properties:
  • caseExact: false

  • type: string

  • mutability: readWrite

  • required: false

  • returned: default

Returns

The description of this CustomerSecretKey.

Return type

str

property display_name

Gets the display_name of this CustomerSecretKey. Display Name

SCIM++ Properties:
  • caseExact: false

  • type: string

  • mutability: readWrite

  • required: false

  • returned: default

Returns

The display_name of this CustomerSecretKey.

Return type

str

property domain_ocid

Gets the domain_ocid of this CustomerSecretKey. 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 CustomerSecretKey.

Return type

str

property expires_on

Gets the expires_on of this CustomerSecretKey. When the user’s credential expire.

Added In: 2109090424

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: immutable

  • required: false

  • returned: default

  • type: dateTime

  • uniqueness: none

Returns

The expires_on of this CustomerSecretKey.

Return type

str

property id

Gets the id of this CustomerSecretKey. 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: false

  • idcsSearchable: true

  • multiValued: false

  • mutability: readOnly

  • required: false

  • returned: always

  • type: string

  • uniqueness: global

Returns

The id of this CustomerSecretKey.

Return type

str

property idcs_created_by

Gets the idcs_created_by of this CustomerSecretKey.

Returns

The idcs_created_by of this CustomerSecretKey.

Return type

oci.identity_domains.models.IdcsCreatedBy

property idcs_last_modified_by

Gets the idcs_last_modified_by of this CustomerSecretKey.

Returns

The idcs_last_modified_by of this CustomerSecretKey.

Return type

oci.identity_domains.models.IdcsLastModifiedBy

property idcs_last_upgraded_in_release

Gets the idcs_last_upgraded_in_release of this CustomerSecretKey. 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 CustomerSecretKey.

Return type

str

property idcs_prevented_operations

Gets the idcs_prevented_operations of this CustomerSecretKey. 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 CustomerSecretKey.

Return type

list[str]

property meta

Gets the meta of this CustomerSecretKey.

Returns

The meta of this CustomerSecretKey.

Return type

oci.identity_domains.models.Meta

property ocid

Gets the ocid of this CustomerSecretKey. Unique OCI identifier 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 CustomerSecretKey.

Return type

str

property schemas

[Required] Gets the schemas of this CustomerSecretKey. 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 CustomerSecretKey.

Return type

list[str]

property secret_key

Gets the secret_key of this CustomerSecretKey. The secret key.

SCIM++ Properties:
  • caseExact: true

  • type: string

  • mutability: readOnly

  • required: false

  • returned: default

Returns

The secret_key of this CustomerSecretKey.

Return type

str

property status

Gets the status of this CustomerSecretKey. The user’s credential status.

Added In: 2109090424

SCIM++ Properties:
  • caseExact: false

  • idcsSearchable: false

  • multiValued: false

  • mutability: readWrite

  • required: false

  • returned: never

  • type: string

  • uniqueness: none

Allowed values for this property are: “ACTIVE”, “INACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The status of this CustomerSecretKey.

Return type

str

property tags

Gets the tags of this CustomerSecretKey. A list of tags on this resource.

SCIM++ Properties:
  • idcsCompositeKey: [key, value]

  • idcsSearchable: true

  • multiValued: true

  • mutability: readWrite

  • required: false

  • returned: request

  • type: complex

  • uniqueness: none

Returns

The tags of this CustomerSecretKey.

Return type

list[oci.identity_domains.models.Tags]

property tenancy_ocid

Gets the tenancy_ocid of this CustomerSecretKey. 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 CustomerSecretKey.

Return type

str

property urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user

Gets the urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user of this CustomerSecretKey.

Returns

The urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user of this CustomerSecretKey.

Return type

oci.identity_domains.models.ExtensionSelfChangeUser

property user

Gets the user of this CustomerSecretKey.

Returns

The user of this CustomerSecretKey.

Return type

oci.identity_domains.models.CustomerSecretKeyUser