Cesium User API

openapi: 3.2.0
info:
  title: Cesium ion User 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: User
  description: Routes related to the currently authenticated account.
paths:
  /v1/me:
    get:
      operationId: getMe
      summary: Get profile information
      description: 'Retrieves profile information for the access token currently being used to make API calls.


        This route works with any valid token, but additional information is returned if the token use the `profile:read` scope.'
      tags:
      - User
      security:
      - OAuth2:
        - profile:read
      - AccessToken:
        - profile:read
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                title: Profile Information
                type: object
                properties:
                  id:
                    type: number
                    description: The unique identifier for this account.
                  scopes:
                    type: array
                    description: The array of scopes available with this token.
                  username:
                    type: string
                    description: The account username.
                  email:
                    type: string
                    description: The primary email address associated with this account.
                  emailVerified:
                    type: boolean
                    description: If true, the email address has been verified for this account.
                  avatar:
                    type: string
                    description: A url to the profile image associated with this account.
                  storage:
                    type: object
                    description: Information about the amount of storage available in the user's account.
                    properties:
                      used:
                        type: number
                        description: The number of bytes currently being used by this account.
                      available:
                        type: number
                        description: The number of bytes available for additional asset uploads to this account.
                      total:
                        type: number
                        description: The total number of bytes currently allowed to be used by this account.
                  beta:
                    type: boolean
                    description: if this user's account is able to access early access beta features
                required:
                - id
                - scopes
              examples:
                Response with profile:read scope:
                  value:
                    id: 212352
                    scopes:
                    - assets:read
                    - profile:read
                    username: mamato
                    email: matt@cesium.com
                    emailVerified: true
                    avatar: https://www.gravatar.com/avatar/4f14cc6c584f41d89ef1d34c8986ebfb.jpg?d=mp
                    storage:
                      used: 214526475
                      available: 53472564725
                      total: 53687091200
                    beta: false
                Response without profile:read scope:
                  value:
                    id: 212352
                    scopes:
                    - assets:read
                    - assets:write
                    - assets:list
        401:
          $ref: '#/components/responses/401'
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