AuthToken¶

class oci.identity_domains.models.AuthToken(**kwargs)¶

Bases: object

The user’s Auth token resource.

Attributes

`IDCS_PREVENTED_OPERATIONS_DELETE`	A constant which can be used with the idcs_prevented_operations property of a AuthToken.
`IDCS_PREVENTED_OPERATIONS_REPLACE`	A constant which can be used with the idcs_prevented_operations property of a AuthToken.
`IDCS_PREVENTED_OPERATIONS_UPDATE`	A constant which can be used with the idcs_prevented_operations property of a AuthToken.
`STATUS_ACTIVE`	A constant which can be used with the status property of a AuthToken.
`STATUS_INACTIVE`	A constant which can be used with the status property of a AuthToken.
`compartment_ocid`	Gets the compartment_ocid of this AuthToken.
`delete_in_progress`	Gets the delete_in_progress of this AuthToken.
`description`	Gets the description of this AuthToken.
`domain_ocid`	Gets the domain_ocid of this AuthToken.
`expires_on`	Gets the expires_on of this AuthToken.
`id`	Gets the id of this AuthToken.
`idcs_created_by`	Gets the idcs_created_by of this AuthToken.
`idcs_last_modified_by`	Gets the idcs_last_modified_by of this AuthToken.
`idcs_last_upgraded_in_release`	Gets the idcs_last_upgraded_in_release of this AuthToken.
`idcs_prevented_operations`	Gets the idcs_prevented_operations of this AuthToken.
`meta`	Gets the meta of this AuthToken.
`ocid`	Gets the ocid of this AuthToken.
`schemas`	[Required] Gets the schemas of this AuthToken.
`status`	Gets the status of this AuthToken.
`tags`	Gets the tags of this AuthToken.
`tenancy_ocid`	Gets the tenancy_ocid of this AuthToken.
`token`	Gets the token of this AuthToken.
`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 AuthToken.
`user`	Gets the user of this AuthToken.

Methods

__init__(**kwargs) Initializes a new AuthToken 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 AuthToken. 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 AuthToken. 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 AuthToken. This constant has a value of “update”

STATUS_ACTIVE = 'ACTIVE'¶: A constant which can be used with the status property of a AuthToken. This constant has a value of “ACTIVE”

STATUS_INACTIVE = 'INACTIVE'¶: A constant which can be used with the status property of a AuthToken. This constant has a value of “INACTIVE”

__init__(**kwargs)¶

Initializes a new AuthToken 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 AuthToken.
ocid (str) – The value to assign to the ocid property of this AuthToken.
schemas (list[str]) – The value to assign to the schemas property of this AuthToken.
meta (oci.identity_domains.models.Meta) – The value to assign to the meta property of this AuthToken.
idcs_created_by (oci.identity_domains.models.IdcsCreatedBy) – The value to assign to the idcs_created_by property of this AuthToken.
idcs_last_modified_by (oci.identity_domains.models.IdcsLastModifiedBy) – The value to assign to the idcs_last_modified_by property of this AuthToken.
idcs_prevented_operations (list[str]) – The value to assign to the idcs_prevented_operations property of this AuthToken. 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 AuthToken.
delete_in_progress (bool) – The value to assign to the delete_in_progress property of this AuthToken.
idcs_last_upgraded_in_release (str) – The value to assign to the idcs_last_upgraded_in_release property of this AuthToken.
domain_ocid (str) – The value to assign to the domain_ocid property of this AuthToken.
compartment_ocid (str) – The value to assign to the compartment_ocid property of this AuthToken.
tenancy_ocid (str) – The value to assign to the tenancy_ocid property of this AuthToken.
description (str) – The value to assign to the description property of this AuthToken.
token (str) – The value to assign to the token property of this AuthToken.
status (str) – The value to assign to the status property of this AuthToken. 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 AuthToken.
user (oci.identity_domains.models.AuthTokenUser) – The value to assign to the user property of this AuthToken.
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 AuthToken.

compartment_ocid¶

Gets the compartment_ocid of this AuthToken. 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 AuthToken.
Return type:	str

delete_in_progress¶

Gets the delete_in_progress of this AuthToken. 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 AuthToken.
Return type:	bool

description¶

Gets the description of this AuthToken. Description

Added In: 2010242156

SCIM++ Properties:

caseExact: false
type: string
mutability: readWrite
required: false
returned: default

Returns:	The description of this AuthToken.
Return type:	str

domain_ocid¶

Gets the domain_ocid of this AuthToken. 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 AuthToken.
Return type:	str

expires_on¶

Gets the expires_on of this AuthToken. 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 AuthToken.
Return type:	str

id¶

Gets the id of this AuthToken. 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 AuthToken.
Return type:	str

idcs_created_by¶

Gets the idcs_created_by of this AuthToken.

Returns:	The idcs_created_by of this AuthToken.
Return type:	oci.identity_domains.models.IdcsCreatedBy

idcs_last_modified_by¶

Gets the idcs_last_modified_by of this AuthToken.

Returns:	The idcs_last_modified_by of this AuthToken.
Return type:	oci.identity_domains.models.IdcsLastModifiedBy

idcs_last_upgraded_in_release¶

Gets the idcs_last_upgraded_in_release of this AuthToken. 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 AuthToken.
Return type:	str

idcs_prevented_operations¶

Gets the idcs_prevented_operations of this AuthToken. 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 AuthToken.
Return type:	list[str]

meta¶

Gets the meta of this AuthToken.

Returns:	The meta of this AuthToken.
Return type:	oci.identity_domains.models.Meta

ocid¶

Gets the ocid of this AuthToken. 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 AuthToken.
Return type:	str

schemas¶

[Required] Gets the schemas of this AuthToken. 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 AuthToken.
Return type:	list[str]

status¶

Gets the status of this AuthToken. 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 AuthToken.
Return type:	str

tags¶

Gets the tags of this AuthToken. 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 AuthToken.
Return type:	list[oci.identity_domains.models.Tags]

tenancy_ocid¶

Gets the tenancy_ocid of this AuthToken. 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 AuthToken.
Return type:	str

token¶

Gets the token of this AuthToken. token

Added In: 2010242156

SCIM++ Properties:

caseExact: true
type: string
mutability: readOnly
required: false
returned: default
idcsSensitive: hash_sc

Returns:	The token of this AuthToken.
Return type:	str

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 AuthToken.

Returns:	The urn_ietf_params_scim_schemas_oracle_idcs_extension_self_change_user of this AuthToken.
Return type:	oci.identity_domains.models.ExtensionSelfChangeUser

user¶

Gets the user of this AuthToken.

Returns:	The user of this AuthToken.
Return type:	oci.identity_domains.models.AuthTokenUser