---
title: "ClaimList"
url: "https://nov18-dev.movespot.fyi/apis/konnect-sliver-1/versions/3f8cda05-1eea-4a0c-b583-c24374bebb67/schemas/ClaimList"
---

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

# ClaimList

## 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
components:
  schemas:
    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
    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
    ClaimList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/Claim"
        meta:
          $ref: "#/components/schemas/PaginatedMeta"
      required:
        - data
        - meta
```
