Schematic

Schematic accesstokens API

The accesstokens API from Schematic — 1 operation(s) for accesstokens.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.schematichq.com/
📖
APIReference
https://docs.schematichq.com/api-reference
📖
Authentication
https://docs.schematichq.com/api-reference/authentication.mdx
📖
GettingStarted
https://docs.schematichq.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/schematic/refs/heads/main/openapi/schematic-accesstokens-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/SchematicHQ

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/schematic/refs/heads/main/json-schema/schematic-company-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/schematic/refs/heads/main/json-schema/schematic-feature-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/schematic/refs/heads/main/json-schema/schematic-plan-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/schematic/refs/heads/main/json-structure/schematic-api-structure.json

Other Resources

🔗
SDK Python
https://github.com/SchematicHQ/schematic-python
🔗
SDK Node
https://github.com/SchematicHQ/schematic-node
🔗
SDK Go
https://github.com/SchematicHQ/schematic-go
🔗
SDK Ruby
https://github.com/SchematicHQ/schematic-ruby
🔗
SDK Java
https://github.com/SchematicHQ/schematic-java
🔗
SDK PHP
https://github.com/SchematicHQ/schematic-php
🔗
SDK C#
https://github.com/SchematicHQ/schematic-csharp
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/schematic/refs/heads/main/rules/schematic-rules.yml
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/schematic/refs/heads/main/json-ld/schematic-context.jsonld
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/schematic/refs/heads/main/apis.yml

OpenAPI Specification

schematic-accesstokens-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  title: Schematic accesstokens API
  version: '0.1'
  description: Schematic API
  x-rules-engine-schema-version: v97288f60
servers:
- url: https://api.schematichq.com
security:
- ApiKeyAuth: []
tags:
- name: accesstokens
paths:
  /temporary-access-tokens:
    post:
      operationId: issueTemporaryAccessToken
      summary: Issue temporary access token
      tags:
      - accesstokens
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IssueTemporaryAccessTokenRequestBody'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/IssueTemporaryAccessTokenResponseData'
                  params:
                    type: object
                    description: Input parameters
                    title: IssueTemporaryAccessTokenParams
                required:
                - data
                - params
                title: IssueTemporaryAccessTokenResponse
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  responses:
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    ServerError:
      description: Server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    IssueTemporaryAccessTokenResponseData:
      type: object
      properties:
        api_key_id:
          type: string
        created_at:
          type: string
          format: date-time
        environment_id:
          type: string
        expired_at:
          type: string
          format: date-time
        id:
          type: string
        resource_type:
          $ref: '#/components/schemas/TemporaryAccessTokenResourceType'
        token:
          type: string
        updated_at:
          type: string
          format: date-time
      required:
      - id
      - environment_id
      - resource_type
      - api_key_id
      - expired_at
      - created_at
      - updated_at
      - token
      title: IssueTemporaryAccessTokenResponseData
    IssueTemporaryAccessTokenRequestBody:
      type: object
      properties:
        lookup:
          additionalProperties:
            type: string
          type: object
        resource_type:
          $ref: '#/components/schemas/TemporaryAccessTokenResourceType'
      required:
      - resource_type
      - lookup
      title: IssueTemporaryAccessTokenRequestBody
    ApiError:
      type: object
      properties:
        error:
          type: string
          description: Error message
      required:
      - error
    TemporaryAccessTokenResourceType:
      type: string
      enum:
      - company
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Schematic-Api-Key