Lithium Tokens API

The Tokens API from Lithium — 1 operation(s) for tokens.

OpenAPI Specification

lithium-tokens-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: agent-states-api-v2 AccountSet Tokens API
  version: '1.1'
servers:
- url: https://{instance}.response.lithium.com/api/v2/agentstate
  variables:
    instance:
      default: instance
security:
- {}
tags:
- name: Tokens
paths:
  /tokens/appId/{appId}:
    put:
      summary: Refresh JWT
      description: Refresh the JWT used to authenticate calls to the Bot v3 API
      operationId: tokensappid-put
      parameters:
      - name: appId
        in: path
        description: The `appId` of the bot defined in the bot registration
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"data\": {\n    \"token\": \"[NEW TOKEN]\",\n    \"expiresAtMillis\": 1560276824632\n  },\n  \"requestId\": \"bcefbedf-45bb-11e9-b37c-1b28a88f8a21\"\n}\n"
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      token:
                        type: string
                        example: '[NEW TOKEN]'
                      expiresAtMillis:
                        type: integer
                        example: 1560276824632
                        default: 0
                  requestId:
                    type: string
                    example: bcefbedf-45bb-11e9-b37c-1b28a88f8a21
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"error\": {\n    \"message\": \"Unauthorized\",\n    \"requestId\": \"d3cf183a-4f30-11e9-bc72-cd9609519b63\"\n  }\n}"
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Unauthorized
                      requestId:
                        type: string
                        example: d3cf183a-4f30-11e9-bc72-cd9609519b63
      deprecated: false
      security: []
      x-readme:
        code-samples:
        - language: curl
          code: "curl -X PUT \\\n  https://api.app.lithium.com/bots/v3/tokens/appId/appId \\\n  -H \"Content-type: application/json; charset=utf-8\" \\\n  -H \"Authorization: Bearer [TOKEN TO BE REFRESHED]\""
        samples-languages:
        - curl
      tags:
      - Tokens
    delete:
      summary: Invalidate JWT
      description: Invalidate the JWT used to authenticate calls to the Bot v3 API
      operationId: tokensappid-delete
      parameters:
      - name: appId
        in: path
        description: The `appId` of the bot as defined in the bot registration
        schema:
          type: string
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      security: []
      x-readme:
        code-samples:
        - language: curl
          code: "curl -X DELETE \\\n  https://api.app.lithium.com/bots/v3/tokens/appId/appID \\\n  -H \"Authorization: Bearer [TOKEN]\"\n"
        samples-languages:
        - curl
      tags:
      - Tokens
x-readme:
  headers: []
  explorer-enabled: false
  proxy-enabled: false
x-readme-fauxas: true