AuthToken¶

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

Bases: object

An AuthToken is an Oracle-generated token string that you can use to authenticate with third-party APIs that do not support Oracle Cloud Infrastructure’s signature-based authentication. For example, use an AuthToken to authenticate with a Swift client with the Object Storage Service.

The auth token is associated with the user’s Console login. Auth tokens never expire. A user can have up to two auth tokens at a time.

Note: The token is always an Oracle-generated string; you can’t change it to a string of your choice.

For more information, see Managing User Credentials.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a AuthToken.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a AuthToken.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a AuthToken.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a AuthToken.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a AuthToken.
`description`	Gets the description of this AuthToken.
`id`	Gets the id of this AuthToken.
`inactive_status`	Gets the inactive_status of this AuthToken.
`lifecycle_state`	Gets the lifecycle_state of this AuthToken.
`time_created`	Gets the time_created of this AuthToken.
`time_expires`	Gets the time_expires of this AuthToken.
`token`	Gets the token of this AuthToken.
`user_id`	Gets the user_id of this AuthToken.

Methods

__init__(**kwargs) Initializes a new AuthToken object with values from keyword arguments.

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

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a AuthToken. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a AuthToken. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a AuthToken. This constant has a value of “DELETING”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state 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:

token (str) – The value to assign to the token property of this AuthToken.
id (str) – The value to assign to the id property of this AuthToken.
user_id (str) – The value to assign to the user_id property of this AuthToken.
description (str) – The value to assign to the description property of this AuthToken.
time_created (datetime) – The value to assign to the time_created property of this AuthToken.
time_expires (datetime) – The value to assign to the time_expires property of this AuthToken.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this AuthToken. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
inactive_status (int) – The value to assign to the inactive_status property of this AuthToken.

description¶

Gets the description of this AuthToken. The description you assign to the auth token. Does not have to be unique, and it’s changeable.

(For tenancies that support identity domains) You can have an empty description.

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

id¶

Gets the id of this AuthToken. The OCID of the auth token.

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

inactive_status¶

Gets the inactive_status of this AuthToken. The detailed status of INACTIVE lifecycleState.

Returns:	The inactive_status of this AuthToken.
Return type:	int

lifecycle_state¶

Gets the lifecycle_state of this AuthToken. The token’s current state. After creating an auth token, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

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

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

time_created¶

Gets the time_created of this AuthToken. Date and time the AuthToken object was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this AuthToken.
Return type:	datetime

time_expires¶

Gets the time_expires of this AuthToken. Date and time when this auth token will expire, in the format defined by RFC3339. Null if it never expires.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_expires of this AuthToken.
Return type:	datetime

token¶

Gets the token of this AuthToken. The auth token. The value is available only in the response for CreateAuthToken, and not for ListAuthTokens or UpdateAuthToken.

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

user_id¶

Gets the user_id of this AuthToken. The OCID of the user the auth token belongs to.

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