com.oracle.bmc.identity.model

Class ApiKey

java.lang.Object

com.oracle.bmc.identity.model.ApiKey

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class ApiKey
extends Object

A PEM-format RSA credential for securing requests to the Oracle Cloud Infrastructure REST API. Also known as an API signing key. Specifically, this is the public key from the key pair. The private key remains with the user calling the API. For information about generating a key pair in the required PEM format, see Required Keys and OCIDs.

Important:** This is **not** the SSH key for accessing compute instances.

Each user can have a maximum of three API signing keys.

For more information about user credentials, see [User Credentials](https://docs.cloud.oracle.com/Content/Identity/Concepts/usercredentials.htm).
Note: Objects should always be created or deserialized using the ApiKey.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 ApiKey.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	ApiKey.Builder
static class	ApiKey.LifecycleState The API key’s current state.

Constructor Summary

Constructors

Constructor and Description
ApiKey(String keyId, String keyValue, String fingerprint, String userId, Date timeCreated, ApiKey.LifecycleState lifecycleState, Long inactiveStatus) Deprecated.

Method Summary

Modifier and Type	Method and Description
static ApiKey.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getFingerprint() The key’s fingerprint (e.g., 12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef).
Long	getInactiveStatus() The detailed status of INACTIVE lifecycleState.
String	getKeyId() An Oracle-assigned identifier for the key, in this format: TENANCY_OCID/USER_OCID/KEY_FINGERPRINT.
String	getKeyValue() The key’s value.
ApiKey.LifecycleState	getLifecycleState() The API key’s current state.
Date	getTimeCreated() Date and time the ApiKey object was created, in the format defined by RFC3339.
String	getUserId() The OCID of the user the key belongs to.
int	hashCode()
ApiKey.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiKey

@Deprecated
 @ConstructorProperties(value={"keyId","keyValue","fingerprint","userId","timeCreated","lifecycleState","inactiveStatus"})
public ApiKey(String keyId,
                                                                                                                                                     String keyValue,
                                                                                                                                                     String fingerprint,
                                                                                                                                                     String userId,
                                                                                                                                                     Date timeCreated,
                                                                                                                                                     ApiKey.LifecycleState lifecycleState,
                                                                                                                                                     Long inactiveStatus)

Deprecated.

Method Detail

builder

public static ApiKey.Builder builder()

Create a new builder.

toBuilder

public ApiKey.Builder toBuilder()

getKeyId

public String getKeyId()

An Oracle-assigned identifier for the key, in this format: TENANCY_OCID/USER_OCID/KEY_FINGERPRINT.

Returns:

the value

getKeyValue

public String getKeyValue()

The key’s value.

Returns:

the value

getFingerprint

public String getFingerprint()

The key’s fingerprint (e.g., 12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef).

Returns:

the value

getUserId

public String getUserId()

The OCID of the user the key belongs to.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

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

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

Returns:

the value

getLifecycleState

public ApiKey.LifecycleState getLifecycleState()

The API key’s current state. After creating an ApiKey object, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Returns:

the value

getInactiveStatus

public Long getInactiveStatus()

The detailed status of INACTIVE lifecycleState.

Returns:

the value

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

get__explicitlySet__

public Set<String> get__explicitlySet__()