---
title: "List client secrets"
url: "https://nov18-dev.movespot.fyi/apis/konnect-sliver-dcr-dev-0/versions/f13250cb-053c-4f2d-b0e4-ed0e59c34cec/operations/listClientSecrets"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-sliver-dcr-dev-0/versions/f13250cb-053c-4f2d-b0e4-ed0e59c34cec.md

# List client secrets

`GET` `/clients/{clientId}/secrets`

Operation ID: `listClientSecrets`

List all secrets for a given client.

## Path parameters

- `clientId` (string, required) - The OAuth 2.0 client ID

## Query parameters

- `page[size]` (integer, optional) - The maximum number of items to include per page. The last page of a collection may include fewer items.
- `page[number]` (integer, optional) - Determines which page of the entities to retrieve.
- `sort` (string, optional) - Sorts a collection of secrets. Supported sort attributes are: - created_at - updated_at
- `filter` (object, optional) - Filter secrets returned in the response.

## Responses

- `200` - List of client Secrets
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Sliver DCR
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com/oauth2/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/oauth2/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/oauth2/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/oauth2/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/oauth2/v1
    description: India Production region
  - url: https://sg.api.konghq.com/oauth2/v1
    description: Singapore Production region
paths:
  /clients/{clientId}/secrets:
    parameters:
      - $ref: "#/components/parameters/clientId"
    get:
      operationId: listClientSecrets
      summary: List client secrets
      description: List all secrets for a given client.
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
        - name: sort
          in: query
          description: |
            Sorts a collection of secrets. Supported sort attributes are:
            - created_at
            - updated_at
          required: false
          schema:
            $ref: "#/components/schemas/SortQuery"
        - name: filter
          in: query
          description: Filter secrets returned in the response.
          required: false
          schema:
            type: object
            properties:
              id:
                $ref: "#/components/schemas/StringFieldEqualsFilter"
              enabled:
                $ref: "#/components/schemas/BooleanFieldFilter"
          style: deepObject
      responses:
        "200":
          $ref: "#/components/responses/ClientSecretList"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - dcrmanagement
security:
  - systemAccountAccessToken: []
  - personalAccessToken: []
  - konnectAccessToken: []
components:
  parameters:
    clientId:
      schema:
        $ref: "#/components/schemas/ClientId"
      name: clientId
      in: path
      required: true
      description: The OAuth 2.0 client ID
    PageSize:
      name: page[size]
      description: The maximum number of items to include per page. The last page of a
        collection may include fewer items.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 10
    PageNumber:
      name: page[number]
      description: Determines which page of the entities to retrieve.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 1
  schemas:
    SortQuery:
      description: >
        The `asc` suffix is optional as the default sort order is ascending.

        The `desc` suffix is used to specify a descending order.

        Multiple sort attributes may be provided via a comma separated list.

        JSONPath notation may be used to specify a sub-attribute (eg: 'foo.bar
        desc').
      type: string
      example: created_at desc
      title: SortQuery
    StringFieldEqualsFilter:
      description: Filters on the given string field value by exact match.
      oneOf:
        - type: string
        - type: object
          title: StringFieldEqualsComparison
          additionalProperties: false
          properties:
            eq:
              type: string
          required:
            - eq
      title: StringFieldEqualsFilter
      x-examples:
        example-1: equals-some-value
        example-2:
          eq: some-value
    BooleanFieldFilter:
      description: Filter by a boolean value (true/false).
      type: boolean
      title: BooleanFieldFilter
      x-examples:
        example-1: true
    ClientId:
      description: The OAuth 2.0 client ID
      type: string
      example: kYa9iQFU5xPDSIUH9z1z
      maxLength: 36
      minLength: 1
      pattern: "[-_\\w]+"
      readOnly: true
    ClientSecretList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/ClientSecretItem"
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
      required:
        - data
        - meta
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    ClientSecretItem:
      description: The client secret. The secret value is only returned when creating
        a new secret item.
      type: object
      properties:
        id:
          description: The ID of the client secret
          type: string
          format: uuid
        enabled:
          $ref: "#/components/schemas/SecretEnabled"
        secret:
          $ref: "#/components/schemas/ClientSecret"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      required:
        - id
        - enabled
        - created_at
        - updated_at
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    SecretEnabled:
      description: Specifies whether the secret is enabled. If the secret is not
        enabled, it will not be usable during authentication phase.
      type: boolean
      default: true
    ClientSecret:
      description: The OAuth 2.0 client secret
      type: string
      example: YAzsyUlNZ5gNGeKS9H3VAdxVPzhPo4ae
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    PageMeta:
      description: Contains pagination query parameters and the total number of
        objects returned.
      type: object
      properties:
        number:
          type: number
          example: 1
        size:
          type: number
          example: 10
        total:
          type: number
          example: 100
      required:
        - number
        - size
        - total
  responses:
    ClientSecretList:
      description: List of client Secrets
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ClientSecretList"
          examples:
            ClientSecretList:
              $ref: "#/components/examples/ClientSecretList"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  examples:
    ClientSecretList:
      value:
        data:
          - id: f44567da-a0b1-4eef-86c9-b27ab2e22048
            enabled: true
            created_at: 2023-03-20T09:29:14.52Z
            updated_at: 2023-03-21T09:29:14.52Z
          - id: 5e051473-3b98-45c9-aa99-75b18c158bbf
            enabled: false
            created_at: 2023-03-19T09:29:14.52Z
            updated_at: 2023-03-20T09:29:14.52Z
        meta:
          page:
            number: 1
            size: 2
            total: 2
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
```
