---
title: "List all auth server claims"
url: "https://nov18-dev.movespot.fyi/apis/konnect-sliver-1/versions/3f8cda05-1eea-4a0c-b583-c24374bebb67/operations/listAuthServerClaims"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-sliver-1/versions/3f8cda05-1eea-4a0c-b583-c24374bebb67.md

# List all auth server claims

`GET` `/auth-servers/{authServerId}/claims`

Operation ID: `listAuthServerClaims`

List all the claims for a given auth server.

## Path parameters

- `authServerId` (string, uuid, required) - The auth server 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 claims. Supported sort attributes are: - created_at - updated_at - name
- `filter` (object, optional) - Filter claims returned in the response.

## Responses

- `200` - List of claims
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Sliver
  version: 1.0.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
paths:
  /auth-servers/{authServerId}/claims:
    parameters:
      - $ref: "#/components/parameters/authServerId"
    get:
      operationId: listAuthServerClaims
      summary: List all auth server claims
      description: List all the claims for a given auth server.
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
        - name: sort
          in: query
          description: |
            Sorts a collection of claims. Supported sort attributes are:
            - created_at
            - updated_at
            - name
          required: false
          schema:
            $ref: "#/components/schemas/SortQuery"
        - name: filter
          in: query
          description: Filter claims returned in the response.
          required: false
          schema:
            type: object
            properties:
              name:
                $ref: "#/components/schemas/LegacyStringFieldFilter"
              id:
                $ref: "#/components/schemas/StringFieldEqualsFilter"
          style: deepObject
      responses:
        "200":
          $ref: "#/components/responses/ClaimList"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Auth Server Claims
security:
  - systemAccountAccessToken: []
  - personalAccessToken: []
  - konnectAccessToken: []
components:
  parameters:
    authServerId:
      schema:
        type: string
        format: uuid
        example: d32d905a-ed33-46a3-a093-d8f536af9a8a
      name: authServerId
      in: path
      required: true
      description: The auth server 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
    LegacyStringFieldFilter:
      description: "Filter using **one** of the following operators: `eq`, `contains`"
      type: object
      properties:
        eq:
          description: The field exactly matches the provided value.
          type: string
          example: ?filter[field_name_here][eq]=foo
        contains:
          description: The field contains the provided value.
          type: string
          example: ?filter[field_name_here][contains]=foo
      additionalProperties: false
      x-examples:
        example-1:
          contains: some-value
        example-2:
          eq: some-value
    StringFieldEqualsFilter:
      description: Filters on the given string field value by exact match.
      properties:
        eq:
          type: string
      title: StringFieldEqualsFilter
      x-examples:
        example-1: equals-some-value
        example-2:
          eq: some-value
    ClaimList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Claim"
        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
    Claim:
      type: object
      properties:
        id:
          description: The ID of the claim
          type: string
          format: uuid
        name:
          $ref: "#/components/schemas/ClaimName"
        value:
          $ref: "#/components/schemas/ClaimValue"
        include_in_token:
          $ref: "#/components/schemas/ClaimIncludeInToken"
        include_in_all_scopes:
          $ref: "#/components/schemas/ClaimIncludeInAllScopes"
        include_in_scopes:
          $ref: "#/components/schemas/ClaimIncludeInScopes"
        enabled:
          $ref: "#/components/schemas/ClaimEnabled"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      required:
        - id
        - name
        - value
        - include_in_token
        - include_in_all_scopes
        - include_in_scopes
        - 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
    ClaimName:
      description: The name of the claim
      type: string
      minLength: 1
    ClaimValue:
      description: Specifies the value of the claim. It may contain a static value or
        a dynamic (templated) value. Static values which are valid JSON will
        result in a JSON object in the token claims.
      type: string
      minLength: 1
    ClaimIncludeInToken:
      description: Specifies whether to include claim in the token. If the value is
        set to 'false' for a claim, the client instead uses the access token to
        get claims from the '/userinfo' endpoint.
      type: boolean
      default: false
    ClaimIncludeInAllScopes:
      description: Specifies whether to include the claim in all scopes. If the value
        is set to 'false' for a claim, the claim is only included in the scopes
        that explicitly list it.
      type: boolean
      default: false
    ClaimIncludeInScopes:
      description: Specifies the scopes IDs in which the claim is included
      type: array
      items:
        type: string
        format: uuid
      nullable: false
    ClaimEnabled:
      description: Specifies whether the claim is enabled. If the claim is not
        enabled, it will not be included in the token or the '/userinfo'
        endpoint.
      type: boolean
      default: true
    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:
    ClaimList:
      description: List of claims
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ClaimList"
          examples:
            ClaimList:
              $ref: "#/components/examples/ClaimList"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  examples:
    ClaimList:
      value:
        data:
          - id: 07d05309-45cc-4b37-92fb-1524846deec3
            name: Claim 1
            value: Claim 1 Value
            include_in_token: true
            include_in_all_scopes: false
            include_in_scopes:
              - c5e12516-182c-4928-ae04-05374b3b1cca
              - b5525b78-f3a0-4bd6-befc-7696be58717e
            enabled: true
            created_at: 2023-03-20T09:29:14.52Z
            updated_at: 2023-03-21T09:29:14.52Z
          - id: 5e051473-3b98-45c9-aa99-75b18c158bbf
            name: Claim 2
            value: Claim 2 Value
            include_in_token: true
            include_in_all_scopes: false
            include_in_scopes:
              - c5e12516-182c-4928-ae04-05374b3b1cca
              - b5525b78-f3a0-4bd6-befc-7696be58717e
            enabled: true
            created_at: 2023-03-20T09:29:14.52Z
            updated_at: 2023-03-21T09: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.
```
