Package com.ibm.cloud.platform_services.iam_identity.v1.model

Class CreateApiKeyOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.platform_services.iam_identity.v1.model.CreateApiKeyOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class CreateApiKeyOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The createApiKey options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateApiKeyOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
java.lang.String	accountId()	Gets the accountId.
java.lang.String	actionWhenLeaked()	Gets the actionWhenLeaked.
java.lang.String	apikey()	Gets the apikey.
java.lang.String	description()	Gets the description.
java.lang.String	entityDisable()	Gets the entityDisable.
java.lang.String	entityLock()	Gets the entityLock.
java.lang.String	iamId()	Gets the iamId.
java.lang.String	name()	Gets the name.
CreateApiKeyOptions.Builder	newBuilder()	New builder.
java.lang.Boolean	storeValue()	Gets the storeValue.
java.lang.Boolean	supportSessions()	Gets the supportSessions.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public CreateApiKeyOptions.Builder newBuilder()

New builder.

Returns:

a CreateApiKeyOptions builder

name

public java.lang.String name()

Gets the name. Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key.

Returns:

the name

iamId

public java.lang.String iamId()

Gets the iamId. The iam_id that this API key authenticates.

Returns:

the iamId

description

public java.lang.String description()

Gets the description. The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key.

Returns:

the description

accountId

public java.lang.String accountId()

Gets the accountId. The account ID of the API key.

Returns:

the accountId

apikey

public java.lang.String apikey()

Gets the apikey. You can optionally passthrough the API key value for this API key. If passed, a minimum length validation of 32 characters for that apiKey value is done, i.e. the value can contain any characters and can even be non-URL safe, but the minimum length requirement must be met. If omitted, the API key management will create an URL safe opaque API key value. The value of the API key is checked for uniqueness. Ensure enough variations when passing in this value.

Returns:

the apikey

storeValue

public java.lang.Boolean storeValue()

Gets the storeValue. Send true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify `false` or omit the value. We don't allow storing of API keys for users.

Returns:

the storeValue

supportSessions

public java.lang.Boolean supportSessions()

Gets the supportSessions. Defines whether you can manage CLI login sessions for the API key. When `true`, sessions are created and can be reviewed or revoked. When `false`, no sessions are tracked. To block access, delete or rotate the API key. Available only for user API keys.

Returns:

the supportSessions

actionWhenLeaked

public java.lang.String actionWhenLeaked()

Gets the actionWhenLeaked. Defines the action to take when API key is leaked, valid values are 'none', 'disable' and 'delete'.

Returns:

the actionWhenLeaked

entityLock

public java.lang.String entityLock()

Gets the entityLock. Indicates if the API key is locked for further write operations. False by default.

Returns:

the entityLock

entityDisable

public java.lang.String entityDisable()

Gets the entityDisable. Indicates if the API key is disabled. False by default.

Returns:

the entityDisable