Quadrillion credentials API

The credentials API from Quadrillion — 2 operation(s) for credentials.

OpenAPI Specification

quadrillion-credentials-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Quadrillion Cloud account credentials API
  description: Public cloud API service for cloud-safe backend endpoints
  version: 0.1.0
tags:
- name: credentials
paths:
  /api/credentials/status:
    get:
      tags:
      - credentials
      summary: Get Credentials Status
      description: 'Return ``{key: {set: bool, hint: str | null}}`` for every credential.


        Reports the active user''s visible credential state for each known key.'
      operationId: get_credentials_status_api_credentials_status_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
  /api/credentials/{key}:
    put:
      tags:
      - credentials
      summary: Store Credential Handler
      description: Store a credential in ``settings.json``.
      operationId: store_credential_handler_api_credentials__key__put
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          title: Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/_CredentialStoreRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - credentials
      summary: Delete Credential Handler
      description: Remove a credential from ``settings.json``.
      operationId: delete_credential_handler_api_credentials__key__delete
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          title: Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    _CredentialStoreRequest:
      properties:
        value:
          type: string
          title: Value
      type: object
      required:
      - value
      title: _CredentialStoreRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError