Acronis Clients API

OAuth2 client credential management

OpenAPI Specification

acronis-clients-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Acronis Account Management Activities Clients API
  description: The Acronis Account Management API provides endpoints for managing tenants, users, OAuth clients, applications, licensing (offering items), usage reporting, infrastructure, and branding within the Acronis Cyber Protect Cloud platform.
  version: '2.0'
  contact:
    name: Acronis Developer Portal
    url: https://developer.acronis.com
  x-generated-from: documentation
  x-last-validated: '2026-04-19'
servers:
- url: https://{datacenter}.acronis.com/api/2
  description: Acronis Cloud API - Account Management
  variables:
    datacenter:
      default: eu2-cloud
      description: Acronis datacenter region (e.g., us-cloud, eu2-cloud, au-cloud)
security:
- bearerAuth: []
tags:
- name: Clients
  description: OAuth2 client credential management
paths:
  /clients:
    get:
      operationId: listClients
      summary: Acronis List OAuth Clients
      description: List OAuth2 client credentials registered in the system.
      tags:
      - Clients
      parameters:
      - name: tenant_id
        in: query
        schema:
          type: string
          format: uuid
        description: Filter clients by tenant UUID
      responses:
        '200':
          description: List of OAuth clients
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientList'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createClient
      summary: Acronis Create OAuth Client
      description: Create a new OAuth2 client credential for API authentication.
      tags:
      - Clients
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientRequest'
      responses:
        '201':
          description: Client created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Client'
        '400':
          $ref: '#/components/responses/BadRequest'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /clients/{client_id}:
    get:
      operationId: getClient
      summary: Acronis Get OAuth Client
      description: Retrieve details about a specific OAuth2 client.
      tags:
      - Clients
      parameters:
      - name: client_id
        in: path
        required: true
        schema:
          type: string
        description: OAuth2 client identifier
      responses:
        '200':
          description: Client details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Client'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteClient
      summary: Acronis Delete OAuth Client
      description: Delete an OAuth2 client credential.
      tags:
      - Clients
      parameters:
      - name: client_id
        in: path
        required: true
        schema:
          type: string
        description: OAuth2 client identifier
      responses:
        '204':
          description: Client deleted
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request - invalid input
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    ClientList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Client'
    Client:
      type: object
      description: OAuth2 client credential
      properties:
        client_id:
          type: string
          description: OAuth2 client identifier
          example: abc123def456
        client_secret:
          type: string
          description: OAuth2 client secret (only shown on creation)
        tenant_id:
          type: string
          format: uuid
          description: Tenant the client belongs to
        type:
          type: string
          enum:
          - api_client
          - agent
          description: Client type
        status:
          type: string
          enum:
          - enabled
          - disabled
        data:
          type: object
          additionalProperties: true
          description: Additional client metadata
    ClientRequest:
      type: object
      required:
      - tenant_id
      - type
      properties:
        tenant_id:
          type: string
          format: uuid
          description: Tenant UUID to associate the client with
        type:
          type: string
          enum:
          - api_client
          description: Client type
        data:
          type: object
          additionalProperties: true
    Error:
      type: object
      description: API error response
      properties:
        code:
          type: integer
          description: Error code
          example: 400
        message:
          type: string
          description: Human-readable error message
          example: Invalid request parameters
        details:
          type: array
          items:
            type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth2 bearer token obtained from /idp/token
    basicAuth:
      type: http
      scheme: basic
      description: Base64-encoded client_id:client_secret