Arcadia Authentication API

openapi: 3.2.0
info:
  description: Plug API
  title: Plug Authentication API
  version: 2.0.0
servers:
- url: https://api.arcadia.com
security:
- OAuth2: []
tags:
- name: Authentication
paths:
  /oauth2/token:
    post:
      operationId: create-access-token
      security: []
      tags:
      - Authentication
      summary: Create an Access Token
      description: 'Use API credentials from the Dashboard to create an Access Token that has permission to use all Arcadia API endpoints.

        API access tokens are valid for one hour.'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - client_id
              - client_secret
              - grant_type
              properties:
                client_id:
                  type: string
                  description: The client ID for the token request. This can be found in the Dashboard, under the API Keys page [here](https://dashboard.arcadia.com/configuration/api-keys).
                client_secret:
                  type: string
                  description: The client secret for the token request. This can be found in the Dashboard, on the API Keys page [here](https://dashboard.arcadia.com/configuration/api-keys).
                grant_type:
                  type: string
                  description: The grant type for the token request. The only available option currently is “client_credentials”.
                  enum:
                  - client_credentials
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TokenErrorResponse'
components:
  schemas:
    TokenErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: A short description of the error that occurred.
        error_description:
          type: string
          description: A more descriptive, human-readable explanation of the error.
      example:
        error: invalid_client
        error_description: Invalid client or Invalid client credentials
    TokenResponse:
      type: object
      properties:
        access_token:
          type: string
          description: The access token that can be used to access the Arcadia API. This token should be included in the “Authorization” header in the format “Bearer ACCESS_TOKEN".
        expires_in:
          type: integer
          description: The number of seconds until the access token expires. Defaults to 3600 seconds (one hour).
        refresh_expires_in:
          type: integer
          description: If one is provided, indicates the number of seconds until the refresh token expires. Currently, the refresh token grant type is not supported, so this value will always be 0.
        token_type:
          type: string
          description: Specifies the type of access token, per the OAuth2 spec. Always returns a value of “Bearer”, indicating the access token should be added to requests in the “Authorization” header in the format “Bearer ACCESS_TOKEN”.
        not-before-policy:
          type: integer
          description: A timestamp that specifies the earliest time the access token is valid. A value of 0 means there is no restriction on when the token become valid, and can be used immediately.
        scope:
          type: string
          description: The scope of the access token. This will always currently be “profile email”.
      required:
      - access_token
      - expires_in
      - refresh_expires_in
      - token_type
      - not-before-policy
      - scope
      example:
        access_token: foobar
        expires_in: 3600
        refresh_expires_in: 0
        token_type: Bearer
        not-before-policy: 0
        scope: profile email
  securitySchemes:
    OAuth2:
      type: oauth2
      description: This API uses OAuth2 with the client credentials flow using the ['Create an Access Token'](ref:create-access-token) endpoint. API keys can be retrieved from the [Dashboard](https://dashboard.arcadia.com/).
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: /oauth2/token
x-provenance:
  method: harvested
  publisher: Arcadia
  source: https://docs.arcadia.com/openapi/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)