Cesium OAuth API

openapi: 3.2.0
info:
  title: Cesium ion OAuth API
  version: v1
  description: '# Overview


    The Cesium ion REST API allows you to leverage ion''s powerful tiling and streaming capabilities from your own applications and workflows.'
servers:
- url: https://api.cesium.com
  description: Cesium ion API Server
security:
- OAuth2: []
tags:
- name: OAuth
  description: The Oauth API provides a mechanism to allow third-party applications to access a user's ion account data through the Oauth 2.0 authorization framework.
paths:
  /oauth/token:
    post:
      operationId: postOauthToken
      summary: Obtain an access token
      description: 'Obtain an access token using the OAuth 2.0 authorization framework. This endpoint supports the `authorization_code`, and `refresh_token` grant types.


        For more information on how to use this endpoint, see our OAuth 2.0 tutorial.'
      tags:
      - OAuth
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                grant_type:
                  type: string
                  description: The OAuth 2.0 grant type being used. Authorization code and refresh token are the supported grants.
                  enum:
                  - authorization_code
                  - refresh_token
                client_id:
                  type: number
                  description: The client identifier issued to the client during the registration process.
                code:
                  type: string
                  description: The authorization code received from the user login process. Required when using the `authorization_code` grant type.
                redirect_uri:
                  type: string
                  description: The redirect URI registered with the OAuth Client.
                refresh_token:
                  type: string
                  description: The refresh token previously issued by the authorization server. Required when using the `refresh_token` grant type.
                code_verifier:
                  type: string
                  description: The code verifier used in the PKCE flow. Required when using the `authorization_code` grant type.
              required:
              - grant_type
              - client_id
              - redirect_uri
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  access_token:
                    type: string
                    description: The access token issued by the authorization server.
                  expires_in:
                    type: number
                    description: Number of seconds the access token is valid. Tokens are currently issued for 30 days.
                  refresh_token_expires_in:
                    type: number
                    description: Number of seconds the refresh token is valid. Refresh tokens are currently valid for 90 days.
                  token_type:
                    type: string
                    description: The type of token issued.  This will always be `Bearer`.
                  refresh_token:
                    type: string
                    description: The refresh token which can be used to obtain new access tokens using the `refresh_token` grant type.
              examples:
                Authorization code grant response:
                  value:
                    access_token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
                    token_type: Bearer
                    expires_in: 86400
                    refresh_token: d1e8f4e5c6b7a8d9e0f1a2b3c4d5e6f7...
                    refresh_token_expires_in: 259200
        401:
          description: Invalid Credentials
        409:
          description: Invalid Request
components:
  securitySchemes:
    OAuth2:
      description: 'All Cesium ion endpoints require authentication in the form of an access token provided in the `Authorization` header of the request. ion uses the OAuth 2.0 `Bearer <your_access_token>` format.

        '
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://cesium.com/ion/oauth/
          tokenUrl: https://api.cesium.com/oauth/tokens
          scopes:
            assets:list: List the metadata for all assets available to the account.
            assets:limited-list: List the metadata for selected assets available to the account.
            assets:read: Read metadata and access the tiled data for individual assets available to the account.
            assets:write: Create, modify, and delete assets in the account.
            labels:read: List labels in the account.
            labels:write: Create, modify, and delete labels in the account.
            geocode: Enables the CesiumJS geocoder. Note geocoding via the REST API is not yet supported.
            profile:read: Read your username, email address, avatar, and storage quota.
            archives:read: List and download asset archives.
            archives:write: Create and delete asset archives.
            exports:read: List asset exports.
            exports:write: Export assets.
            tokens:read: Read token metadata and list all tokens for the account.
    AccessToken:
      description: 'A Cesium ion access token provided as a Bearer token in the `Authorization` header. An access token can be

        used anywhere an OAuth 2.0 token can, with the same scopes, and additionally supports the `tokens:write`

        scope, which is not available via OAuth 2.0 since granting a third-party OAuth client the ability to

        create, modify, and delete a user''s other tokens is out of scope for delegated access.

        '
      type: http
      scheme: bearer