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

Class UpdateApiKeyOptions

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class UpdateApiKeyOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    The updateApiKey options.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String actionWhenLeaked()
      Gets the actionWhenLeaked.
      java.lang.String description()
      Gets the description.
      java.lang.String id()
      Gets the id.
      java.lang.String ifMatch()
      Gets the ifMatch.
      java.lang.String name()
      Gets the name.
      UpdateApiKeyOptions.Builder newBuilder()
      New builder.
      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

      • id

        public java.lang.String id()
        Gets the id. Unique ID of the API key to be updated.
        Returns:
        the id

      • ifMatch

        public java.lang.String ifMatch()
        Gets the ifMatch. Version of the API key to be updated. Specify the version that you retrieved when reading the API key. This value helps identifying parallel usage of this API. Pass * to indicate to update any version available. This might result in stale updates.
        Returns:
        the ifMatch

      • name

        public java.lang.String name()
        Gets the name. The name of the API key to update. If specified in the request the parameter must not be empty. The name is not checked for uniqueness. Failure to this will result in an Error condition.
        Returns:
        the name

      • description

        public java.lang.String description()
        Gets the description. The description of the API key to update. If specified an empty description will clear the description of the API key. If a non empty value is provided the API key will be updated.
        Returns:
        the description

      • 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