---
title: "Create a new auth server claim"
url: "https://nov18-dev.movespot.fyi/apis/konnect-sliver-1/versions/3f8cda05-1eea-4a0c-b583-c24374bebb67/operations/createAuthServerClaim"
---

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

# Create a new auth server claim

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

Operation ID: `createAuthServerClaim`

Create a new claim for a given auth server. The `name` attribute will appear in the JWT access token as a claim with the given case-sensitive name. The `value` attribute will be used to populate the claim value in the JWT access token. The value can be templated, which allows you to use variables like `${ uuidv4 }` to generate dynamic values. Claim values are hydrated based on their types, which may include JSON.

## Path parameters

- `authServerId` (string, uuid, required) - The auth server ID

## Request body (required)

Content types: `application/json`

## Responses

- `201` - A claim
- `400` - Bad Request
- `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"
    post:
      operationId: createAuthServerClaim
      summary: Create a new auth server claim
      description: Create a new claim for a given auth server. The `name` attribute
        will appear in the JWT access token as a claim with the given
        case-sensitive name. The `value` attribute will be used to populate the
        claim value in the JWT access token. The value can be templated, which
        allows you to use variables like `${ uuidv4 }` to generate dynamic
        values. Claim values are hydrated based on their types, which may
        include JSON.
      requestBody:
        $ref: "#/components/requestBodies/CreateClaim"
      responses:
        "201":
          $ref: "#/components/responses/Claim"
        "400":
          $ref: "#/components/responses/BadRequest"
        "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
  requestBodies:
    CreateClaim:
      description: Claim to be created
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              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"
            required:
              - name
              - value
          examples:
            Claim:
              $ref: "#/components/examples/CreateClaim"
  responses:
    Claim:
      description: A claim
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Claim"
          examples:
            Claim:
              $ref: "#/components/examples/Claim"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    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
    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
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    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
    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
    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
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    CreateClaim:
      value:
        name: Claim
        value: Claim 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
    Claim:
      value:
        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
    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.
```
