com.oracle.bmc.identity.model

Class AuthToken

java.lang.Object

com.oracle.bmc.identity.model.AuthToken

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class AuthToken
extends 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](https://docs.cloud.oracle.com/Content/Identity/access/managing-user-credentials.htm).
Note: Objects should always be created or deserialized using the AuthToken.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the AuthToken.Builder, which maintain a set of all explicitly set fields called __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthToken.Builder
static class	AuthToken.LifecycleState The token’s current state.

Constructor Summary

Constructors

Constructor and Description
AuthToken(String token, String id, String userId, String description, Date timeCreated, Date timeExpires, AuthToken.LifecycleState lifecycleState, Long inactiveStatus) Deprecated.

Method Summary

Modifier and Type	Method and Description
static AuthToken.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getDescription() The description you assign to the auth token.
String	getId() The OCID of the auth token.
Long	getInactiveStatus() The detailed status of INACTIVE lifecycleState.
AuthToken.LifecycleState	getLifecycleState() The token’s current state.
Date	getTimeCreated() Date and time the AuthToken object was created, in the format defined by RFC3339.
Date	getTimeExpires() Date and time when this auth token will expire, in the format defined by RFC3339.
String	getToken() The auth token.
String	getUserId() The OCID of the user the auth token belongs to.
int	hashCode()
AuthToken.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AuthToken

@ConstructorProperties(value={"token","id","userId","description","timeCreated","timeExpires","lifecycleState","inactiveStatus"})
 @Deprecated
public AuthToken(String token,
                                                                                                                                                                String id,
                                                                                                                                                                String userId,
                                                                                                                                                                String description,
                                                                                                                                                                Date timeCreated,
                                                                                                                                                                Date timeExpires,
                                                                                                                                                                AuthToken.LifecycleState lifecycleState,
                                                                                                                                                                Long inactiveStatus)

Deprecated.

Method Detail

builder

public static AuthToken.Builder builder()

Create a new builder.

toBuilder

public AuthToken.Builder toBuilder()

getToken

public String getToken()

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

getId

public String getId()

The OCID of the auth token.

getUserId

public String getUserId()

The OCID of the user the auth token belongs to.

getDescription

public String getDescription()

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.

getTimeCreated

public Date getTimeCreated()

Date and time the AuthToken object was created, in the format defined by RFC3339.

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

getTimeExpires

public Date getTimeExpires()

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

getLifecycleState

public AuthToken.LifecycleState getLifecycleState()

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

getInactiveStatus

public Long getInactiveStatus()

The detailed status of INACTIVE lifecycleState.

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object