Unity Catalog Temporary Credentials API

openapi: 3.2.0
info:
  title: Unity Catalog Temporary Credentials API
  version: '0.1'
  description: Temporary credentials are used to access storage locations or assets for a limited lifetime.
servers:
- url: http://localhost:8080/api/2.1/unity-catalog
  description: Localhost reference server
tags:
- name: TemporaryCredentials
  description: Temporary credentials are used to access storage locations or assets for a limited lifetime.
paths:
  /temporary-model-version-credentials:
    post:
      operationId: generateTemporaryModelVersionCredentials
      tags:
      - TemporaryCredentials
      summary: Generate temporary model version credentials.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateTemporaryModelVersionCredential'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporaryCredentials'
  /temporary-table-credentials:
    post:
      operationId: generateTemporaryTableCredentials
      tags:
      - TemporaryCredentials
      summary: Generate temporary table credentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateTemporaryTableCredential'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporaryCredentials'
  /temporary-volume-credentials:
    post:
      operationId: generateTemporaryVolumeCredentials
      tags:
      - TemporaryCredentials
      summary: Generate temporary volume credentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateTemporaryVolumeCredential'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporaryCredentials'
  /temporary-path-credentials:
    post:
      operationId: generateTemporaryPathCredentials
      tags:
      - TemporaryCredentials
      summary: Generate temporary path credentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateTemporaryPathCredential'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporaryCredentials'
components:
  schemas:
    GenerateTemporaryVolumeCredential:
      properties:
        volume_id:
          description: "Volume id for which temporary credentials are generated. \nCan be obtained from volumes/{full_name} (get volume info) API.\n"
          type: string
        operation:
          $ref: '#/components/schemas/VolumeOperation'
      type: object
      required:
      - volume_id
      - operation
    GenerateTemporaryPathCredential:
      type: object
      properties:
        url:
          description: The URL of the storage path for which temporary credentials need to be generated.
          type: string
        operation:
          $ref: '#/components/schemas/PathOperation'
      required:
      - url
      - operation
    AzureUserDelegationSAS:
      properties:
        sas_token:
          description: Azure SAS Token
          type: string
      type: object
    PathOperation:
      enum:
      - UNKNOWN_PATH_OPERATION
      - PATH_READ
      - PATH_READ_WRITE
      - PATH_CREATE_TABLE
      type: string
    ModelVersionOperation:
      enum:
      - UNKNOWN_MODEL_VERSION_OPERATION
      - READ_MODEL_VERSION
      - READ_WRITE_MODEL_VERSION
      type: string
    TemporaryCredentials:
      type: object
      properties:
        aws_temp_credentials:
          $ref: '#/components/schemas/AwsCredentials'
        azure_user_delegation_sas:
          $ref: '#/components/schemas/AzureUserDelegationSAS'
        gcp_oauth_token:
          $ref: '#/components/schemas/GcpOauthToken'
        expiration_time:
          description: 'Server time when the credential will expire, in epoch milliseconds.

            The API client is advised to cache the credential given this expiration time.

            '
          type: integer
          format: int64
        url:
          description: The normalized URL of the storage path the temporary credential was generated for.
          type: string
    GenerateTemporaryModelVersionCredential:
      example:
        catalog_name: catalog_name
        schema_name: schema_name
        model_name: model_name
        version: version
        operation: null
      properties:
        catalog_name:
          description: "Catalog name for which temporary credentials are generated. \nCan be obtained from models/{full_name} (get model info) API.\n"
          type: string
        schema_name:
          description: "Schema name for which temporary credentials are generated. \nCan be obtained from models/{full_name} (get model info) API.\n"
          type: string
        model_name:
          description: "Model name for which temporary credentials are generated. \nCan be obtained from models/{full_name} (get model info) API.\n"
          type: string
        version:
          description: 'Model version for which temporary credentials are generated.

            '
          type: integer
          format: int64
        operation:
          $ref: '#/components/schemas/ModelVersionOperation'
      type: object
      required:
      - catalog_name
      - schema_name
      - model_name
      - version
      - operation
    GenerateTemporaryTableCredential:
      example:
        table_id: table_id
        operation: null
      properties:
        table_id:
          description: "Table id for which temporary credentials are generated. \nCan be obtained from tables/{full_name} (get table info) API.\n"
          type: string
        operation:
          $ref: '#/components/schemas/TableOperation'
      type: object
      required:
      - table_id
      - operation
    GcpOauthToken:
      properties:
        oauth_token:
          description: Gcp Token
          type: string
      type: object
    TableOperation:
      enum:
      - UNKNOWN_TABLE_OPERATION
      - READ
      - READ_WRITE
      type: string
    VolumeOperation:
      enum:
      - UNKNOWN_VOLUME_OPERATION
      - READ_VOLUME
      - WRITE_VOLUME
      type: string
    AwsCredentials:
      properties:
        access_key_id:
          description: The access key ID that identifies the temporary credentials.
          type: string
        secret_access_key:
          description: The secret access key that can be used to sign AWS API requests.
          type: string
        session_token:
          description: The token that users must pass to AWS API to use the temporary credentials.
          type: string
      type: object