---
title: "Get an auth server"
url: "https://nov18-dev.movespot.fyi/apis/konnect-sliver-dev-1/versions/12e1e75c-efaa-4e15-bec3-ed9d424d70c5/operations/getAuthServer"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-sliver-dev-1/versions/12e1e75c-efaa-4e15-bec3-ed9d424d70c5.md

# Get an auth server

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

Operation ID: `getAuthServer`

Get an auth server.

## Path parameters

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

## Responses

- `200` - An auth server
- `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}:
    parameters:
      - $ref: "#/components/parameters/authServerId"
    get:
      operationId: getAuthServer
      summary: Get an auth server
      description: Get an auth server.
      responses:
        "200":
          $ref: "#/components/responses/AuthServer"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Auth Server
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
  responses:
    AuthServer:
      description: An auth server
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AuthServer"
          examples:
            AuthServer:
              $ref: "#/components/examples/AuthServer"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    AuthServer:
      type: object
      properties:
        id:
          description: The ID of the auth server
          type: string
          format: uuid
        name:
          $ref: "#/components/schemas/AuthServerName"
        description:
          $ref: "#/components/schemas/AuthServerDescription"
        audience:
          $ref: "#/components/schemas/Audience"
        signing_algorithm:
          $ref: "#/components/schemas/Algorithm"
        issuer:
          $ref: "#/components/schemas/Issuer"
        metadata_uri:
          description: The URI of the metadata document for the auth server
          type: string
          format: uri
        labels:
          $ref: "#/components/schemas/Labels"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        trusted_origins:
          $ref: "#/components/schemas/TrustedOrigins"
        dcr_default_access_token_duration:
          $ref: "#/components/schemas/DcrDefaultAccessTokenDuration"
      required:
        - id
        - name
        - description
        - audience
        - signing_algorithm
        - issuer
        - metadata_uri
        - labels
        - created_at
        - updated_at
    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
    AuthServerName:
      description: The name of the auth server
      type: string
      minLength: 1
    AuthServerDescription:
      description: The description of the auth server
      type: string
    Audience:
      description: The recipients that the tokens are intended for. This becomes the
        'aud' claim in an access token
      type: string
      minLength: 1
    Algorithm:
      description: Algorithm used in the key signing process
      type: string
      default: RS256
      enum:
        - RS256
        - RS384
        - RS512
        - PS256
        - PS384
        - PS512
    Issuer:
      description: The complete URL for the custom authorization server. This becomes
        the 'iss' claim in an access token.
      type: string
    Labels:
      description: >
        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 "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    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
    TrustedOrigins:
      description: A list or trusted origins to apply the CORS header on for the auth server
      type: array
      items:
        $ref: "#/components/schemas/TrustedOrigin"
      maxLength: 16
      uniqueItems: true
    DcrDefaultAccessTokenDuration:
      description: The default access token duration, in seconds, applied to DCR
        clients registered against this auth server
      type: integer
      default: 300
      maximum: 2592000
      minimum: 60
    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
    TrustedOrigin:
      description: A trusted origin for the auth server
      type: string
      format: uri
      example: https://example.com
  examples:
    AuthServer:
      value:
        id: f44567da-a0b1-4eef-86c9-b27ab2e22048
        name: Auth Server 1
        description: Auth Server 1 Description
        audience: api://default
        signing_algorithm: RS256
        issuer: https://auth-server-1.com
        metadata_uri: https://auth-server-1.com/auth/.well-known/openid-configuration
        labels:
          env: production
        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.
```
