KORE Token API

The KORE Token API is the OAuth 2.0 authorization endpoint for the whole platform. A single POST to /v1/auth/token exchanges Client Credentials for a bearer access token per RFC 6749 section 4.4, with a configurable token expiry set on the API Client.

OpenAPI Specification

kore-wireless-token.yml Raw ↑
openapi: 3.0.1
info:
  title: v1-token
  version: '1.0'
servers:
- url: https://api.korewireless.com/api-services
x-hideTryItPanel: true
paths:
  /v1/auth/token:
    post:
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                grant_type:
                  type: string
                client_id:
                  type: string
                client_secret:
                  type: string
      responses:
        '200':
          description: 200 response
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Credentials:
              schema:
                type: string
            Access-Control-Allow-Headers:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/200GetToken'
        '400':
          description: 400 response
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Credentials:
              schema:
                type: string
            Access-Control-Allow-Headers:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 401 response
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Credentials:
              schema:
                type: string
            Access-Control-Allow-Headers:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/401Error'
        '500':
          description: 500 response
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Credentials:
              schema:
                type: string
            Access-Control-Allow-Headers:
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    options:
      responses:
        '200':
          description: 200 response
          headers:
            Access-Control-Allow-Origin:
              schema:
                type: string
            Access-Control-Allow-Methods:
              schema:
                type: string
            Access-Control-Allow-Credentials:
              schema:
                type: string
            Access-Control-Allow-Headers:
              schema:
                type: string
          content: {}
components:
  schemas:
    Error:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
    Empty:
      type: object
    200GetToken:
      type: object
      properties:
        access_token:
          type: string
          example: eyJhbGciOiJSUzI1NiIs
          description: Access token.
        expires_in:
          type: number
          example: 3600
          description: Expiration time of the access token in seconds
        token_type:
          type: string
          example: Bearer
          description: Type of the access token
        scope:
          type: string
          example: email
          description: Scope of the token
    401Error:
      type: object
      properties:
        error:
          type: string
          example: invalid_client
          description: Error message.
        error_description:
          type: string
          example: Invalid client or Invalid client credentials
          description: Details of the error