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

Class ApiKey

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class ApiKey
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    Response body format for API key V1 REST requests.

    • Method Detail

      • getContext

        public ResponseContext getContext()
        Gets the context. Context with key properties for problem determination.
        Returns:
        the context

      • getId

        public java.lang.String getId()
        Gets the id. Unique identifier of this API Key.
        Returns:
        the id

      • getEntityTag

        public java.lang.String getEntityTag()
        Gets the entityTag. Version of the API Key details object. You need to specify this value when updating the API key to avoid stale updates.
        Returns:
        the entityTag

      • getCrn

        public java.lang.String getCrn()
        Gets the crn. Cloud Resource Name of the item. Example Cloud Resource Name: 'crn:v1:bluemix:public:iam-identity:us-south:a/myaccount::apikey:1234-9012-5678'.
        Returns:
        the crn

      • isLocked

        public java.lang.Boolean isLocked()
        Gets the locked. The API key cannot be changed if set to true.
        Returns:
        the locked

      • isDisabled

        public java.lang.Boolean isDisabled()
        Gets the disabled. Defines if API key is disabled, API key cannot be used if 'disabled' is set to true.
        Returns:
        the disabled

      • getCreatedAt

        public java.util.Date getCreatedAt()
        Gets the createdAt. If set contains a date time string of the creation date in ISO format.
        Returns:
        the createdAt

      • getCreatedBy

        public java.lang.String getCreatedBy()
        Gets the createdBy. IAM ID of the user or service which created the API key.
        Returns:
        the createdBy

      • getModifiedAt

        public java.util.Date getModifiedAt()
        Gets the modifiedAt. If set contains a date time string of the last modification date in ISO format.
        Returns:
        the modifiedAt

      • getName

        public java.lang.String getName()
        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

      • isSupportSessions

        public java.lang.Boolean isSupportSessions()
        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

      • getActionWhenLeaked

        public java.lang.String getActionWhenLeaked()
        Gets the actionWhenLeaked. Defines the action to take when API key is leaked, valid values are 'none', 'disable' and 'delete'.
        Returns:
        the actionWhenLeaked

      • getDescription

        public java.lang.String getDescription()
        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

      • getIamId

        public java.lang.String getIamId()
        Gets the iamId. The iam_id that this API key authenticates.
        Returns:
        the iamId

      • getAccountId

        public java.lang.String getAccountId()
        Gets the accountId. ID of the account that this API key authenticates for.
        Returns:
        the accountId

      • getApikey

        public java.lang.String getApikey()
        Gets the apikey. The API key value. This property only contains the API key value for the following cases: create an API key, update a service ID API key that stores the API key value as retrievable, or get a service ID API key that stores the API key value as retrievable. All other operations don't return the API key value, for example all user API key related operations, except for create, don't contain the API key value.
        Returns:
        the apikey

      • getHistory

        public java.util.List<EnityHistoryRecord> getHistory()
        Gets the history. History of the API key.
        Returns:
        the history

      • getActivity

        public Activity getActivity()
        Gets the activity.
        Returns:
        the activity