Auth Server

Create a new auth server

Changed on

Create a new auth server. Each auth server has a unique, randomly generated, public issuer URL.

post/v1/auth-servers

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v1/auth-servers
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

namestring required

The name of the auth server

descriptionstring

The description of the auth server

audiencestring required

The recipients that the tokens are intended for. This becomes the 'aud' claim in an access token

signing_algorithm'RS256' | 'RS384' | 'RS512' | 'PS256' | 'PS384' | 'PS512'

Algorithm used in the key signing process

labelsLabels

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

trusted_originsTrustedOrigin[]

A list or trusted origins to apply the CORS header on for the auth server

Example request

{
  "labels": {
    "env": "test"
  },
  "trusted_origins": [
    "https://example.com"
  ]
}

Response

An auth server

idstring uuid required

The ID of the auth server

namestring required

The name of the auth server

descriptionstring required

The description of the auth server

audiencestring required

The recipients that the tokens are intended for. This becomes the 'aud' claim in an access token

signing_algorithm'RS256' | 'RS384' | 'RS512' | 'PS256' | 'PS384' | 'PS512' required

Algorithm used in the key signing process

issuerstring required

The complete URL for the custom authorization server. This becomes the 'iss' claim in an access token.

metadata_uristring uri required

The URI of the metadata document for the auth server

jwks_uristring uri

The URI of the JWKS endpoint for the auth server

labelsLabels required

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

trusted_originsTrustedOrigin[]

A list or trusted origins to apply the CORS header on for the auth server

Example response

{
  "labels": {
    "env": "test"
  },
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z",
  "trusted_origins": [
    "https://example.com"
  ]
}

Changes

  • f530bf400198Revision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 409.00 enum value to the response property for the response status

  • 4a02153f2e60Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the new optional request property

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status