Class AuthToken

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.

Inheritance

object

AuthToken

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.IdentityService.Models

Assembly: OCI.DotNetSDK.Identity.dll

Syntax

public class AuthToken

Properties

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
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.

Id

Declaration

[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the auth token.

InactiveStatus

Declaration

[JsonProperty(PropertyName = "inactiveStatus")]
public long? InactiveStatus { get; set; }

Property Value

Type	Description
long?	The detailed status of INACTIVE lifecycleState.

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AuthToken.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
AuthToken.LifecycleStateEnum?	The token's current state. After creating an auth token, make sure its `lifecycleState` changes from CREATING to ACTIVE before using it.

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	Date and time the `AuthToken` object was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

TimeExpires

Declaration

[JsonProperty(PropertyName = "timeExpires")]
public DateTime? TimeExpires { get; set; }

Property Value

Type	Description
DateTime?	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

Token

Declaration

[JsonProperty(PropertyName = "token")]
public string Token { get; set; }

Property Value

Type	Description
string	The auth token. The value is available only in the response for `CreateAuthToken`, and not for `ListAuthTokens` or `UpdateAuthToken`.

UserId

Declaration

[JsonProperty(PropertyName = "userId")]
public string UserId { get; set; }

Property Value

Type	Description
string	The OCID of the user the auth token belongs to.