Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AuthToken

An {@code 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 {@code 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](https://docs.cloud.oracle.com/Content/Identity/access/managing-user-credentials.htm).

Properties

Optional description

description: undefined | string

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.

Optional id

id: undefined | string

The OCID of the auth token.

Optional inactiveStatus

inactiveStatus: undefined | number

The detailed status of INACTIVE lifecycleState. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional lifecycleState

lifecycleState: LifecycleState

The token's current state. After creating an auth token, make sure its {@code lifecycleState} changes from CREATING to ACTIVE before using it.

Optional timeCreated

timeCreated: Date

Date and time the {@code AuthToken} object was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Optional timeExpires

timeExpires: Date

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

Example: {@code 2016-08-25T21:10:29.600Z}

Optional token

token: undefined | string

The auth token. The value is available only in the response for {@code CreateAuthToken}, and not for {@code ListAuthTokens} or {@code UpdateAuthToken}.

Optional userId

userId: undefined | string

The OCID of the user the auth token belongs to.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: AuthToken): object

getJsonObj