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

Class ListApiKeysOptions

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String accountId()
      Gets the accountId.
      java.lang.String filter()
      Gets the filter.
      java.lang.String groupId()
      Gets the groupId.
      java.lang.String iamId()
      Gets the iamId.
      java.lang.Boolean includeHistory()
      Gets the includeHistory.
      ListApiKeysOptions.Builder newBuilder()
      New builder.
      java.lang.String order()
      Gets the order.
      java.lang.Long pagesize()
      Gets the pagesize.
      java.lang.String pagetoken()
      Gets the pagetoken.
      java.lang.String scope()
      Gets the scope.
      java.lang.String sort()
      Gets the sort.
      java.lang.String type()
      Gets the type.

      • 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

      • accountId

        public java.lang.String accountId()
        Gets the accountId. Account ID of the API keys to query. If a service IAM ID is specified in iam_id then account_id must match the account of the IAM ID. If a user IAM ID is specified in iam_id then then account_id must match the account of the Authorization token.
        Returns:
        the accountId

      • iamId

        public java.lang.String iamId()
        Gets the iamId. IAM ID of the API keys to be queried. The IAM ID may be that of a user or a service. For a user IAM ID iam_id must match the Authorization token.
        Returns:
        the iamId

      • pagesize

        public java.lang.Long pagesize()
        Gets the pagesize. Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
        Returns:
        the pagesize

      • pagetoken

        public java.lang.String pagetoken()
        Gets the pagetoken. Optional Prev or Next page token returned from a previous query execution. Default is start with first page.
        Returns:
        the pagetoken

      • scope

        public java.lang.String scope()
        Gets the scope. Optional parameter to define the scope of the queried API keys. Can be 'entity' (default) or 'account'.
        Returns:
        the scope

      • type

        public java.lang.String type()
        Gets the type. Optional parameter to filter the type of the queried API keys. Can be 'user' or 'serviceid'.
        Returns:
        the type

      • sort

        public java.lang.String sort()
        Gets the sort. Optional sort property, valid values are name, description, created_at and created_by. If specified, the items are sorted by the value of this property.
        Returns:
        the sort

      • order

        public java.lang.String order()
        Gets the order. Optional sort order, valid values are asc and desc. Default: asc.
        Returns:
        the order

      • includeHistory

        public java.lang.Boolean includeHistory()
        Gets the includeHistory. Defines if the entity history is included in the response.
        Returns:
        the includeHistory

      • filter

        public java.lang.String filter()
        Gets the filter. An optional filter query parameter used to refine the results of the search operation. For more information see [Filtering list results](#filter-list-results) section.
        Returns:
        the filter

      • groupId

        public java.lang.String groupId()
        Gets the groupId. Optional group ID of the service ID(s) to which the searched API keys are bound. If this parameter is not provided the default group is applied on service ID API keys. For user API keys this parameter is ignored as they always belong to the default group.
        Returns:
        the groupId