com.nutanix.dp1.iam.iam.v4.authn

Class ApiKey

java.lang.Object

com.nutanix.dp1.iam.common.v1.config.TenantAwareModel

com.nutanix.dp1.iam.common.v1.response.ExternalizableAbstractModel

com.nutanix.dp1.iam.iam.v4.authn.ApiKey

All Implemented Interfaces:

com.nutanix.dp1.iam.deserializers.IamObjectTypeTypedObject, com.nutanix.json.deserializers.ObjectTypeTypedObject, Serializable

Direct Known Subclasses:

ApiKeyValidateResponse

public class ApiKey
extends ExternalizableAbstractModel
implements Serializable, com.nutanix.dp1.iam.deserializers.IamObjectTypeTypedObject

Credentials in the form of a unique random key for the Service Account.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
ApiKeyCustomOptions	customOptions
@Pattern(regexp="^[^<>;()&+%/\\\\\"`]*$") @Size(max=1000) String	description Brief description of the API Key.
OffsetDateTime	expiryTime The expiry time of the API Key.
@Pattern(regexp="^[^<>;\'()&+%/\\\\\"`]*$") @Size(min=1,max=255) String	name Identifier for the API Key in the form of a name.
@Size(min=0,max=50) List<String>	scope An optional set of audiences for the API key, meant to restrict its access to APIs.
ApiKeyStatusType	status

Fields inherited from class com.nutanix.dp1.iam.common.v1.response.ExternalizableAbstractModel

extId

Constructor Summary

Constructors

Constructor and Description
ApiKey()
ApiKey(String tenantId, String extId, List<ApiLink> links, String name, String description, List<String> scope, ApiKeyCustomOptions customOptions, String apiKey, ApiKeyStatusType status, OffsetDateTime createdTime, String createdBy, OffsetDateTime lastUsedTime, OffsetDateTime expiryTime)

Method Summary

Modifier and Type	Method and Description
void	setApiKey(String apiKey) The actual API key value, returned only during creation.
void	setCreatedBy(String createdBy) User or Service who created the API Key.
void	setCreatedTime(OffsetDateTime createdTime) The creation time of the API Key.
void	setLastUsedTime(OffsetDateTime lastUsedTime) The time when the API key was last used.

Methods inherited from class com.nutanix.dp1.iam.common.v1.response.ExternalizableAbstractModel

setLinks

Methods inherited from class com.nutanix.dp1.iam.common.v1.config.TenantAwareModel

setTenantId

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.nutanix.json.deserializers.ObjectTypeTypedObject

get$objectType, get$reserved

Field Detail

name

@Pattern(regexp="^[^<>;\'()&+%/\\\\\"`]*$")
 @Size(min=1,
      max=255)
public @Pattern(regexp="^[^<>;\'()&+%/\\\\\"`]*$") @Size(min=1,max=255) String name

Identifier for the API Key in the form of a name.

description

@Pattern(regexp="^[^<>;()&+%/\\\\\"`]*$")
 @Size(max=1000)
public @Pattern(regexp="^[^<>;()&+%/\\\\\"`]*$") @Size(max=1000) String description

Brief description of the API Key.

scope

@Size(min=0,
      max=50)
public @Size(min=0,max=50) List<String> scope

An optional set of audiences for the API key, meant to restrict its access to APIs.

customOptions

public ApiKeyCustomOptions customOptions

status

public ApiKeyStatusType status

expiryTime

public OffsetDateTime expiryTime

The expiry time of the API Key.

Constructor Detail

ApiKey

public ApiKey()

ApiKey

public ApiKey(String tenantId,
              String extId,
              List<ApiLink> links,
              String name,
              String description,
              List<String> scope,
              ApiKeyCustomOptions customOptions,
              String apiKey,
              ApiKeyStatusType status,
              OffsetDateTime createdTime,
              String createdBy,
              OffsetDateTime lastUsedTime,
              OffsetDateTime expiryTime)

Method Detail

setApiKey

public void setApiKey(String apiKey)

The actual API key value, returned only during creation.

setCreatedTime

public void setCreatedTime(OffsetDateTime createdTime)

The creation time of the API Key.

setCreatedBy

public void setCreatedBy(String createdBy)

User or Service who created the API Key.

setLastUsedTime

public void setLastUsedTime(OffsetDateTime lastUsedTime)

The time when the API key was last used.