MyApiKey

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

Bases: object

The user’s API key.

Attributes:

IDCS_PREVENTED_OPERATIONS_DELETE

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

IDCS_PREVENTED_OPERATIONS_REPLACE

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

IDCS_PREVENTED_OPERATIONS_UPDATE

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

compartment_ocid

Gets the compartment_ocid of this MyApiKey.

delete_in_progress

Gets the delete_in_progress of this MyApiKey.

description

Gets the description of this MyApiKey.

domain_ocid

Gets the domain_ocid of this MyApiKey.

fingerprint

[Required] Gets the fingerprint of this MyApiKey.

id

Gets the id of this MyApiKey.

idcs_created_by

Gets the idcs_created_by of this MyApiKey.

idcs_last_modified_by

Gets the idcs_last_modified_by of this MyApiKey.

idcs_last_upgraded_in_release

Gets the idcs_last_upgraded_in_release of this MyApiKey.

idcs_prevented_operations

Gets the idcs_prevented_operations of this MyApiKey.

key

[Required] Gets the key of this MyApiKey.

meta

Gets the meta of this MyApiKey.

ocid

Gets the ocid of this MyApiKey.

schemas

[Required] Gets the schemas of this MyApiKey.

tags

Gets the tags of this MyApiKey.

tenancy_ocid

Gets the tenancy_ocid of this MyApiKey.

user

Gets the user of this MyApiKey.

Methods:

__init__(**kwargs)

Initializes a new MyApiKey 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 MyApiKey. 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 MyApiKey. 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 MyApiKey. This constant has a value of “update”

__init__(**kwargs)

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

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

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

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

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

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

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

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

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

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

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

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

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

  • fingerprint (str) – The value to assign to the fingerprint property of this MyApiKey.

  • key (str) – The value to assign to the key property of this MyApiKey.

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

property compartment_ocid

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

Return type

str

property delete_in_progress

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

Return type

bool

property description

Gets the description of this MyApiKey. Description

Added In: 2101262133

SCIM++ Properties:
  • caseExact: false

  • type: string

  • mutability: readWrite

  • required: false

  • returned: default

Returns

The description of this MyApiKey.

Return type

str

property domain_ocid

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

Return type

str

property fingerprint

[Required] Gets the fingerprint of this MyApiKey. Fingerprint

Added In: 2010242156

SCIM++ Properties:
  • caseExact: true

  • idcsSearchable: true

  • type: string

  • mutability: readOnly

  • required: true

  • returned: default

Returns

The fingerprint of this MyApiKey.

Return type

str

property id

Gets the id of this MyApiKey. 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 MyApiKey.

Return type

str

property idcs_created_by

Gets the idcs_created_by of this MyApiKey.

Returns

The idcs_created_by of this MyApiKey.

Return type

oci.identity_domains.models.IdcsCreatedBy

property idcs_last_modified_by

Gets the idcs_last_modified_by of this MyApiKey.

Returns

The idcs_last_modified_by of this MyApiKey.

Return type

oci.identity_domains.models.IdcsLastModifiedBy

property idcs_last_upgraded_in_release

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

Return type

str

property idcs_prevented_operations

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

Return type

list[str]

property key

[Required] Gets the key of this MyApiKey. Key

Added In: 2010242156

SCIM++ Properties:
  • caseExact: true

  • idcsPii: true

  • type: string

  • mutability: immutable

  • required: true

  • returned: default

Returns

The key of this MyApiKey.

Return type

str

property meta

Gets the meta of this MyApiKey.

Returns

The meta of this MyApiKey.

Return type

oci.identity_domains.models.Meta

property ocid

Gets the ocid of this MyApiKey. 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 MyApiKey.

Return type

str

property schemas

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

Return type

list[str]

property tags

Gets the tags of this MyApiKey. 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 MyApiKey.

Return type

list[oci.identity_domains.models.Tags]

property tenancy_ocid

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

Return type

str

property user

Gets the user of this MyApiKey.

Returns

The user of this MyApiKey.

Return type

oci.identity_domains.models.MyApiKeyUser