Multi-service Portal API documentation version 2
https://{host}:{port}/api/{version}
- host: required(string - default: localhost)
- port: required(integer - default: 443)
- version: required(2)
/brands
Actions with brands.
get
Fetches brand details by ID.
get /brands/{brand}
Fetches brand details by ID.
URI Parameters
- brand: required(string)
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"properties": {
"support_phone": {
"type": ["string", "null"],
"description": "Company support phone number."
},
"id": {"$ref": "#/definitions/uuid"},
"account_server_url": {
"type": ["string", "null"],
"description": "Link to account server."
},
"support_url": {
"type": ["string", "null"],
"description": "Support page address."
},
"mobile_app_android_download_url": {
"type": ["string", "null"],
"description": "Link for Android mobile app download."
},
"upsell_url": {
"type": ["string", "null"],
"description": "Link for partner`s Buy page."
},
"backup_console_url": {
"type": "string",
"description": "Link to Backup Console."
},
"terms_url": {
"type": ["string", "null"],
"description": "Company terms and conditions page url."
},
"home_url": {
"type": ["string", "null"],
"description": "Company web-site url."
},
"knowledgebase_url": {
"type": ["string", "null"],
"description": "Knowledge base url."
},
"platform_terms_url": {
"type": ["string", "null"],
"description": "Terms and conditions page for platform."
},
"user_guide_url": {
"type": ["string", "null"],
"description": "User guide url."
},
"mobile_app_ios_download_url": {
"type": ["string", "null"],
"description": "Link for iOS mobile app download."
},
"color": {
"type": ["string", "null"],
"description": "Brand color in RGB."
},
"company_name": {
"type": ["string", "null"],
"description": "Company name."
},
"color_scheme": {
"type": "string",
"description": "Color scheme identifier."
},
"logotype": {
"description": "Logotype id.",
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/uuid"
}
]
},
"service_name": {
"type": ["string", "null"],
"description": "Name of the service."
},
"reg_server_url": {
"type": ["string", "null"],
"description": "Registration server URL."
},
"router_url": {
"type": ["string", "null"],
"description": "Link to Management Console."
},
"agent_gateway_url": {
"type": ["string", "null"],
"description": "Agent gateway URL."
},
"help_url": {
"type": ["string", "null"],
"description": "Online help url."
},
"privacy_policy_url": {
"type": ["string", "null"],
"description": "Platform privacy policy."
},
"owns_custom_legal_docs": {
"type": "boolean",
"description": "Flag that decides if brand owns custom terms urls."
},
"white_labeled_agent": {
"type": "boolean",
"description": "Acronis branded or white labeled agent."
}
},
"definitions": {
"uuid": {"$ref": "../../_common/types/uuid.json"}
},
"type": "object",
"description": "Public brand schema.",
"$schema": "http://json-schema.org/draft-04/schema"
}
Example:
{
"support_phone": "+1 1111 1111111",
"id": "2f8ad2e2-28f2-11e7-aad1-5ffe2ad47151",
"account_server_url": "mc-cloud.acronis.com",
"support_url": "support.acronis.com",
"mobile_app_android_download_url": "www.mobile.com/download",
"upsell_url": "www.partner.com/buy",
"backup_console_url": "mc-cloud.acronis.com/bc",
"terms_url": "terms.acronis.com",
"home_url": "www.example.com",
"knowledgebase_url": "kb.acronis.com/errorcode/",
"platform_terms_url": "terms.acronis.com",
"user_guide_url": "guide.acronis.com",
"mobile_app_ios_download_url": "www.mobile.com/download",
"color": "FFFFFF",
"company_name": "Example",
"color_scheme": "default",
"logotype": "2f8ad2e2-28f2-11e7-aad1-5ffe2ad47151",
"service_name": "Example",
"reg_server_url": "https://rs.custom-cloud.acronis.com",
"router_url": "cloud.acronis.com",
"agent_gateway_url": "https://agents.custom-cloud.acronis.com",
"help_url": "api/ams/links/help",
"hide_predefined": 1,
"privacy_policy_url": "https://www.acronis.com/company/privacy.html",
"owns_custom_legal_docs": true,
"white_labeled_agent": true
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
/content
Actions with images.
get
Fetches a PNG image by ID.
get /content/images/{image}
Fetches a PNG image by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- image: required(string)
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Headers
- Cache-Control: (string)
Example:
max-age=86400, must-revalidate
Body
Media type: image/png
Type: any
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/access_policies
get
Fetches a list of access policies for specific users.
get /access_policies
Fetches a list of access policies for specific users.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- users: (json)
A filter by comma-separated list of users' UUIDs.
Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed,248c535a-0ebe-11e7-a80e-bbdaa1d60c7c - subtree_root_tenant_id: (json)
A filter by tenants tree starting from the specified tenant ID. Is mutually exclusive with
users.Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed - updated_since: (datetime)
A filter by access policies that were updated after the specified RFC3339 timestamp in UTC time zone.
Example:
2016-02-28T16:41:41.090Z - limit: (integer - default: 5000)
Number of elements in current access policies page of the response.
- after: (string)
Cursor to fetch the next access policies page. The cursor encodes all the filtering and sorting arguments, thus client does not need to provide all them for the next page, only cursor should be provided. Client can get the cursor from
paging.cursors.afterfield of the previous page response. - allow_deleted: (boolean)
If true, deleted access policies may be returned.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"accessPolicy": {"$ref": "./accessPolicy.json"}
},
"type": "object",
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/accessPolicy"
}
}
},
"required": [
"items",
"timestamp"
]
}
Example:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"id": "00000000-0000-0000-0000-000000000005",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "hci_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "hci",
"resource_path": "res1"
},
{
"id": "00000000-0000-0000-0000-000000000004",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "notary_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "notary",
"resource_path": "res4/res5"
},
{
"id": "00000000-0000-0000-0000-000000000002",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "pds_operator",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5"
},
{
"id": "00000000-0000-0000-0000-000000000003",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "pds_support",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5"
}
]
}HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "bad request",
"details": {
"info": "Request body contains badly-formed JSON."
}
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages a specific access policy.
get
Fetches an access policy by ID.
delete
Deletes an access policy by ID.
get /access_policies/{access_policy_id}
Fetches an access policy by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- access_policy_id: required(json)
Access policy ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"userRole": {"$ref": "../_common/types/userRole.json"}
},
"type": "object",
"properties": {
"id": {
"description": "Access policy unique identifier.",
"type": "string"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Creation timestamp."
},
"updated_at": {
"$ref": "#/definitions/dateTime",
"description": "Last update timestamp, if tenant has just been created - then equals to `created_at`, if tenant has just been deleted - then equals to `deleted_at`."
},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
},
"trustee_id": {
"description": "Unique identifier of the Subject for whom access policy is granted.",
"type": "string"
},
"trustee_type": {
"description": "Type of the Subject for whom access policy is granted.",
"type": "string",
"enum": ["user", "user_group", "client"]
},
"issuer_id": {
"description": "Issuer unique identifier.",
"type": "string"
},
"tenant_id": {
"description": "Tenant unique identifier.",
"type": "string"
},
"resource_server_id": {
"description": "Tenant unique identifier.",
"type": "string"
},
"resource_namespace": {
"description": "Resource namespace.",
"type": "string"
},
"resource_path": {
"description": "Resource path.",
"type": "string"
},
"role_id": {
"$ref": "#/definitions/userRole",
"description": "Role identifier"
}
},
"required": ["id", "version", "created_at", "updated_at", "deleted_at", "trustee_id", "trustee_type", "tenant_id", "issuer_id", "role_id"]
}
Example:
{
"id": "00000000-0000-0000-0000-000000000004",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "notary_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "notary",
"resource_path": "res4/res5"
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
delete /access_policies/{access_policy_id}
Deletes an access policy by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- access_policy_id: required(json)
Access policy ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 204
Access policy was successfully deleted.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/legal_documents
Legal documents management.
get
Fetches a batch of legal documents by their IDs.
Available in cloud version only.
get /legal_documents
Fetches a batch of legal documents by their IDs.
Available in cloud version only.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- uuids: required(string)
Comma-separated list of legal documents' UUIDs.
Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed,248c535a-0ebe-11e7-a80e-bbdaa1d60c7c
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"agreement": {"$ref": "legalDocument.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/agreement"
}
}
},
"additionalProperties": false,
"required": [
"items"
]
}
Example:
{
"items": [
{
"document_version": "2019-04-04",
"comment": "comment",
"created": "2016-06-22T19:25:16",
"id": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"link": "https://acronis.com/eula-2019-04-04?language=[Language]",
"added_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"changed_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"covered_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"common_part_update": true,
"owner_tenant": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"added_by": "e6ac14fe-b53a-4120-862d-1c9d7cdc7980",
"published": "2016-06-22T19:25:16",
"grace_period": 30,
"document_type": "eula",
"version": 1497533157730
},
{
"document_version": "2019-04-04",
"comment": "comment",
"created": "2016-06-22T19:25:16",
"id": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"link": "https://acronis.com/eula-2019-04-04?language=[Language]",
"added_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"changed_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"covered_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"common_part_update": false,
"owner_tenant": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"added_by": "e6ac14fe-b53a-4120-862d-1c9d7cdc7980",
"published": null,
"grace_period": 30,
"document_type": "privacy_statement",
"version": 1497533157730
},
{
"document_version": "2019-04-04",
"comment": "comment",
"created": "2016-06-22T19:25:16",
"id": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"link": "https://acronis.com/eula-2019-04-04?language=[Language]",
"added_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"changed_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"covered_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"common_part_update": true,
"owner_tenant": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"added_by": "e6ac14fe-b53a-4120-862d-1c9d7cdc7980",
"published": null,
"grace_period": 30,
"document_type": "platform_terms",
"version": 1497533157730
}
]
}HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages a specific legal document.
delete
Deletes a legal document by ID.
Already published legal document cannot be deleted.
Available in cloud version only.
get
Fetches the information about the legal document.
Available in cloud version only.
put
Updates the information about the legal document.
Already published legal document cannot be updated.
Available in cloud version only.
delete /legal_documents/{legal_document_id}
Deletes a legal document by ID.
Already published legal document cannot be deleted.
Available in cloud version only.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
URI Parameters
- legal_document_id: required(json)
Legal document ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- version: required(integer)
Growing number of object internal version.
Example:
1559561146223
HTTP status code 204
Legal document was successfully deleted.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get /legal_documents/{legal_document_id}
Fetches the information about the legal document.
Available in cloud version only.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- legal_document_id: required(json)
Legal document ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"date": {"$ref": "../_common/types/date.json"},
"datetime": {"$ref": "../_common/types/dateTime.json"},
"url": {"$ref": "../_common/types/url.json"},
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"properties": {
"comment": {
"description": "Document description. This field can have a null value.",
"type": ["string", "null"]
},
"common_part_update": {
"description": "Flag that represents if document contains common part update.",
"type": "boolean"
},
"changed_items": {
"description": "Items changed in a given version compared to a previous one.",
"type": "object",
"properties": {
"offering_items": {
"type": "array",
"items": {
"type": "string"
}
},
"backend_types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"covered_items": {
"description": "Full set of items covered by a given document.",
"type": "object",
"properties": {
"offering_items": {
"type": "array",
"items": {
"type": "string"
}
},
"backend_types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"added_items": {
"description": "Set of items that appeared just in a current version.",
"type": "object",
"properties": {
"offering_items": {
"type": "array",
"items": {
"type": "string"
}
},
"backend_types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"grace_period": {
"description": "Grace period for accepting given document.\nCountdown will start after a first preposition to sign it.",
"type": "integer"
},
"id": {
"description": "Unique identifier for this document.",
"$ref": "#/definitions/uuid"
},
"link": {
"description": "Link to a document.",
"$ref": "#/definitions/url"
},
"owner_tenant": {
"description": "Owner tenant uuid.",
"$ref": "#/definitions/uuid"
},
"added_by": {
"description": "User which added document.",
"$ref": "#/definitions/uuid"
},
"published": {
"description": "Publication time if document was made available for partners, null if document still could be changed. This field can have a null value.",
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/datetime"
}
]
},
"document_type": {
"type": "string",
"description": "Type of a document.",
"enum": ["eula", "privacy_statement", "platform_terms"]
},
"document_version": {
"$ref": "#/definitions/date",
"description": "Document version (provided by parsing document url)."
},
"created": {
"$ref": "#/definitions/datetime",
"description": "Time of document creation."
},
"version": {
"type": "integer",
"description": "Internal version (auto-incremented entity version)."
}
},
"additionalProperties": false,
"required": [
"comment",
"common_part_update",
"changed_items",
"covered_items",
"created",
"document_type",
"grace_period",
"id",
"link",
"owner_tenant",
"published",
"document_version",
"version"
],
"type": "object"
}
Example:
{
"document_version": "2019-04-04",
"created": "2016-06-22T19:25:16",
"comment": "End-user licence agreement",
"id": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"link": "https://acronis.com/eula-2019-04-04?language=[Language]",
"added_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"changed_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"covered_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"common_part_update": false,
"owner_tenant": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"added_by": "e6ac14fe-b53a-4120-862d-1c9d7cdc7980",
"published": "2016-06-22T19:25:16",
"grace_period": 30,
"document_type": "eula",
"version": 1497533157730
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /legal_documents/{legal_document_id}
Updates the information about the legal document.
Already published legal document cannot be updated.
Available in cloud version only.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
URI Parameters
- legal_document_id: required(json)
Legal document ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- version: required(integer)
Growing number of object internal version.
Example:
1559561146223
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"published": {
"description": "True if document was made available for partners.",
"type": "boolean"
}
},
"additionalProperties": false,
"type": "object"
}
Example:
{
"published": true
}
HTTP status code 202
Legal document was successfully updated.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"date": {"$ref": "../_common/types/date.json"},
"datetime": {"$ref": "../_common/types/dateTime.json"},
"url": {"$ref": "../_common/types/url.json"},
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"properties": {
"comment": {
"description": "Document description. This field can have a null value.",
"type": ["string", "null"]
},
"common_part_update": {
"description": "Flag that represents if document contains common part update.",
"type": "boolean"
},
"changed_items": {
"description": "Items changed in a given version compared to a previous one.",
"type": "object",
"properties": {
"offering_items": {
"type": "array",
"items": {
"type": "string"
}
},
"backend_types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"covered_items": {
"description": "Full set of items covered by a given document.",
"type": "object",
"properties": {
"offering_items": {
"type": "array",
"items": {
"type": "string"
}
},
"backend_types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"added_items": {
"description": "Set of items that appeared just in a current version.",
"type": "object",
"properties": {
"offering_items": {
"type": "array",
"items": {
"type": "string"
}
},
"backend_types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"grace_period": {
"description": "Grace period for accepting given document.\nCountdown will start after a first preposition to sign it.",
"type": "integer"
},
"id": {
"description": "Unique identifier for this document.",
"$ref": "#/definitions/uuid"
},
"link": {
"description": "Link to a document.",
"$ref": "#/definitions/url"
},
"owner_tenant": {
"description": "Owner tenant uuid.",
"$ref": "#/definitions/uuid"
},
"added_by": {
"description": "User which added document.",
"$ref": "#/definitions/uuid"
},
"published": {
"description": "Publication time if document was made available for partners, null if document still could be changed. This field can have a null value.",
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/datetime"
}
]
},
"document_type": {
"type": "string",
"description": "Type of a document.",
"enum": ["eula", "privacy_statement", "platform_terms"]
},
"document_version": {
"$ref": "#/definitions/date",
"description": "Document version (provided by parsing document url)."
},
"created": {
"$ref": "#/definitions/datetime",
"description": "Time of document creation."
},
"version": {
"type": "integer",
"description": "Internal version (auto-incremented entity version)."
}
},
"additionalProperties": false,
"required": [
"comment",
"common_part_update",
"changed_items",
"covered_items",
"created",
"document_type",
"grace_period",
"id",
"link",
"owner_tenant",
"published",
"document_version",
"version"
],
"type": "object"
}
Example:
{
"document_version": "2019-04-04",
"created": "2016-06-22T19:25:16",
"comment": "End-user licence agreement",
"id": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"link": "https://acronis.com/eula-2019-04-04?language=[Language]",
"added_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"changed_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"covered_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"common_part_update": false,
"owner_tenant": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"added_by": "e6ac14fe-b53a-4120-862d-1c9d7cdc7980",
"published": "2016-06-22T19:25:16",
"grace_period": 30,
"document_type": "eula",
"version": 1497533157730
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/applications
Manages applications.
get
Fetches a list of all registered applications.
get /applications
Fetches a list of all registered applications.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"application": {"$ref": "./application.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/application"
}
}
},
"required": [
"items"
]
}
Example:
{
"items": [
{
"type": "backup",
"api_base_url": "/bc/",
"name": "Backup",
"id": "6e6d758d-8e74-3ae3-ac84-50eb0dff12eb",
"usages": [
"assigned_compute_points",
"child_storages",
"cloud_to_cloud_backup",
"compute_points",
"dr_cloud_servers",
"dr_internet_access",
"dr_storage",
"google_drive_storage",
"google_mail_storage",
"google_team_drive_storage",
"group_mailbox_storage",
"group_site_storage",
"gsuite_seats",
"local_storage",
"mailbox_instance_size",
"mailbox_storage",
"mailboxes",
"mobile_storage",
"mobiles",
"onedrive_storage",
"public_ips",
"server_storage",
"servers",
"sharepoint_online_site_storage",
"site_collection_storage",
"storage",
"total_storage",
"universal_devices",
"universal_devices_storage",
"virtualhost_storage",
"virtualhosts",
"vm_storage",
"vms",
"website_storage",
"websites",
"win_server_essentials",
"win_server_essentials_storage",
"workstation_storage",
"workstations"
]
},
{
"type": "physical_data_shipping",
"api_base_url": "/pds/",
"name": "Physical Data Shipping",
"id": "b71b2c18-590a-303c-9d5a-8444fbe713ac",
"usages": [
"drives_shipped_from_cloud",
"drives_shipped_to_cloud"
]
},
{
"type": "files_cloud",
"api_base_url": "/fc/",
"name": "File Sync & Share",
"id": "dfd85a5f-a464-32ab-81fd-99bcc66a070f",
"usages": [
"fc_child_storages",
"fc_seats",
"fc_storage",
"fc_total_storage"
]
},
{
"type": "notary",
"api_base_url": "/notary/console",
"name": "Notary",
"id": "f9c5744e-bd1a-36b6-b0f0-ecd7483e1796",
"usages": [
"esignatures",
"esignatures_api",
"notarizations",
"notarizations_api",
"notarizations_total",
"notary_storage"
]
},
{
"type": "hci",
"api_base_url": "/hci/",
"name": "Acronis Storage SPLA",
"id": "cc29685d-a9ca-3e87-a83d-069f18b588f0",
"usages": [
"hci_cifs_storage",
"hci_compute_points",
"hci_iscsi_storage",
"hci_nfs_storage",
"hci_s3_storage",
"hci_storage",
"hci_total_cifs_storage",
"hci_total_compute_points",
"hci_total_iscsi_storage",
"hci_total_nfs_storage",
"hci_total_s3_storage",
"hci_total_storage",
"hci_total_vm_provisioned_cpu",
"hci_total_vm_provisioned_ram",
"hci_total_vm_storage",
"hci_total_vtl_storage",
"hci_vm_provisioned_cpu",
"hci_vm_provisioned_ram",
"hci_vm_storage",
"hci_vtl_storage"
]
},
{
"type": "platform",
"api_base_url": "/mc/",
"name": "Management Portal",
"id": "7459244f-68f3-3bf4-9f53-5f63ecc1d91f",
"usages": []
}
]
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages a specific application.
get
Fetches the information about the application by ID.
get /applications/{application_id}
Fetches the information about the application by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- application_id: required(json)
Application ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"applicationType": { "$ref": "../_common/types/applicationType.json" }
},
"type": "object",
"properties": {
"id": {
"description": "Unique identifier for application-tenant binding.",
"$ref": "#/definitions/uuid"
},
"name": {
"type": "string",
"description": "Human-readable name that will be displayed to the users."
},
"type": {
"description": "Type of application.",
"$ref": "#/definitions/applicationType"
},
"usages": {
"description": "Available usages for this application.",
"type": "array",
"items": {
"type": "string",
"description": "Usage name."
}
},
"api_base_url": {
"type": "string",
"description": "Base URL for application's HTTP API."
}
},
"required": [
"id",
"name",
"type",
"api_base_url",
"usages"
]
}
Example:
{
"id": "8aaf366b-fe24-4f25-93b3-bd729c86cc95",
"name": "Acronis Backup Cloud",
"type": "backup",
"api_base_url": "/bc",
"usages": [ "workstations", "vms" ]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages application's bindings.
Manages application-tenants bindings.
post
Turns the application on for the tenant.
delete
Turns the application off for the tenant.
post /applications/{application_id}/bindings/tenants/{tenant_id}
Turns the application on for the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- application_id: required(json)
Application ID (UUID).
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 204
Application was successfully turned on.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
delete /applications/{application_id}/bindings/tenants/{tenant_id}
Turns the application off for the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- application_id: required(json)
Application ID (UUID).
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 204
Application was successfully turned off.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages application's features.
Manages application's features for the tenants.
Manages a specific feature of the application for the provided tenant. Effective features can be only read; own features can be read, updated and deleted.
post
Enables the application's feature for the provided tenant.
delete
Disables the application's feature for the provided tenant.
get
Fetches the application's feature status for the provided tenant.
post /applications/{application_id}/features/tenants/{tenant_id}/{feature_name}
Enables the application's feature for the provided tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
URI Parameters
- application_id: required(json)
Application ID (UUID).
- tenant_id: required(json)
Tenant ID (UUID).
- feature_name: required(string)
Name of the application's feature.
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 201
Application's feature was successfully enabled.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "boolean",
"description": "Feature status for a given tenant."
}
}
}
Example:
{
"status": true
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
delete /applications/{application_id}/features/tenants/{tenant_id}/{feature_name}
Disables the application's feature for the provided tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
URI Parameters
- application_id: required(json)
Application ID (UUID).
- tenant_id: required(json)
Tenant ID (UUID).
- feature_name: required(string)
Name of the application's feature.
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 204
Application's feature was successfully disabled.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "boolean",
"description": "Feature status for a given tenant."
}
}
}
Example:
{
"status": true
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get /applications/{application_id}/features/tenants/{tenant_id}/{feature_name}
Fetches the application's feature status for the provided tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- application_id: required(json)
Application ID (UUID).
- tenant_id: required(json)
Tenant ID (UUID).
- feature_name: required(string)
Name of the application's feature.
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "boolean",
"description": "Feature status for a given tenant."
}
}
}
Example:
{
"status": true
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages application's settings.
Manages schemas of the application's settings.
get
Fetches a list of application's settings schemas.
get /applications/{application_id}/settings/schemas
Fetches a list of application's settings schemas.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- application_id: required(json)
Application ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"schemas": {
"type": "array",
"items": {
"$ref": "settingSchema.json"
}
}
}
}
Example:
{
"schemas": [
{
"application_id": "c51227c8-473f-4f49-8a24-29efa254efd5",
"name": "quota_1",
"inheritance_type": "minimum",
"business_type": "quota"
},
{
"application_id": "c51227c8-473f-4f49-8a24-29efa254efd5",
"name": "setting_2",
"inheritance_type": "minimum",
"business_type": "setting"
}
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages application settings for tenants.
get
Fetches a batch of settings for tenants by their IDs.
Available in cloud version only.
get /applications/{application_id}/settings/tenants
Fetches a batch of settings for tenants by their IDs.
Available in cloud version only.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- application_id: required(json)
Application ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- allow_deleted: (boolean)
If true, settings for deleted tenants may be returned.
- uuids: required(string)
Comma-separated list of tenants' UUIDs.
Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed,248c535a-0ebe-11e7-a80e-bbdaa1d60c7c
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {
"$ref": "../_common/types/uuid.json"
}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tenant": {
"type": "string",
"description": "ID of tenant setting list belongs to.",
"$ref": "#/definitions/uuid"
},
"settings": {
"type": "array",
"items": {
"$ref": "setting.json"
}
}
},
"required": [
"tenant",
"settings"
]
}
}
},
"required": [
"items"
]
}Example:
{
"items": [
{
"tenant": "56379099-8944-4359-b8ef-88eff3391a61",
"settings": [
{
"name": "setting_1",
"application_id": "2f2a4239-f140-4337-a107-bed298fed3f1",
"own": {
"value": "new_stuff",
"lock": false,
"exclusive": false
},
"effective": {
"owner": {
"type": "tenant",
"id": "81129b10-9f2a-4ee7-bf90-8698c4af055c"
},
"hidden": false,
"value": "old_Stuff",
"lock": false
}
},
{
"name": "setting_2",
"application_id": "2f2a4239-f140-4337-a107-bed298fed3f1",
"own": {
"value": "new_stuff",
"lock": false,
"exclusive": false
},
"effective": {
"owner": {
"type": "tenant",
"id": "81129b10-9f2a-4ee7-bf90-8698c4af055c"
},
"hidden": false,
"value": "old_Stuff",
"lock": false
}
}
]
},
{
"tenant": "7ca99bce-52c7-4c76-b01e-b9c5a0f83491",
"settings": [
{
"name": "setting_1",
"application_id": "2f2a4239-f140-4337-a107-bed298fed3f1",
"own": {
"value": "new_stuff",
"lock": false,
"exclusive": false
},
"effective": {
"owner": {
"type": "tenant",
"id": "81129b10-9f2a-4ee7-bf90-8698c4af055c"
},
"hidden": false,
"value": "old_Stuff",
"lock": false
}
},
{
"name": "setting_2",
"application_id": "2f2a4239-f140-4337-a107-bed298fed3f1",
"own": {
"value": "new_stuff",
"lock": false,
"exclusive": false
},
"effective": {
"owner": {
"type": "tenant",
"id": "81129b10-9f2a-4ee7-bf90-8698c4af055c"
},
"hidden": false,
"value": "old_Stuff",
"lock": false
}
}
]
}
]
}Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Fetches application settings for the provided tenant.
get /applications/{application_id}/settings/tenants/{tenant_id}
Fetches application settings for the provided tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- application_id: required(json)
Application ID (UUID).
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"settings": {
"type": "array",
"items": {
"$ref": "setting.json"
}
}
},
"required": [
"settings"
]
}
Example:
{
"settings": [
{
"name": "setting_1",
"application_id": "2f2a4239-f140-4337-a107-bed298fed3f1",
"own": {
"value": "new_stuff",
"lock": false,
"exclusive": false
},
"effective": {
"owner": {
"type": "tenant",
"id": "81129b10-9f2a-4ee7-bf90-8698c4af055c"
},
"hidden": false,
"value": "old_Stuff",
"lock": false
}
}
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages a setting of the specific application for the provided tenant. Effective settings can be only read; own settings can be read, updated and deleted.
"tier_level_value" (int) The level of minimum commitment, i.e. volume discount.
Allowed values: [ -2 (Custom), -1 (No commitment), 0 (Tier 1), 1, 2, 3, 4, 5, 6, 7 ]
"licensing_mode" (string)
- "per_gb" licensing mode - when partner is charged for storage usage only (Acronis Hosted, Azure Hosted, Google Hosted, Hybrid or local storage).
- "per_device" licensing mode - when partner is charged for each protected device and additionally for Acronis, Google or Azure Hosted storage. Hybrid Storage and Local Storage are included into the device fee.
delete
Deletes own setting of the tenant's application. The setting will be inherited from parent tenants when deleted.
put
Updates a setting of the tenant's application.
get
Fetches a setting of the tenant's application.
delete /applications/{application_id}/settings/tenants/{tenant_id}/{setting_name}
Deletes own setting of the tenant's application. The setting will be inherited from parent tenants when deleted.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- application_id: required(json)
Application ID (UUID).
- tenant_id: required(json)
Tenant ID (UUID).
- setting_name: required(string)
A name of the application's setting.
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 204
Own application setting was successfully deleted.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /applications/{application_id}/settings/tenants/{tenant_id}/{setting_name}
Updates a setting of the tenant's application.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- application_id: required(json)
Application ID (UUID).
- tenant_id: required(json)
Tenant ID (UUID).
- setting_name: required(string)
A name of the application's setting.
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"value": {
"type": [
"string",
"boolean",
"integer",
"null",
"object"
],
"description": "Value of the setting."
},
"lock": {
"type": "boolean",
"description": "Flag that controls whether the value can be overridden at another tenant's level."
},
"exclusive": {
"type": "boolean",
"description": "If true, the value set for this tenant does not affect inheritance; this tenant's children will inherit the value from their grandparent tenant."
}
}
}
Example:
{
"value": "qwerty",
"lock": false
}
HTTP status code 200
Own setting was successfully updated.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {
"$ref": "../_common/types/uuid.json"
}
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the setting, for internal use by the platform and applications. Serves as the setting's ID."
},
"application_id": {
"type": "string",
"description": "ID of application that this setting belongs to.",
"$ref": "#/definitions/uuid"
},
"own": {
"type": ["object", "null"],
"description": "Data which was set for this tenant.",
"properties": {
"value": {
"type": [ "string", "boolean", "integer", "null", "object" ],
"description": "Value of the setting. This field can have a null value."
},
"lock": {
"type": "boolean",
"description": "Flag that controls whether the value can be overridden at another tenant's level.",
"default": false
},
"exclusive": {
"type": "boolean",
"description": "If true, the value set for this tenant does not affect inheritance; this tenant's children will inherit the value from their grandparent tenant.",
"default": false
}
},
"required": [ "value", "lock", "exclusive" ]
},
"effective": {
"type": ["object", "null"],
"description": "Inherited data. This field can have a null value.",
"properties": {
"owner": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["tenant", "user"],
"description": "Type of object where this value is defined."
},
"id": {
"description": "ID of tenant or user where this value is defined.",
"$ref": "#/definitions/uuid"
}
},
"required": ["type", "id"]
},
"value": {
"type": [ "string", "boolean", "integer", "null" ],
"description": "Value of the setting. This field can have a null value."
},
"lock": {
"type": "boolean",
"description": "Flag that controls whether the value can be overridden at another tenant's level."
}
}
}
},
"required": ["effective", "name"]
}
Example:
{
"name": "setting_1",
"application_id": "2f2a4239-f140-4337-a107-bed298fed3f1",
"own": {
"value": "new_stuff",
"lock": false,
"exclusive": false
},
"effective": {
"owner": {
"type": "tenant",
"id": "81129b10-9f2a-4ee7-bf90-8698c4af055c"
},
"value": "old_Stuff",
"lock": false
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get /applications/{application_id}/settings/tenants/{tenant_id}/{setting_name}
Fetches a setting of the tenant's application.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- application_id: required(json)
Application ID (UUID).
- tenant_id: required(json)
Tenant ID (UUID).
- setting_name: required(string)
A name of the application's setting.
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {
"$ref": "../_common/types/uuid.json"
}
},
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the setting, for internal use by the platform and applications. Serves as the setting's ID."
},
"application_id": {
"type": "string",
"description": "ID of application that this setting belongs to.",
"$ref": "#/definitions/uuid"
},
"own": {
"type": ["object", "null"],
"description": "Data which was set for this tenant.",
"properties": {
"value": {
"type": [ "string", "boolean", "integer", "null", "object" ],
"description": "Value of the setting. This field can have a null value."
},
"lock": {
"type": "boolean",
"description": "Flag that controls whether the value can be overridden at another tenant's level.",
"default": false
},
"exclusive": {
"type": "boolean",
"description": "If true, the value set for this tenant does not affect inheritance; this tenant's children will inherit the value from their grandparent tenant.",
"default": false
}
},
"required": [ "value", "lock", "exclusive" ]
},
"effective": {
"type": ["object", "null"],
"description": "Inherited data. This field can have a null value.",
"properties": {
"owner": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["tenant", "user"],
"description": "Type of object where this value is defined."
},
"id": {
"description": "ID of tenant or user where this value is defined.",
"$ref": "#/definitions/uuid"
}
},
"required": ["type", "id"]
},
"value": {
"type": [ "string", "boolean", "integer", "null" ],
"description": "Value of the setting. This field can have a null value."
},
"lock": {
"type": "boolean",
"description": "Flag that controls whether the value can be overridden at another tenant's level."
}
}
}
},
"required": ["effective", "name"]
}
Example:
{
"name": "setting_1",
"application_id": "2f2a4239-f140-4337-a107-bed298fed3f1",
"own": {
"value": "new_stuff",
"lock": false,
"exclusive": false
},
"effective": {
"owner": {
"type": "tenant",
"id": "81129b10-9f2a-4ee7-bf90-8698c4af055c"
},
"value": "old_Stuff",
"lock": false
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/billing
Manages billing settings.
Manages tenant's billing settings.
get
Fetches tenant-level billing settings.
put
Updates tenant-level billing settings.
get /billing/tenants/{tenant_id}
Fetches tenant-level billing settings.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"definitions": {
"currency": {"$ref": "../_common/types/currency.json"}
},
"properties": {
"mode": {
"type": "string",
"enum": [
"external",
"internal"
]
},
"usage_calculation_mode": {
"type": "string",
"enum": [
"last_day",
"average"
]
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
}
},
"required": [
"mode",
"usage_calculation_mode",
"version"
]
}
Example:
{
"version": 1497533157730,
"mode": "external",
"usage_calculation_mode": "last_day"
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /billing/tenants/{tenant_id}
Updates tenant-level billing settings.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"definitions": {
"currency": {"$ref": "../_common/types/currency.json"}
},
"properties": {
"mode": {
"type": "string",
"enum": [
"external",
"internal"
]
},
"usage_calculation_mode": {
"type": "string",
"enum": [
"last_day",
"average"
]
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
}
},
"required": [
"version"
]
}
Example:
{
"version": 1497533157730,
"mode": "external",
"usage_calculation_mode": "last_day"
}
HTTP status code 200
Tenant billing settings were successfully updated.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"definitions": {
"currency": {"$ref": "../_common/types/currency.json"}
},
"properties": {
"mode": {
"type": "string",
"enum": [
"external",
"internal"
]
},
"usage_calculation_mode": {
"type": "string",
"enum": [
"last_day",
"average"
]
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
}
},
"required": [
"mode",
"usage_calculation_mode",
"version"
]
}
Example:
{
"version": 1497533157730,
"mode": "external",
"usage_calculation_mode": "last_day"
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages billing periods.
get
Fetches custom billing periods.
put
Updates custom billing periods. Do not use dates later than UTC yesterday.
get /billing/tenants/{tenant_id}/periods
Fetches custom billing periods.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"date": {"$ref": "../_common/types/date.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"offering_item": {
"type": "object",
"properties": {
"application_id": {
"description": "ID of the offering item's owner application.",
"$ref": "#/definitions/uuid"
},
"infra_component_id": {
"description": "ID of the offering item's infrastructure component (for items that are bound to a component).",
"$ref": "#/definitions/uuid"
},
"infra_component_type": {
"type": "string",
"description": "Infrastructure component type."
},
"name": {
"type": "string",
"description": "Usage name (type)."
}
},
"required": [
"application_id",
"name"
]
},
"current_period": {
"oneOf": [
{
"type": "object",
"properties": {
"start": {
"description": "Starting date of the billing period.",
"$ref": "#/definitions/date"
}
},
"required": ["start"]
},
{"type": "null"}
],
"description": "This field can have a null value."
}
},
"required": [
"offering_item",
"current_period"
]
}
}
},
"required": [
"items"
]
}
Example:
{
"items": [
{
"offering_item": {
"application_id": "b037d1f6-25cf-4a9c-98f1-d3e41c100948",
"name": "storage",
"infra_component_id": "05348371-d95e-4cab-af2a-8e2cadafc30d"
},
"current_period": {
"start": "2017-02-27"
}
},
{
"offering_item": {
"application_id": "b037d1f6-25cf-4a9c-98f1-d3e41c100948",
"name": "storage",
"infra_component_id": "916188f5-2ce6-4e77-b1f3-27764119cabd"
},
"current_period": {
"start": "2017-02-04"
}
},
{
"offering_item": {
"application_id": "b037d1f6-25cf-4a9c-98f1-d3e41c100948",
"name": "servers"
},
"current_period": null
}
],
"meta": {
"total": 3
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /billing/tenants/{tenant_id}/periods
Updates custom billing periods. Do not use dates later than UTC yesterday.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"date": {"$ref": "../_common/types/date.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"offering_item": {
"type": "object",
"properties": {
"application_id": {
"description": "ID of the offering item's owner application.",
"$ref": "#/definitions/uuid"
},
"infra_component_id": {
"description": "ID of the offering item's infrastructure component (for items that are bound to a component).",
"$ref": "#/definitions/uuid"
},
"infra_component_type": {
"type": "string",
"description": "Infrastructure component type."
},
"name": {
"type": "string",
"description": "Usage name (type)."
}
},
"required": [
"application_id",
"name"
]
},
"current_period": {
"oneOf": [
{
"type": "object",
"properties": {
"start": {
"description": "Starting date of the billing period.",
"$ref": "#/definitions/date"
}
},
"required": ["start"]
},
{"type": "null"}
],
"description": "This field can have a null value."
}
},
"required": [
"offering_item",
"current_period"
]
}
}
},
"required": [
"items"
]
}
Example:
{
"items": [
{
"offering_item": {
"application_id": "b037d1f6-25cf-4a9c-98f1-d3e41c100948",
"name": "storage",
"infra_component_id": "05348371-d95e-4cab-af2a-8e2cadafc30d"
},
"current_period": {
"start": "2017-02-27"
}
},
{
"offering_item": {
"application_id": "b037d1f6-25cf-4a9c-98f1-d3e41c100948",
"name": "storage",
"infra_component_id": "916188f5-2ce6-4e77-b1f3-27764119cabd"
},
"current_period": {
"start": "2017-02-04"
}
},
{
"offering_item": {
"application_id": "b037d1f6-25cf-4a9c-98f1-d3e41c100948",
"name": "servers"
},
"current_period": null
}
]
}
HTTP status code 200
Billing periods were successfully updated.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"date": {"$ref": "../_common/types/date.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"offering_item": {
"type": "object",
"properties": {
"application_id": {
"description": "ID of the offering item's owner application.",
"$ref": "#/definitions/uuid"
},
"infra_component_id": {
"description": "ID of the offering item's infrastructure component (for items that are bound to a component).",
"$ref": "#/definitions/uuid"
},
"infra_component_type": {
"type": "string",
"description": "Infrastructure component type."
},
"name": {
"type": "string",
"description": "Usage name (type)."
}
},
"required": [
"application_id",
"name"
]
},
"current_period": {
"oneOf": [
{
"type": "object",
"properties": {
"start": {
"description": "Starting date of the billing period.",
"$ref": "#/definitions/date"
}
},
"required": ["start"]
},
{"type": "null"}
],
"description": "This field can have a null value."
}
},
"required": [
"offering_item",
"current_period"
]
}
}
},
"required": [
"items"
]
}
Example:
{
"items": [
{
"offering_item": {
"application_id": "b037d1f6-25cf-4a9c-98f1-d3e41c100948",
"name": "storage",
"infra_component_id": "05348371-d95e-4cab-af2a-8e2cadafc30d"
},
"current_period": {
"start": "2017-02-27"
}
},
{
"offering_item": {
"application_id": "b037d1f6-25cf-4a9c-98f1-d3e41c100948",
"name": "storage",
"infra_component_id": "916188f5-2ce6-4e77-b1f3-27764119cabd"
},
"current_period": {
"start": "2017-02-04"
}
},
{
"offering_item": {
"application_id": "b037d1f6-25cf-4a9c-98f1-d3e41c100948",
"name": "servers"
},
"current_period": null
}
],
"meta": {
"total": 3
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/clients
Manages OAuth 2.0 / OpenID Connect clients.
post
Creates a new client.
get
Fetches a batch of clients.
post /clients
Creates a new client.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"description": "Client type.",
"type": "string",
"enum": [
"api_client",
"managed_client"
]
},
"tenant_id": {
"description": "Tenant ID for client to be associated.",
"$ref": "../_common/types/uuid.json"
},
"data": {
"description": "Additional metadata, like agentType, hostname, etc...",
"type": "object"
},
"token_endpoint_auth_method": {
"description": "Explicit specified auth method.",
"type": "string",
"enum": [
"client_secret_basic",
"client_secret_post",
"none"
]
},
"redirect_uris": {
"description": "List of possible redirect uris.",
"type": "array",
"items": {
"type": "string"
}
},
"origin_id": {
"description": "Client origin ID.",
"type": "string"
}
},
"required": [
"type",
"tenant_id",
"token_endpoint_auth_method"
]
}
Example:
{
"type": "managed_client",
"tenant_id": "48f86be5-c628-49c3-8575-62e78f54e4eb",
"data": {
"client_name": "Some application client",
"origin_dc_id": "ff7625c0-d649-445c-a2b3-9b59e66bfc2d"
},
"token_endpoint_auth_method": "client_secret_basic",
"origin_id": "72403667-8e45-4dd9-bcbc-3e6047b98b3d"
}HTTP status code 201
Client was successfully created.
Body
Media type: application/json
Type: json
Content:
{
"title": "Post client result schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"}
},
"properties": {
"client_id": {
"description": "The provisioned unique client identifier.",
"$ref": "#/definitions/uuid"
},
"tenant_id": {
"description": "Tenant ID for client to be associated.",
"$ref": "#/definitions/uuid"
},
"client_secret_expires_at": {
"description": "Time at which the client_secret will expire or 0 if it will not expire, according to the configured client secret lifetime. Its value is represented as number of seconds since the Unix epoch.",
"type": "integer"
},
"type": {
"description": "Client type.",
"type": "string",
"enum": [
"api_client",
"managed_client"
]
},
"data": {
"description": "Additional metadata, like agentType, hostname, etc...",
"type": "object"
},
"token_endpoint_auth_method": {
"description": "Explicit specified auth method.",
"type": "string",
"enum": [
"client_secret_basic",
"client_secret_post",
"none"
]
},
"client_secret": {
"description": "Client secret.",
"type": "string"
},
"registration_access_token": {
"description": "Client registration access token.",
"type": "string"
},
"created_at": {
"description": "Creation date and time.",
"$ref": "#/definitions/dateTime"
},
"created_by": {
"description": "ID of the user who registered the client.",
"type": "string"
},
"status": {
"description": "Client status - either enabled or disabled. Disabled clients can no longer be used to receive Access Tokens.",
"type": "string",
"enum": [
"enabled",
"disabled"
]
},
"redirect_uris": {
"description": "List of possible redirect uris.",
"type": "array",
"items": {
"type": "string"
}
},
"origin_id": {
"description": "Client origin ID.",
"type": "string"
}
},
"required": [
"client_id",
"tenant_id",
"client_secret_expires_at",
"type",
"token_endpoint_auth_method",
"client_secret",
"registration_access_token",
"created_at",
"created_by",
"status"
]
}
Example:
{
"client_secret_expires_at": 0,
"token_endpoint_auth_method": "client_secret_basic",
"tenant_id": "48f86be5-c628-49c3-8575-62e78f54e4eb",
"data": {
"client_name": "Some application client",
"origin_dc_id": "ff7625c0-d649-445c-a2b3-9b59e66bfc2d"
},
"client_secret": "cfffe6f6271b4addbe90ca63236de581",
"registration_access_token": "94fe1f5e59b64bd69ad6754a34f37674",
"client_id": "3663410d-4b70-4860-860c-8db82bffab8e",
"created_at": "2019-08-24T01:23:15",
"created_by": "ab9d9f43-f9aa-4f83-9409-5547172daa27",
"type": "managed_client",
"status": "enabled",
"origin_id": "72403667-8e45-4dd9-bcbc-3e6047b98b3d"
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "ApplicationAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get /clients
Fetches a batch of clients.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- uuids: required(json)
A filter by comma-separated list of client's UUIDs.
Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed,248c535a-0ebe-11e7-a80e-bbdaa1d60c7c - origin_id: (string)
A filter by clients origin ID. Can be used together with uuids or separately.
Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed - allow_deleted: (boolean)
If true, info for deleted clients may be returned.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"client": {"$ref": "client.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/client"
}
}
},
"required": [
"items"
]
}
Example:
{
"items": [
{
"client_id": "4557d5f5-7881-54f4-83a5-212f19d355c1",
"client_secret_expires_at": 0,
"type": "api_client",
"tenant_id": "0a305354-6efc-4b81-858d-2ae5dd1f08b1",
"data": {
"client_name": "backup_api_gateway"
},
"token_endpoint_auth_method": "client_secret_basic",
"created_at": "2023-07-06T16:26:33Z",
"created_by": "ab9ae709-0d00-521a-8be3-7891b1041e18",
"last_access_at": "2023-07-28T14:16:19Z",
"last_access_from_ip": "10.233.106.171",
"status": "enabled",
"redirect_uris": [
"/bc/api/gateway/cb",
"/bc/api/gateway/cb:ui"
]
},
{
"client_id": "3663410d-4b70-4860-860c-8db82bffab8e",
"client_secret_expires_at": 0,
"type": "managed_client",
"tenant_id": "48f86be5-c628-49c3-8575-62e78f54e4eb",
"data": {
"client_name": "Some application client",
"origin_dc_id": "ff7625c0-d649-445c-a2b3-9b59e66bfc2d"
},
"token_endpoint_auth_method": "client_secret_basic",
"created_at": "2019-08-24T01:23:15",
"created_by": "ab9d9f43-f9aa-4f83-9409-5547172daa27",
"last_access_at": "2023-07-20T16:11:01Z",
"last_access_from_ip": "10.233.106.172",
"status": "enabled",
"origin_id": "72403667-8e45-4dd9-bcbc-3e6047b98b3d"
}
]
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages specific OAuth 2.0 / OpenID Connect client.
delete
Deletes a client by ID.
put
Updates a client by ID.
get
Fetches a client by ID.
delete /clients/{client_id}
Deletes a client by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- client_id: required(json)
Client ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 204
Client was successfully deleted.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /clients/{client_id}
Updates a client by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- client_id: required(json)
Client ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"data": {
"description": "Additional metadata that will be updated.",
"type": "object"
},
"status": {
"description": "Client status - either enabled or disabled. Disabled clients can no longer be used to receive Access Tokens.",
"type": "string",
"enum": [
"enabled",
"disabled"
]
},
"redirect_uris": {
"description": "List of possible redirect uris.",
"type": "array",
"items": {
"type": "string"
}
},
"origin_id": {
"description": "Client origin ID.",
"type": "string"
}
}
}
Example:
{
"data": {
"client_name": "Some application client"
},
"status": "disabled",
"redirect_uris": ["com.acronis.abc://oauth"]
}HTTP status code 200
Client was successfully updated.
Body
Media type: application/json
Type: json
Content:
{
"title": "Basic client schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"}
},
"properties": {
"client_id": {
"description": "The provisioned unique client identifier.",
"$ref": "#/definitions/uuid"
},
"tenant_id": {
"description": "Tenant ID for client to be associated.",
"$ref": "#/definitions/uuid"
},
"client_secret_expires_at": {
"description": "Time at which the client_secret will expire or 0 if it will not expire, according to the configured client secret lifetime. Its value is represented as number of seconds since the Unix epoch.",
"type": "integer"
},
"type": {
"description": "Client type.",
"type": "string",
"enum": [
"api_client",
"managed_client"
]
},
"data": {
"description": "Additional metadata, like agentType, hostname, etc...",
"type": "object"
},
"token_endpoint_auth_method": {
"description": "Explicit specified auth method.",
"type": "string",
"enum": [
"client_secret_basic",
"client_secret_post",
"none"
]
},
"created_at": {
"description": "Date and time when the client was created. This field can have a null value.",
"oneOf": [
{ "$ref": "#/definitions/dateTime" },
{ "type": "null" }
]
},
"created_by": {
"description": "ID of the user who registered the client.",
"type": "string"
},
"last_access_at": {
"description": "Date and time when client was used to issue token last time. This field can have a null value.",
"oneOf": [
{ "$ref": "#/definitions/dateTime" },
{ "type": "null" }
]
},
"last_access_from_ip": {
"description": "IP address from witch client was used to issue token last time. This field can have a null value.",
"type": ["string", "null"]
},
"status": {
"description": "Client status - either enabled or disabled. Disabled clients can no longer be used to receive Access Tokens.",
"type": "string",
"enum": [
"enabled",
"disabled"
]
},
"redirect_uris": {
"description": "List of possible redirect uris.",
"type": "array",
"items": {
"type": "string"
}
},
"origin_id": {
"description": "Client origin ID.",
"type": "string"
}
},
"required": [
"client_id",
"tenant_id",
"client_secret_expires_at",
"type",
"token_endpoint_auth_method",
"created_at",
"created_by",
"last_access_at",
"last_access_from_ip",
"status"
]
}
Example:
{
"client_id": "4557d5f5-7881-54f4-83a5-212f19d355c1",
"client_secret_expires_at": 0,
"type": "api_client",
"tenant_id": "0a305354-6efc-4b81-858d-2ae5dd1f08b1",
"data": {
"client_name": "backup_api_gateway"
},
"token_endpoint_auth_method": "client_secret_basic",
"created_at": "2023-07-06T16:26:33Z",
"created_by": "ab9ae709-0d00-521a-8be3-7891b1041e18",
"last_access_at": "2023-07-28T14:16:19Z",
"last_access_from_ip": "10.233.106.171",
"status": "enabled",
"redirect_uris": [
"/bc/api/gateway/cb",
"/bc/api/gateway/cb:ui"
]
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "ApplicationAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get /clients/{client_id}
Fetches a client by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- client_id: required(json)
Client ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"title": "Basic client schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"}
},
"properties": {
"client_id": {
"description": "The provisioned unique client identifier.",
"$ref": "#/definitions/uuid"
},
"tenant_id": {
"description": "Tenant ID for client to be associated.",
"$ref": "#/definitions/uuid"
},
"client_secret_expires_at": {
"description": "Time at which the client_secret will expire or 0 if it will not expire, according to the configured client secret lifetime. Its value is represented as number of seconds since the Unix epoch.",
"type": "integer"
},
"type": {
"description": "Client type.",
"type": "string",
"enum": [
"api_client",
"managed_client"
]
},
"data": {
"description": "Additional metadata, like agentType, hostname, etc...",
"type": "object"
},
"token_endpoint_auth_method": {
"description": "Explicit specified auth method.",
"type": "string",
"enum": [
"client_secret_basic",
"client_secret_post",
"none"
]
},
"created_at": {
"description": "Date and time when the client was created. This field can have a null value.",
"oneOf": [
{ "$ref": "#/definitions/dateTime" },
{ "type": "null" }
]
},
"created_by": {
"description": "ID of the user who registered the client.",
"type": "string"
},
"last_access_at": {
"description": "Date and time when client was used to issue token last time. This field can have a null value.",
"oneOf": [
{ "$ref": "#/definitions/dateTime" },
{ "type": "null" }
]
},
"last_access_from_ip": {
"description": "IP address from witch client was used to issue token last time. This field can have a null value.",
"type": ["string", "null"]
},
"status": {
"description": "Client status - either enabled or disabled. Disabled clients can no longer be used to receive Access Tokens.",
"type": "string",
"enum": [
"enabled",
"disabled"
]
},
"redirect_uris": {
"description": "List of possible redirect uris.",
"type": "array",
"items": {
"type": "string"
}
},
"origin_id": {
"description": "Client origin ID.",
"type": "string"
}
},
"required": [
"client_id",
"tenant_id",
"client_secret_expires_at",
"type",
"token_endpoint_auth_method",
"created_at",
"created_by",
"last_access_at",
"last_access_from_ip",
"status"
]
}
Example:
{
"client_id": "4557d5f5-7881-54f4-83a5-212f19d355c1",
"client_secret_expires_at": 0,
"type": "api_client",
"tenant_id": "0a305354-6efc-4b81-858d-2ae5dd1f08b1",
"data": {
"client_name": "backup_api_gateway"
},
"token_endpoint_auth_method": "client_secret_basic",
"created_at": "2023-07-06T16:26:33Z",
"created_by": "ab9ae709-0d00-521a-8be3-7891b1041e18",
"last_access_at": "2023-07-28T14:16:19Z",
"last_access_from_ip": "10.233.106.171",
"status": "enabled",
"redirect_uris": [
"/bc/api/gateway/cb",
"/bc/api/gateway/cb:ui"
]
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Endpoint for resetting secret of an OAuth 2.0 / OpenID Connect client.
post
Resets the client secret by client ID.
post /clients/{client_id}/reset_secret
Resets the client secret by client ID.
Secured by oauth2
Secured by session
Secured by basicAuth
URI Parameters
- client_id: required(json)
Client ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: any
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"title": "Post client result schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"}
},
"properties": {
"client_id": {
"description": "The provisioned unique client identifier.",
"$ref": "#/definitions/uuid"
},
"tenant_id": {
"description": "Tenant ID for client to be associated.",
"$ref": "#/definitions/uuid"
},
"client_secret_expires_at": {
"description": "Time at which the client_secret will expire or 0 if it will not expire, according to the configured client secret lifetime. Its value is represented as number of seconds since the Unix epoch.",
"type": "integer"
},
"type": {
"description": "Client type.",
"type": "string",
"enum": [
"api_client",
"managed_client"
]
},
"data": {
"description": "Additional metadata, like agentType, hostname, etc...",
"type": "object"
},
"token_endpoint_auth_method": {
"description": "Explicit specified auth method.",
"type": "string",
"enum": [
"client_secret_basic",
"client_secret_post",
"none"
]
},
"client_secret": {
"description": "Client secret.",
"type": "string"
},
"registration_access_token": {
"description": "Client registration access token.",
"type": "string"
},
"created_at": {
"description": "Creation date and time.",
"$ref": "#/definitions/dateTime"
},
"created_by": {
"description": "ID of the user who registered the client.",
"type": "string"
},
"status": {
"description": "Client status - either enabled or disabled. Disabled clients can no longer be used to receive Access Tokens.",
"type": "string",
"enum": [
"enabled",
"disabled"
]
},
"redirect_uris": {
"description": "List of possible redirect uris.",
"type": "array",
"items": {
"type": "string"
}
},
"origin_id": {
"description": "Client origin ID.",
"type": "string"
}
},
"required": [
"client_id",
"tenant_id",
"client_secret_expires_at",
"type",
"token_endpoint_auth_method",
"client_secret",
"registration_access_token",
"created_at",
"created_by",
"status"
]
}
Example:
{
"client_secret_expires_at": 0,
"token_endpoint_auth_method": "client_secret_basic",
"tenant_id": "48f86be5-c628-49c3-8575-62e78f54e4eb",
"data": {
"client_name": "Some application client",
"origin_dc_id": "ff7625c0-d649-445c-a2b3-9b59e66bfc2d"
},
"client_secret": "cfffe6f6271b4addbe90ca63236de581",
"registration_access_token": "94fe1f5e59b64bd69ad6754a34f37674",
"client_id": "3663410d-4b70-4860-860c-8db82bffab8e",
"created_at": "2019-08-24T01:23:15",
"created_by": "ab9d9f43-f9aa-4f83-9409-5547172daa27",
"type": "managed_client",
"status": "enabled",
"origin_id": "72403667-8e45-4dd9-bcbc-3e6047b98b3d"
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "ApplicationAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by session
Headers
- Cookie: required(string)
Example:
SESSION="c09fef6c-43ba-4e08-9c2b-fa81f6945ace"
HTTP status code 401
The request was denied due to an invalid session token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the current session token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by basicAuth
Headers
- Authorization: required(string - pattern: Basic [0-9a-zA-Z\-\._~+/]*=)
Used to send the base64-encoded "client_id:client_secret" credentials.
Example:
Basic QUJDMTIz=
HTTP status code 403
The request was denied due to the credentials having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/editions
get
Fetches a list of editions available on the platform.
get /editions
Fetches a list of editions available on the platform.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false,
"required": [
"items"
]
}Example:
{
"items": [
"standard",
"advanced",
"disaster_recovery"
]
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/identity_providers
Identity providers management.
get
Fetches a batch of identity providers.
post
Registers a new identity provider.
get /identity_providers
Fetches a batch of identity providers.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- uuids: required(string)
Comma-separated list of identity providers' UUIDs.
Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed,248c535a-0ebe-11e7-a80e-bbdaa1d60c7c
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"idp": {"$ref": "idp.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/idp"
}
}
},
"required": [
"items"
]
}
Example:
{
"items": [{
"id": "1abc15ae-5349-4bb8-9262-89c5de9e9a5d",
"owner_tenant_id": "84595658-c287-4752-a231-4a4245bdf7b8",
"domain": "example.com",
"idp_type": "oidc",
"address": "https://idp.example.com",
"oauth2_client_id": "3d80afb304c240aea694abffed0b77a0",
"oauth2_client_secret": "c4f3d0cfe6864223bebf6eae81ff95a2",
"forgot_password_url": "https://idp.example.com/forgot_password",
"change_password_url": "https://idp.example.com/change_password",
"redirect_logout_url": "https://idp.example.com/home",
"login_attribute": "example.login",
"automatic_url_redirection": true,
"version": 1
}]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post /identity_providers
Registers a new identity provider.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"url": {"$ref": "../_common/types/url.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"owner_tenant_id": {
"$ref": "#/definitions/uuid"
},
"domain": {
"type": "string"
},
"idp_type": {
"type": "string"
},
"address": {
"$ref": "#/definitions/url"
},
"oauth2_client_id": {
"type": "string"
},
"oauth2_client_secret": {
"type": "string"
},
"forgot_password_url": {
"type": "string"
},
"change_password_url": {
"type": "string"
},
"reset_password_url": {
"type": "string"
},
"redirect_logout_url": {
"type": "string"
},
"login_attribute": {
"type": "string"
},
"automatic_url_redirection": {
"type": "boolean"
},
"meta": {
"type": "string"
},
"external_id": {
"type": "string"
},
"vendor": {
"type": "string"
},
"scim_provisioner_user_id": {
"type": "string"
}
},
"required": ["owner_tenant_id", "domain", "idp_type"]
}
Example:
{
"owner_tenant_id": "84595658-c287-4752-a231-4a4245bdf7b8",
"domain": "example.com",
"idp_type": "oidc",
"address": "https://idp.example.com",
"oauth2_client_id": "3d80afb304c240aea694abffed0b77a0",
"oauth2_client_secret": "c4f3d0cfe6864223bebf6eae81ff95a2",
"forgot_password_url": "https://idp.example.com/forgot_password",
"change_password_url": "https://idp.example.com/change_password",
"redirect_logout_url": "https://idp.example.com/home",
"login_attribute": "example.login",
"automatic_url_redirection": true
}
HTTP status code 201
Identity provider was successfully registered.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"url": {"$ref": "../_common/types/url.json"}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of identity provider."
},
"owner_tenant_id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of owner tenant."
},
"domain": {
"type": "string",
"description": "Unique domain name of identity provider, e.g. 'example.com'."
},
"idp_type": {
"type": "string",
"enum": [
"internal",
"oidc"
]
},
"address": {
"$ref": "#/definitions/url",
"description": "IdP address, e.g. https://idp.example.com. For OIDC identity providers discovery endpoint is supposed to be located at <address>/.well-known/openid-configuration, e.g. https://idp.example.com/.well-known/openid-configuration."
},
"oauth2_client_id": {
"type": "string",
"description": "OAuth2 client ID. Required for OIDC identity providers."
},
"oauth2_client_secret": {
"type": "string",
"description": "OAuth2 client secret. Required for OIDC identity provider."
},
"forgot_password_url": {
"type": "string",
"description": "Forgot password URL (for not authenticated users)."
},
"change_password_url": {
"type": "string",
"description": "Change password URL (for authenticated users)."
},
"reset_password_url": {
"type": "string",
"description": "Reset Password URL (for administrators)."
},
"redirect_logout_url": {
"type": "string",
"description": "URL to redirect user to after logout."
},
"login_attribute": {
"type": "string",
"description": "Attribute statement required to login a user by support."
},
"automatic_url_redirection": {
"type": "boolean",
"description": "Determines whether redirection should be allowed at root handler."
},
"meta": {
"type": "string",
"description": "Metadata of third party identity provider."
},
"external_id": {
"type": "string",
"description": "Identifier at third party identity provider."
},
"saml_encryption_certificate": {
"type": "string",
"description": "Certificate for SAML assertion encryption."
},
"saml_logout_certificate": {
"type": "string",
"description": "Certificate for SAML response signing."
},
"version": {
"type": "integer",
"description": "Auto-incremented identity provider version."
},
"vendor": {
"type": "string",
"description": "Vendor of identity provider (e.g. OKTA, EntraID). Mandatory for SAML."
},
"scim_provisioner_user_id": {
"type": "string",
"description": "Identifier of SCIM provisioner user who will provision users for this IdP."
},
"saml_entityid": {
"type": "string",
"description": "The identifier is the audience of the SAML response."
}
},
"required": ["id", "owner_tenant_id", "domain", "idp_type", "version"]
}
Example:
{
"id": "1abc15ae-5349-4bb8-9262-89c5de9e9a5d",
"owner_tenant_id": "84595658-c287-4752-a231-4a4245bdf7b8",
"domain": "example.com",
"idp_type": "oidc",
"address": "https://idp.example.com",
"oauth2_client_id": "3d80afb304c240aea694abffed0b77a0",
"oauth2_client_secret": "c4f3d0cfe6864223bebf6eae81ff95a2",
"forgot_password_url": "https://idp.example.com/forgot_password",
"change_password_url": "https://idp.example.com/change_password",
"redirect_logout_url": "https://idp.example.com/home",
"login_attribute": "example.login",
"automatic_url_redirection": true,
"version": 1,
"vendor": "OKTA",
"scim_provisioner_user_id": "df931ba0-82c5-4a54-8054-859afe77dd11",
"saml_entityid": ""
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages a specific identity provider.
delete
Unregisters the identity provider by ID.
put
Updates an identity provider by ID.
get
Fetches an identity provider by ID.
delete /identity_providers/{idp_id}
Unregisters the identity provider by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
URI Parameters
- idp_id: required(json)
Identity provider ID (UUID)
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- version: required(integer)
Growing number of object internal version.
Example:
1559561146223
HTTP status code 204
Identity Provider was successfully unregistered
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /identity_providers/{idp_id}
Updates an identity provider by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
URI Parameters
- idp_id: required(json)
Identity provider ID (UUID)
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"url": {"$ref": "../_common/types/url.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"owner_tenant_id": {
"$ref": "#/definitions/uuid"
},
"domain": {
"type": "string"
},
"idp_type": {
"type": "string"
},
"address": {
"$ref": "#/definitions/url"
},
"oauth2_client_id": {
"type": "string"
},
"oauth2_client_secret": {
"type": "string"
},
"forgot_password_url": {
"type": "string"
},
"change_password_url": {
"type": "string"
},
"reset_password_url": {
"type": "string"
},
"redirect_logout_url": {
"type": "string"
},
"login_attribute": {
"type": "string"
},
"automatic_url_redirection": {
"type": "boolean"
},
"meta": {
"type": "string"
},
"external_id": {
"type": "string"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"vendor": {
"type": "string"
},
"scim_provisioner_user_id": {
"type": "string"
}
},
"required": ["version"]
}
Example:
{
"idp_type": "oidc",
"address": "https://idp.example.com",
"oauth2_client_id": "3d80afb304c240aea694abffed0b77a0",
"oauth2_client_secret": "c4f3d0cfe6864223bebf6eae81ff95a2",
"version": 1,
"vendor": "OKTA",
"scim_provisioner_user_id": "df931ba0-82c5-4a54-8054-859afe77dd11"
}
HTTP status code 200
Identity Provider was successfully updated
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"url": {"$ref": "../_common/types/url.json"}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of identity provider."
},
"owner_tenant_id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of owner tenant."
},
"domain": {
"type": "string",
"description": "Unique domain name of identity provider, e.g. 'example.com'."
},
"idp_type": {
"type": "string",
"enum": [
"internal",
"oidc"
]
},
"address": {
"$ref": "#/definitions/url",
"description": "IdP address, e.g. https://idp.example.com. For OIDC identity providers discovery endpoint is supposed to be located at <address>/.well-known/openid-configuration, e.g. https://idp.example.com/.well-known/openid-configuration."
},
"oauth2_client_id": {
"type": "string",
"description": "OAuth2 client ID. Required for OIDC identity providers."
},
"oauth2_client_secret": {
"type": "string",
"description": "OAuth2 client secret. Required for OIDC identity provider."
},
"forgot_password_url": {
"type": "string",
"description": "Forgot password URL (for not authenticated users)."
},
"change_password_url": {
"type": "string",
"description": "Change password URL (for authenticated users)."
},
"reset_password_url": {
"type": "string",
"description": "Reset Password URL (for administrators)."
},
"redirect_logout_url": {
"type": "string",
"description": "URL to redirect user to after logout."
},
"login_attribute": {
"type": "string",
"description": "Attribute statement required to login a user by support."
},
"automatic_url_redirection": {
"type": "boolean",
"description": "Determines whether redirection should be allowed at root handler."
},
"meta": {
"type": "string",
"description": "Metadata of third party identity provider."
},
"external_id": {
"type": "string",
"description": "Identifier at third party identity provider."
},
"saml_encryption_certificate": {
"type": "string",
"description": "Certificate for SAML assertion encryption."
},
"saml_logout_certificate": {
"type": "string",
"description": "Certificate for SAML response signing."
},
"version": {
"type": "integer",
"description": "Auto-incremented identity provider version."
},
"vendor": {
"type": "string",
"description": "Vendor of identity provider (e.g. OKTA, EntraID). Mandatory for SAML."
},
"scim_provisioner_user_id": {
"type": "string",
"description": "Identifier of SCIM provisioner user who will provision users for this IdP."
},
"saml_entityid": {
"type": "string",
"description": "The identifier is the audience of the SAML response."
}
},
"required": ["id", "owner_tenant_id", "domain", "idp_type", "version"]
}
Example:
{
"id": "1abc15ae-5349-4bb8-9262-89c5de9e9a5d",
"owner_tenant_id": "84595658-c287-4752-a231-4a4245bdf7b8",
"domain": "example.com",
"idp_type": "oidc",
"address": "https://idp.example.com",
"oauth2_client_id": "3d80afb304c240aea694abffed0b77a0",
"oauth2_client_secret": "c4f3d0cfe6864223bebf6eae81ff95a2",
"forgot_password_url": "https://idp.example.com/forgot_password",
"change_password_url": "https://idp.example.com/change_password",
"redirect_logout_url": "https://idp.example.com/home",
"login_attribute": "example.login",
"automatic_url_redirection": true,
"version": 1,
"vendor": "OKTA",
"scim_provisioner_user_id": "df931ba0-82c5-4a54-8054-859afe77dd11",
"saml_entityid": ""
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get /identity_providers/{idp_id}
Fetches an identity provider by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- idp_id: required(json)
Identity provider ID (UUID)
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"url": {"$ref": "../_common/types/url.json"}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of identity provider."
},
"owner_tenant_id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of owner tenant."
},
"domain": {
"type": "string",
"description": "Unique domain name of identity provider, e.g. 'example.com'."
},
"idp_type": {
"type": "string",
"enum": [
"internal",
"oidc"
]
},
"address": {
"$ref": "#/definitions/url",
"description": "IdP address, e.g. https://idp.example.com. For OIDC identity providers discovery endpoint is supposed to be located at <address>/.well-known/openid-configuration, e.g. https://idp.example.com/.well-known/openid-configuration."
},
"oauth2_client_id": {
"type": "string",
"description": "OAuth2 client ID. Required for OIDC identity providers."
},
"oauth2_client_secret": {
"type": "string",
"description": "OAuth2 client secret. Required for OIDC identity provider."
},
"forgot_password_url": {
"type": "string",
"description": "Forgot password URL (for not authenticated users)."
},
"change_password_url": {
"type": "string",
"description": "Change password URL (for authenticated users)."
},
"reset_password_url": {
"type": "string",
"description": "Reset Password URL (for administrators)."
},
"redirect_logout_url": {
"type": "string",
"description": "URL to redirect user to after logout."
},
"login_attribute": {
"type": "string",
"description": "Attribute statement required to login a user by support."
},
"automatic_url_redirection": {
"type": "boolean",
"description": "Determines whether redirection should be allowed at root handler."
},
"meta": {
"type": "string",
"description": "Metadata of third party identity provider."
},
"external_id": {
"type": "string",
"description": "Identifier at third party identity provider."
},
"saml_encryption_certificate": {
"type": "string",
"description": "Certificate for SAML assertion encryption."
},
"saml_logout_certificate": {
"type": "string",
"description": "Certificate for SAML response signing."
},
"version": {
"type": "integer",
"description": "Auto-incremented identity provider version."
},
"vendor": {
"type": "string",
"description": "Vendor of identity provider (e.g. OKTA, EntraID). Mandatory for SAML."
},
"scim_provisioner_user_id": {
"type": "string",
"description": "Identifier of SCIM provisioner user who will provision users for this IdP."
},
"saml_entityid": {
"type": "string",
"description": "The identifier is the audience of the SAML response."
}
},
"required": ["id", "owner_tenant_id", "domain", "idp_type", "version"]
}
Example:
{
"id": "1abc15ae-5349-4bb8-9262-89c5de9e9a5d",
"owner_tenant_id": "84595658-c287-4752-a231-4a4245bdf7b8",
"domain": "example.com",
"idp_type": "oidc",
"address": "https://idp.example.com",
"oauth2_client_id": "3d80afb304c240aea694abffed0b77a0",
"oauth2_client_secret": "c4f3d0cfe6864223bebf6eae81ff95a2",
"forgot_password_url": "https://idp.example.com/forgot_password",
"change_password_url": "https://idp.example.com/change_password",
"redirect_logout_url": "https://idp.example.com/home",
"login_attribute": "example.login",
"automatic_url_redirection": true,
"version": 1,
"vendor": "OKTA",
"scim_provisioner_user_id": "df931ba0-82c5-4a54-8054-859afe77dd11",
"saml_entityid": ""
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/idp
Authorization endpoints via identity providers.
get
OpenID Connect 1.0 authorization endpoint.
Performs authentication of the user. For more details, see https://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint.
get /idp/authorize
OpenID Connect 1.0 authorization endpoint.
Performs authentication of the user. For more details, see https://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint.
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- scope: required(string - pattern: ^openid(\s+[\w_]+)*$)
Must contain
openidand, optionally, other space-separated scopes. - response_type: required(code)
Corresponds to OpenID Connect 1.0 or OAuth 2.0 authorization flows. Our IdP currently supports only Authorization Code Flow.
- client_id: required(string)
OAuth 2.0 client identifier (UUID).
- redirect_uri: required(string)
Redirection URI to which the response will be sent.
- state: (string)
Opaque value that client can be used to maintain a state between the request and the response callback.
- prompt: (login)
Space-delimited, case-sensitive list of string values that specifies whether the IdP prompts the user for reauthentication and consent. Our IdP currently supports only
login. - id_token_hint: (string)
ID token previously issued by IdP being passed as a hint about the user current or past authenticated session.
- login_hint: (string)
Hint to the IdP server about the login identifier the user might use to log in.
- code_challenge: (string - pattern: ^[A-Za-z0-9\-\._~]{43,128}$)
A challenge derived from the code verifier, to be verified against during the token request.
The code verifier must be generated in accordance with RFC7636 Section 4.1.
The code challenge must be generated in accordance with RFC7636 Section 4.2.
- code_challenge_method: (one of plain, S256)
A transformation method that was used to derive the code challenge. If the client is capable of using
S256, it MUST useS256.Required if
code_challengewas provided.
HTTP status code 200
If non-silent authentication condition is detected (i.e. id_token_hint parameter is not present, or authenticated user session does not exist), the HTML page with login form is returned here.
Body
Media type: text/html
Type: any
Example:
<form method="post">
<input type="hidden" name="client_id" value="{client_id}">
<input type="hidden" name="redirect_url" value="{redirect_url}">
<input type="hidden" name="state" value="{state}">
User: <input name="username" type="text">
Password: <input name="password" type="password">
<input type="submit">
<form>HTTP status code 302
The user has been redirected to the URL specified in the redirect_uri query string parameter.
On successful silent authentication (in case id_token_hint parameter is present, or authenticated user session still exists), the result is passed in the code query string parameter of the redirect URI.
If an error occurred, it will be reported in the error query string parameter of the redirect URI. Possible error values: access_denied, invalid_request, invalid_scope, unsupported_response_type and unauthorized_client.
Our IdP currently supports not all of possible OpenID Connect 1.0 and OAuth2 error values.
Headers
- Location: required(string)
Example:
https://redirect_uri/?code=SplxlOBeZQQYbYS6WxSbIA&state=af0ifjsldkj
post
Requests an access token, an ID token and, optionally, a refresh token.
To additionally request a refresh token, refer to OpenID Connect Core 1.0 Section 11.
post /idp/token
Requests an access token, an ID token and, optionally, a refresh token.
To additionally request a refresh token, refer to OpenID Connect Core 1.0 Section 11.
Annotations
- roles_lib.x-tags
["public"]
Headers
- Authorization: (string - pattern: Basic [0-9a-zA-Z\-\._~+/]*=)
Used to send the base64-encoded "client_id:client_secret" credentials. May be required depending on the grant type and 'token_endpoint_auth_method'
Example:
Basic QUJDMTIz=
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- grant_type: required(one of password, md5_password, authorization_code, refresh_token, client_credentials, urn:ietf:params:oauth:grant-type:device_code, urn:ietf:params:oauth:grant-type:jwt-bearer)
The following authorization grant types are supported:
passwordgrant type implementation is in accordance with RFC6749 Section 4.3.md5_passwordgrant type is the same aspasswordgrant type, but password provided as MD5 hashsum.authorization_code,refresh_tokenandclient_credentialsgrant types implementation is in accordance with OpenID Connect Core 1.0 Section 3.1.3.authorization_codegrant type implementation also supports PKCE extension in accordance with RFC7636urn:ietf:params:oauth:grant-type:device_codegrant type implementation is in accordance with RFC8628.urn:ietf:params:oauth:grant-type:jwt-bearergrant type implementation is in accordance with RFC7523.
- client_id: (string)
OAuth 2.0 / OpenID Connect client's identifier (UUID).
Required for the
urn:ietf:params:oauth:grant-type:device_codegrant type.Required for
authorization_codeandclient_credentialsgrant types if the client was created withtoken_endpoint_auth_methodset toclient_secret_post. - client_secret: (string)
OAuth 2.0 / OpenID Connect clients secret.
Required for
authorization_codeandclient_credentialsgrant types if the client was created withtoken_endpoint_auth_methodset toclient_secret_post. - username: (string)
Required for the
passwordandmd5_passwordgrant types. - password: (string)
Required for the
passwordandmd5_passwordgrant types. - refresh_token: (string)
Required for the
refresh_tokengrant type. - code: (string)
Required for the
authorization_codegrant type. - scope: (string - pattern: ^[\w_]+(\s+[\w_]+)*$)
Not used for the
authorization_codegrant type. Optional for all other supported grant types. - assertion: (string)
Required for the
urn:ietf:params:oauth:grant-type:jwt-bearergrant type. - device_code: (string)
Required for the
urn:ietf:params:oauth:grant-type:device_codegrant type. - totp_code: (string)
Required for the
passwordgrant type with TOTP authentication. - code_verifier: (string - pattern: ^[A-Za-z0-9\-\._~]{43,128}$)
A cryptographically random string that is used to correlate the authorization request to the token request.
Required for the
authorization_codegrant type ifcode_challengewas provided during the authorization request. - token_version: (one of 2, 3)
The version of the token that the client expects to receive.
If not specified, the latest version of the token that suits the client will be issued. If the requested version is not supported, the request will fail with 400 Bad Request error.
Supported versions: 2, 3. Token version 2 contains
verfield in the payload section. Starting from version 3, the token containsverfield in both header and payload sections.
HTTP status code 200
Authentication was successful and the tokens were issued.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"access_token": {
"type": "string"
},
"token_type": {
"type": "string"
},
"expires_in": {
"type": "integer"
},
"expires_on": {
"type": "integer"
},
"id_token": {
"type": "string"
},
"refresh_token": {
"type": "string"
}
},
"required": ["access_token", "token_type", "id_token"]
}
Example:
{
"access_token": "nowhere_to_apply",
"token_type": "bearer",
"expires_in": 600,
"expires_on": 1388444763,
"id_token" : "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.....",
"refresh_token": "OhYc9oko5ej9"
}
HTTP status code 400
Failed authentication factors check and when redirect_uri form parameter is not defined.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"totp_setup_required",
"totp_required",
"invalid_totp",
"access_denied",
"invalid_request"
]
},
"error_description": {
"type": "string"
}
},
"required": [
"error",
"error_description"
]
}
Example:
{
"error": "invalid_request",
"error_description": "Invalid request"
}
HTTP status code 401
Failed authentication factors check and when redirect_uri form parameter is not defined.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"totp_setup_required",
"totp_required",
"invalid_totp",
"access_denied",
"invalid_request"
]
},
"error_description": {
"type": "string"
}
},
"required": [
"error",
"error_description"
]
}
Example:
{
"error": "totp_required",
"error_description": "TOTP code is required"
}
HTTP status code 403
Requested scope is not allowed.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"totp_setup_required",
"totp_required",
"invalid_totp",
"access_denied",
"invalid_request"
]
},
"error_description": {
"type": "string"
}
},
"required": [
"error",
"error_description"
]
}
Example:
{
"error": "access_denied",
"error_description": "Requested scope is not a subset of previously issued token's scope"
}
post
Revokes an access token and, if any, a refresh token in accordance with RFC7009.
Confidential clients must either follow Basic authentication scheme or provide credentials in the request body.
Public clients must provide client_id in the request body.
If access_token revocation is requested, the refresh token, if any, issued together with provided access token will also be revoked.
If refresh_token revocation is requested, the access token issued together with provided refresh token will also be revoked.
post /idp/revoke_token
Revokes an access token and, if any, a refresh token in accordance with RFC7009.
Confidential clients must either follow Basic authentication scheme or provide credentials in the request body.
Public clients must provide client_id in the request body.
If access_token revocation is requested, the refresh token, if any, issued together with provided access token will also be revoked.
If refresh_token revocation is requested, the access token issued together with provided refresh token will also be revoked.
Annotations
- roles_lib.x-tags
["public"]
Headers
- Authorization: (string - pattern: Basic [0-9a-zA-Z\-\._~+/]*=)
Used to send the base64-encoded "client_id:client_secret" credentials.
Example:
Basic QUJDMTIz=
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- token: required(string)
The token that the client wants to revoke.
- token_type_hint: (one of access_token, refresh_token)
A hint about the token type submitted for revocation.
- client_id: (string)
OAuth 2.0 / OpenID Connect client's identifier (UUID). Required for public clients.
- client_secret: (string)
OAuth 2.0 / OpenID Connect clients secret. Can be used by confidential clients for authentication.
HTTP status code 200
Authentication was successful and the token was revoked.
HTTP status code 400
Invalid request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_client",
"invalid_request",
"unsupported_token_type"
]
},
"error_description": {
"type": "string"
}
},
"required": [
"error",
"error_description"
]
}
Example:
{
"error": "unsupported_token_type",
"error_description": "Unsupported token type"
}
HTTP status code 401
Failed authentication factors check.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_client",
"invalid_request",
"unsupported_token_type"
]
},
"error_description": {
"type": "string"
}
},
"required": [
"error",
"error_description"
]
}
Example:
{
"error": "invalid_client",
"error_description": "Invalid client credentials"
}
post
Available in cloud version only and this method can be accessed only by OAuth 2.0 / OpenID Connect client.
Requests a one-time token for authentication on behalf of the specified user. Either user external ID or Acronis user login or Acronis user UUID can be supplied.
post /idp/ott
Available in cloud version only and this method can be accessed only by OAuth 2.0 / OpenID Connect client.
Requests a one-time token for authentication on behalf of the specified user. Either user external ID or Acronis user login or Acronis user UUID can be supplied.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::users_admin
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"ott_purpose": {"$ref": "../_common/types/ottPurpose.json"},
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"purpose": {
"$ref": "#/definitions/ott_purpose"
},
"login": {
"type": "string"
},
"external_id": {
"type": "string"
},
"user_id": {
"$ref": "#/definitions/uuid"
},
"audit_data": {
"type": "string",
"description": "An arbitrary optional text field that could be later used for auditing purposes."
}
},
"required": ["purpose"]
}
Example:
{
"login": "user@mail.org",
"purpose": "user_login",
"audit_data": "external system support department user ID"
}HTTP status code 200
One-time token was successfully issued.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"ott": {
"type": "string",
"description": "A base64-encoded one-time token."
}
},
"required": ["ott"]
}Example:
{
"ott": "dGhpcyBpcyB0ZXN0IG9uZS10aW1lIHRva2Vu"
}HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post
Authenticates to the platform using one-time token and provides the IdP session cookie.
Available in cloud version only.
post /idp/ott/login
Authenticates to the platform using one-time token and provides the IdP session cookie.
Available in cloud version only.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"ott": {
"type": "string"
}
},
"required": ["ott"]
}
Example:
{
"ott": "dGhpcyBpcyB0ZXN0IG9uZS10aW1lIHRva2Vu"
}
HTTP status code 200
Authentication with one-time token was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"contact": {"$ref": "../_common/contact/contact.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"business_types": {"$ref": "../_common/types/business_types.json"},
"userNotifications": {"$ref": "../_common/types/userNotifications.json"}
},
"type": "object",
"properties": {
"id": {
"description": "Unique identifier.",
"$ref": "#/definitions/uuid"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"tenant_id": {
"description": "ID of tenant this user belongs to.",
"$ref": "#/definitions/uuid"
},
"login": {
"type": "string",
"description": "User's login."
},
"contact": {
"$ref": "#/definitions/contact"
},
"activated": {
"type": "boolean",
"description": "Flag, indicates whether the user has been activated or not."
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the user is enabled or disabled."
},
"access_policies": {
"description": "Will be returned with all user access policies if query param `with_access_policies` is provided.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "../access_policies/accessPolicy.json"
}
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Date and time when user was created."
},
"updated_at": {
"$ref": "#/definitions/dateTime",
"description": "Last update timestamp, if user has just been created - then is equal to `created_at`, if user has just been deleted - then is equal to `deleted_at`."
},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
},
"language": {
"type": "string",
"description": "Preferred locale."
},
"idp_id": {
"$ref": "#/definitions/uuid",
"description": "Identity provider UUID."
},
"external_id": {
"type": "string",
"description": "User's ID in external identity provider (e.g. SID in AD)."
},
"origin_id": {
"type": "string",
"description": "User's origin ID, for example, ID of a Cyber Application responsible for creating this user."
},
"origin_external_id": {
"type": "string",
"description": "User's external origin ID."
},
"disable_after": {
"$ref": "#/definitions/dateTime",
"description": "Timestamp indicating when the user will be disabled."
},
"personal_tenant_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "UUID of user's personal tenant. This field can have a null value."
},
"business_types": {
"$ref": "#/definitions/business_types"
},
"notifications": {
"$ref": "#/definitions/userNotifications",
"_comment": "possible values are: [maintenance, quota, reports, backup_error, backup_warning, backup_info, backup_daily_report, backup_critical, device_control_warning, certificate_management_error, certificate_management_warning, certificate_management_info]"
},
"mfa_status": {
"type": "string",
"description": "Multi-factor authentication status of the user.",
"enum": [
"disabled",
"forcibly_disabled",
"setup_required",
"enabled"
]
},
"external_operation_status": {
"oneOf": [
{"type": "null"},
{
"type": "string",
"enum": [
"deleting",
"recovering"
]
}
],
"description": "Indicates if some external operation in progress for this user (his personal tenant)."
}
},
"required": [
"id",
"version",
"tenant_id",
"login",
"contact",
"activated",
"enabled",
"created_at",
"updated_at",
"deleted_at",
"language",
"business_types",
"notifications"
]
}
Example:
{
"id": "948efcf2-b740-4c40-bb2d-4e4a46adfd87",
"version": 2,
"tenant_id": "0ef03214-6e47-4e50-87f2-a5955ba6095c",
"login": "mylogin",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": [],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "111111",
"deleted_at": "2020-05-19T11:50:00"
},
"activated": true,
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"language": "ru",
"idp_id": "e6f73a28-ff2e-4728-8f78-49eb74b20fce",
"external_id": "S-1-5-21-917267712-1342860078-1792151419-500",
"personal_tenant_id": "2f8ad2e2-28f2-11e7-aad1-5ffe2ad47151",
"business_types": [],
"notifications": [
"maintenance",
"quota",
"reports",
"backup_error",
"backup_warning",
"backup_info",
"backup_daily_report",
"backup_critical",
"device_control_warning",
"certificate_management_error",
"certificate_management_warning",
"certificate_management_info"
],
"mfa_status": "setup_required",
"origin_id": "pillr.mdr",
"origin_external_id": "c66b1af2-2ac5-4764-8db6-97b054e7d27e",
"disable_after": "2017-06-22T18:25:16"
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post
Verifies the one-time token.
Available in cloud version only.
post /idp/ott/verify
Verifies the one-time token.
Available in cloud version only.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"ott": {
"type": "string"
}
},
"required": ["ott"]
}
Example:
{
"ott": "dGhpcyBpcyB0ZXN0IG9uZS10aW1lIHRva2Vu"
}
HTTP status code 200
The one-time token is valid.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"contact": {"$ref": "../_common/contact/contact.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"business_types": {"$ref": "../_common/types/business_types.json"},
"userNotifications": {"$ref": "../_common/types/userNotifications.json"}
},
"type": "object",
"properties": {
"id": {
"description": "Unique identifier.",
"$ref": "#/definitions/uuid"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"tenant_id": {
"description": "ID of tenant this user belongs to.",
"$ref": "#/definitions/uuid"
},
"login": {
"type": "string",
"description": "User's login."
},
"contact": {
"$ref": "#/definitions/contact"
},
"activated": {
"type": "boolean",
"description": "Flag, indicates whether the user has been activated or not."
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the user is enabled or disabled."
},
"access_policies": {
"description": "Will be returned with all user access policies if query param `with_access_policies` is provided.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "../access_policies/accessPolicy.json"
}
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Date and time when user was created."
},
"updated_at": {
"$ref": "#/definitions/dateTime",
"description": "Last update timestamp, if user has just been created - then is equal to `created_at`, if user has just been deleted - then is equal to `deleted_at`."
},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
},
"language": {
"type": "string",
"description": "Preferred locale."
},
"idp_id": {
"$ref": "#/definitions/uuid",
"description": "Identity provider UUID."
},
"external_id": {
"type": "string",
"description": "User's ID in external identity provider (e.g. SID in AD)."
},
"origin_id": {
"type": "string",
"description": "User's origin ID, for example, ID of a Cyber Application responsible for creating this user."
},
"origin_external_id": {
"type": "string",
"description": "User's external origin ID."
},
"disable_after": {
"$ref": "#/definitions/dateTime",
"description": "Timestamp indicating when the user will be disabled."
},
"personal_tenant_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "UUID of user's personal tenant. This field can have a null value."
},
"business_types": {
"$ref": "#/definitions/business_types"
},
"notifications": {
"$ref": "#/definitions/userNotifications",
"_comment": "possible values are: [maintenance, quota, reports, backup_error, backup_warning, backup_info, backup_daily_report, backup_critical, device_control_warning, certificate_management_error, certificate_management_warning, certificate_management_info]"
},
"mfa_status": {
"type": "string",
"description": "Multi-factor authentication status of the user.",
"enum": [
"disabled",
"forcibly_disabled",
"setup_required",
"enabled"
]
},
"external_operation_status": {
"oneOf": [
{"type": "null"},
{
"type": "string",
"enum": [
"deleting",
"recovering"
]
}
],
"description": "Indicates if some external operation in progress for this user (his personal tenant)."
}
},
"required": [
"id",
"version",
"tenant_id",
"login",
"contact",
"activated",
"enabled",
"created_at",
"updated_at",
"deleted_at",
"language",
"business_types",
"notifications"
]
}
Example:
{
"id": "948efcf2-b740-4c40-bb2d-4e4a46adfd87",
"version": 2,
"tenant_id": "0ef03214-6e47-4e50-87f2-a5955ba6095c",
"login": "mylogin",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": [],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "111111",
"deleted_at": "2020-05-19T11:50:00"
},
"activated": true,
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"language": "ru",
"idp_id": "e6f73a28-ff2e-4728-8f78-49eb74b20fce",
"external_id": "S-1-5-21-917267712-1342860078-1792151419-500",
"personal_tenant_id": "2f8ad2e2-28f2-11e7-aad1-5ffe2ad47151",
"business_types": [],
"notifications": [
"maintenance",
"quota",
"reports",
"backup_error",
"backup_warning",
"backup_info",
"backup_daily_report",
"backup_critical",
"device_control_warning",
"certificate_management_error",
"certificate_management_warning",
"certificate_management_info"
],
"mfa_status": "setup_required",
"origin_id": "pillr.mdr",
"origin_external_id": "c66b1af2-2ac5-4764-8db6-97b054e7d27e",
"disable_after": "2017-06-22T18:25:16"
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Fetches JSON Web Key Set (JWKS) that can be used to verify JSON Web Token (JWT) generated by the authorization server. For more details, see RFC7517.
get /idp/keys
Fetches JSON Web Key Set (JWKS) that can be used to verify JSON Web Token (JWT) generated by the authorization server. For more details, see RFC7517.
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"keys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"kty": {
"type": "string"
},
"use": {
"type": "string"
},
"kid": {
"type": "string"
},
"alg": {
"type": "string"
},
"n": {
"type": "string"
},
"e": {
"type": "string"
}
}
},
"required": ["kty", "use", "kid", "alg", "n", "e"]
}
},
"required": ["keys"]
}Example:
{
"keys": [
{
"use": "sig",
"kty": "RSA",
"kid": "bfd3151dabd8807f2b69b710464468027211b388",
"alg": "RS256",
"n": "2dn7plDtONN59FweignoZYojMSkpYFzWuIBWDResKZQVGuYl3aFGzfq31F0TkEwQtp2bC6vWpjn1M8DS8icuAllw-6CNlytU9XPSwlEdRdb4vM4N1TK7zPjijbkmKJ_K0uGwQGt2RpgJphkjmN9sWK_JscbxDk3i3Fz68Is6Gn0q9oU7X5H-4BDSnU_cjYvHwnICZloKQYebfjniWoy0Iejhw55i4Ri_yGB-5poR1oNckOKxKWs5nUZyIGuNbOQ_gcyKkLOimfACCQ3flIJ622NmCeSaaEbIoIyvbQO5-hOB3BnE7CN4z1Gtx29gB9uqzo11zkjUbUFB01NOCxZeiQ",
"e": "AQAB"
},
{
"use": "sig",
"kty": "RSA",
"kid": "d5b72a31b56e59247a5ec879184b5afce27fe8b1",
"alg": "RS256",
"n": "oYcpvbwteEHjfJv_PrLiHC-BSdiaNTctAiIgrY6C5Pb1NSif1_PdOPwg2CMVA9A9Ea_IPkNrgl7n9LY8ktHp0iUtm4LfqloVxnWxB1UVVPXD5pNCDYxN0I5BgO6Fbp4EMgvJ7UlJFIMlvfjMFD6-_dAiCjPksW9wGW_HgnXpvNWwPtvFibVsgLXEG83U3eS1qj9EuUJv_9PKTzKD6qQuoomd_AsgVrUkmu3CCE6dIvtmt3oDtEPZRDJ54bah6X3c9CIm5lr8SSDvYJR61bTHJoH5SJEPub8h-x1cxGDPE5eW96PsFrsB0AwynWbBftyV2NDO3HqA5jPBxdA8UWD2LQ",
"e": "AQAB"
},
{
"use": "sig",
"kty": "RSA",
"kid": "f7d782c8244cdbd03bc6723b0d920e81b7c36c34",
"alg": "RS256",
"n": "zdtRz91hxp4Ou5yRpe4jubt67eJybl1LPFJKDsWiHd7DYO4JKky_FWwQNSSj6M7LWf6bf9QQw7jSe_6oz37xRGMqNhtIbkwXNvhgeuNu0MOUp-nKZmojNa2txnW2-udmkVR9StMXb2D3xgNUlqslX7WKwoR2b8ypgB8RQBCU8zFzS8gRqnvMgedl5x8YKxpIMdpwEsX6qJ264B_FT9eerRDbr-_22S0FfSJNpF_xTtSa2KLiGTxEKvigvk22K_No1a8CPOSNb2ZfWewwBZmtMBy0xMlT_bs3mX6Mdg-pEGVmpriSik2BmGsNrwqiJHqyFPgqfQUqOM-NqAs6RGBpBw",
"e": "AQAB"
}
]
}Logout methods.
get
Performs a logout from the platform.
get /idp/logout
Performs a logout from the platform.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
User was successfully logged out.
Body
Media type: text/html
Type: any
Example:
<body onload="window.location.replace('/')">
<h5>Please wait...</h5>
<img src="https://cloud.example.com/fc/signout" />
<img src="https://cloud.example.com/signout" />
</body>
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Part of the device flow. Device authorization methods. For more details, see https://tools.ietf.org/html/draft-ietf-oauth-device-flow-07
post
Registers device codes and issues device and user codes.
post /idp/device_authorization
Registers device codes and issues device and user codes.
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/x-www-form-urlencoded
Type: object
Properties- client_id: required(string)
OAuth 2.0 / OpenID Connect client's identifier (UUID).
- display_name: (string)
Device display name (machine name, cluster ID, etc.).
- scope: required(array of string)
Scopes requested or authorized by the end user for the client.
HTTP status code 200
Device code successfully registered.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"properties": {
"device_code": {
"type": "string",
"description": "The device verification code."
},
"user_code": {
"type": "string",
"description": "The end-user verification code."
},
"verification_uri": {
"type": "string",
"description": "The end-user verification URI."
},
"verification_uri_complete": {
"type": "string",
"description": "A verification URI that includes the `user_code`."
},
"expires_in": {
"type": "integer",
"description": "The lifetime in seconds of the `device_code` and `user_code`."
},
"interval": {
"type": "integer",
"description": "The minimum interval time in seconds for the client polling requests to the token endpoint."
}
},
"required": ["device_code", "user_code", "verification_uri"]
}
Example:
{
"device_code": "qVqLLfXHCdFS7nT4M_WI-_hMGXaxzylUBhqZ-CXUPGd-g4B5CFQfgrrDFtHqxSX4",
"user_code": "RDRD-WNDB",
"verification_uri": "http://127.0.0.1:61827/abc",
"verification_uri_complete": "http://127.0.0.1:61827/abc?code=RDRD-WNDB",
"expires_in": 30,
"interval": 100
}Part of the device flow. Device authorization approval methods. For more details, see https://tools.ietf.org/html/draft-ietf-oauth-device-flow-07
get
Returns information about existing device authorization by the user code.
post
Approves existing device code. In case of setting tenant_uuid parameter in the request body or in the scope the current user and target tenant should satisfy next requirements: user should be a partner_admin, user should have RW access to the target tenant, target tenant should be personal, target tenant's owner should have protection_admin or backup_user roles.
get /idp/device_authorization/approval
Returns information about existing device authorization by the user code.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- code: required(string)
The end-user verification code.
- tenant_uuid: (json)
Personal tenant UUID for which the device code will be approved.
HTTP status code 200
Device authorization exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"properties": {
"client_id": {
"$ref": "#/definitions/uuid",
"description": "Public client ID."
},
"display_name": {
"type": "string",
"description": "Device display name (machine name, cluster ID, etc.)."
},
"scope": {
"type": "array",
"items": {"type": "string"},
"description": "Scopes requested or authorized by the end user for the client."
},
"tenant_id": {
"type": "string",
"description": "ID of the scoped tenant."
},
"tenant_name": {
"type": "string",
"description": "Name of the scoped tenant."
},
"is_current_tenant": {
"type": "boolean",
"description": "True if the tenant ID provided by ApiGW is in the path of the scoped tenant ID; false otherwise."
}
},
"required": ["client_id", "display_name", "scope"]
}
Example:
{
"client_id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"display_name": "Super Device",
"scope": ["urn:acronis.com:tenant-id::backup_agent_admin"],
"tenant_id":"822",
"tenant_name":"Ivan Ivanov",
"is_current_tenant":false
}HTTP status code 400
Invalid request parameters, device code expired or associated public client not found. Scoped tenant or its owner not satisfied the requirements.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"totp_setup_required",
"totp_required",
"invalid_totp",
"access_denied",
"invalid_request"
]
},
"error_description": {
"type": "string"
}
},
"required": [
"error",
"error_description"
]
}
Example:
{
"error": "invalid_request",
"error_description": "Invalid request"
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method. Current user has no access to the scoped tenant. User code is invalid or the related device code already deleted.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"totp_setup_required",
"totp_required",
"invalid_totp",
"access_denied",
"invalid_request"
]
},
"error_description": {
"type": "string"
}
},
"required": [
"error",
"error_description"
]
}
Example:
{
"error": "access_denied",
"error_description": "Requested scope is not a subset of previously issued token's scope"
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post /idp/device_authorization/approval
Approves existing device code. In case of setting tenant_uuid parameter in the request body or in the scope the current user and target tenant should satisfy next requirements: user should be a partner_admin, user should have RW access to the target tenant, target tenant should be personal, target tenant's owner should have protection_admin or backup_user roles.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema",
"type": "object",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"properties": {
"code": {
"type": "string",
"description": "The end-user verification code."
},
"tenant_uuid": {
"$ref": "#/definitions/uuid",
"description": "Personal tenant UUID for which the device code will be approved."
}
},
"required": ["code"]
}
Example:
{
"code": "RDRD-WNDB",
"tenant_uuid": "ab7869a9-f5e1-4faf-a56c-5a0ae866dc41"
}HTTP status code 204
Device code successfully approved.
HTTP status code 400
Invalid request parameters, device code expired or associated public client not found. Scoped tenant or its owner not satisfied the requirements.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"totp_setup_required",
"totp_required",
"invalid_totp",
"access_denied",
"invalid_request"
]
},
"error_description": {
"type": "string"
}
},
"required": [
"error",
"error_description"
]
}
Example:
{
"error": "invalid_request",
"error_description": "Invalid request"
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method. Current user has no access to the scoped tenant. User code is invalid or the related device code already deleted.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"totp_setup_required",
"totp_required",
"invalid_totp",
"access_denied",
"invalid_request"
]
},
"error_description": {
"type": "string"
}
},
"required": [
"error",
"error_description"
]
}
Example:
{
"error": "access_denied",
"error_description": "Requested scope is not a subset of previously issued token's scope"
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Fetches an HTML page that handles the login flow from external systems with one-time tokens and redirects users to the provided targetURI. One-time token and target URI must be passed via the following URL fragment parameters:
ott- a URL-encoded one-time token.targetURI- a URI the user should be redirected to on successful authentication.
Example: /idp/external-login#ott=dG9rZW4gd2l0aCBzYWZlIGVuY29kaW5n&targetURI=https://example.com/app.
get /idp/external-login
Fetches an HTML page that handles the login flow from external systems with one-time tokens and redirects users to the provided targetURI. One-time token and target URI must be passed via the following URL fragment parameters:
ott- a URL-encoded one-time token.targetURI- a URI the user should be redirected to on successful authentication.
Example: /idp/external-login#ott=dG9rZW4gd2l0aCBzYWZlIGVuY29kaW5n&targetURI=https://example.com/app.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: text/html
Type: any
Example:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
</head>
<script language="JavaScript">
window.onload = function() {
let params = window.location.hash.substr(1).split('&').reduce(function (result, item) {
let parts = item.split('=');
result[parts[0]] = parts[1];
return result;
}, {});
let xhr = new XMLHttpRequest();
xhr.open('post', '/api/2/idp/ott/login');
xhr.setRequestHeader("Content-type", "application/json");
xhr.setRequestHeader("X-Acronis-API", "1")
xhr.onreadystatechange = function () {
if (xhr.readyState === XMLHttpRequest.DONE && xhr.status === 200) {
window.location.replace(params['targetURI']);
}
};
xhr.send(JSON.stringify({ott: decodeURIComponent(params['ott'])}));
};
</script>
<body>
<h5>{{ _('Please wait...') }}</h5>
<img src="/mc/logout"/>
<img src="/bc/logout"/>
</body>
</html>Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/infra
Manages infrastructure components.
get
Fetches batch of infrastructure components.
post
Registers a new infrastructure component.
get /infra
Fetches batch of infrastructure components.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
- urn:acronis.com::account-server::tenant_viewer
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- uuids: required(string)
Comma-separated list of infrastructures' UUIDs.
Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed,248c535a-0ebe-11e7-a80e-bbdaa1d60c7c
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"infra": {"$ref": "infra.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/infra"
}
}
},
"required": [
"items"
]
}
Example:
{
"items": [
{
"id": "8fcd353b-0a40-40f2-9a55-ef8137d48800",
"owner_tenant_id": "0bb386ae-e66d-4e7b-84fb-cddcf60002de",
"location_id": "f79546d7-d051-4e19-96f3-4cc68c2c5575",
"platform_owned": true,
"name": "Infrastructure Component",
"url": "acronis+fes://storage20.corp.acronis.com:44445",
"capabilities": ["backup", "files_cloud"],
"content_url": "https://browse.storage20.corp.acronis.com/",
"content_mobile_url": "https://browse.storage20.corp.acronis.com/mobile/",
"backend_type": "azure",
"version": 3
},
{
"id": "3d1efc54-4e9a-4db1-abe6-7d2aee50cead",
"owner_tenant_id": "3f545595-0e77-4a34-9259-dab5256f9559",
"location_id": "bfdf24b0-5a72-49a8-a2bd-2fc7c085ff7b",
"platform_owned": false,
"name": "DR Infrastructure Component",
"url": "amazon+s3://dr.corp.acronis.com",
"capabilities": ["disaster_recovery"],
"backend_type": "acronis",
"version": 5
}
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post /infra
Registers a new infrastructure component.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"url": {"$ref": "../_common/types/url.json"},
"infraCap": {"$ref": "infraCap.json"},
"backendType": {
"$ref": "backendType.json",
"description": "This field can have a null value."
}
},
"type": "object",
"additionalProperties": false,
"properties": {
"owner_tenant_id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of tenant this infrastructure component belongs to."
},
"location_id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of location this infrastructure component belongs to."
},
"name": {
"type": "string",
"description": "Human-readable name of infrastructure component that will be displayed to the users."
},
"url": {
"$ref": "#/definitions/url",
"description": "URL for accessing infrastructure component."
},
"capabilities": {
"type": "array",
"description": "Capabilities of infrastructure component.",
"items": {
"$ref": "#/definitions/infraCap"
}
},
"content_url": {
"$ref": "#/definitions/url",
"description": "URL for accessing content of infrastructure component (only for components with `backup` capability)."
},
"content_mobile_url": {
"$ref": "#/definitions/url",
"description": "URL for accessing content of infrastructure component from mobile devices (only for components with `backup` capability)."
},
"backend_type": {
"$ref": "#/definitions/backendType"
}
},
"required": [
"owner_tenant_id",
"name",
"url",
"capabilities"
]
}
Example:
{
"owner_tenant_id": "0bb386ae-e66d-4e7b-84fb-cddcf60002de",
"location_id": "bfdf24b0-5a72-49a8-a2bd-2fc7c085ff7b",
"name": "Default Infrastructure Component",
"url": "acronis+fes://storage20.acronis.com:44445",
"capabilities": ["backup", "disaster_recovery"],
"content_url": "https://browse.storage20.acronis.com/",
"content_mobile_url": "https://browse.storage20.acronis.com/mobile/",
"backend_type": "azure"
}
HTTP status code 201
Infrastructure component was successfully registered.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"url": {"$ref": "../_common/types/url.json"},
"infraCap": {"$ref": "infraCap.json"},
"backendType": {
"$ref": "backendType.json",
"description": "This field can have a null value."
}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of infrastructure component."
},
"owner_tenant_id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of tenant this infrastructure component belongs to."
},
"location_id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of location this infrastructure component belongs to."
},
"platform_owned": {
"type": "boolean",
"description": "Is infra component owned by Platform."
},
"name": {
"type": "string",
"description": "Human-readable name of infrastructure component that will be displayed to the users."
},
"url": {
"$ref": "#/definitions/url",
"description": "URL for accessing infrastructure component."
},
"capabilities": {
"type": "array",
"description": "Capabilities of infrastructure component.",
"items": {
"$ref": "#/definitions/infraCap"
}
},
"content_url": {
"$ref": "#/definitions/url",
"description": "URL for accessing content of infrastructure component (only for components with `backup` capability)."
},
"content_mobile_url": {
"$ref": "#/definitions/url",
"description": "URL for accessing content of infrastructure component from mobile devices (only for components with `backup` capability)."
},
"backend_type": {
"$ref": "#/definitions/backendType"
},
"version": {
"type": "integer",
"description": "Auto-incremented infrastructure component version."
},
"readonly": {
"type": "boolean",
"description": "True if infra details are accessible in a limited way, e.g. infra is owned by some ancestor."
}
},
"required": [
"backend_type",
"id",
"owner_tenant_id",
"location_id",
"platform_owned",
"name",
"url",
"capabilities",
"version"
]
}
Example:
{
"id": "8fcd353b-0a40-40f2-9a55-ef8137d48800",
"owner_tenant_id": "0bb386ae-e66d-4e7b-84fb-cddcf60002de",
"location_id": "f79546d7-d051-4e19-96f3-4cc68c2c5575",
"platform_owned": true,
"name": "Infrastructure Component",
"url": "acronis+fes://storage20.corp.acronis.com:44445",
"capabilities": ["backup", "disaster_recovery"],
"content_url": "https://browse.storage20.corp.acronis.com/",
"content_mobile_url": "https://browse.storage20.corp.acronis.com/mobile/",
"backend_type": "azure",
"version": 3,
"readonly": false
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages infrastructure component.
delete
Unregisters infrastructure component.
put
Updates infrastructure component.
get
Fetches infrastructure component.
delete /infra/{infra_id}
Unregisters infrastructure component.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
URI Parameters
- infra_id: required(json)
Infrastructure component ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- force: (boolean)
If true, existing usage will be ignored in case there are no customer tenants having offering items associated with this infrastructure component turned on.
- version: required(integer)
Growing number of object internal version.
Example:
1559561146223
HTTP status code 204
Infrastructure component was successfully unregistered.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /infra/{infra_id}
Updates infrastructure component.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
URI Parameters
- infra_id: required(json)
Infrastructure component ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"url": {"$ref": "../_common/types/url.json"},
"infraCap": {"$ref": "infraCap.json"},
"backendType": {
"$ref": "backendType.json",
"description": "This field can have a null value."
}
},
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Human-readable name of infrastructure component that will be displayed to the users."
},
"location_id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of location this infrastructure component belongs to."
},
"url": {
"$ref": "#/definitions/url",
"description": "URL for accessing infrastructure component."
},
"capabilities": {
"type": "array",
"description": "Capabilities of infrastructure component.",
"items": {
"$ref": "#/definitions/infraCap"
}
},
"content_url": {
"$ref": "#/definitions/url",
"description": "URL for accessing content of infrastructure component (only for components with `backup` capability)."
},
"content_mobile_url": {
"$ref": "#/definitions/url",
"description": "URL for accessing content of infrastructure component from mobile devices (only for components with `backup` capability)."
},
"backend_type": {
"$ref": "#/definitions/backendType"
},
"version": {
"type": "integer",
"description": "Auto-incremented infrastructure component version."
}
},
"required": [
"version"
]
}
Example:
{
"name": "Infrastructure Component",
"url": "acronis+fes://storage20.corp.acronis.com:44445",
"capabilities": ["files_cloud"],
"content_url": "https://browse.storage20.corp.acronis.com/",
"content_mobile_url": "https://browse.storage20.corp.acronis.com/mobile/",
"backend_type": "azure",
"version": 10
}
HTTP status code 200
Infrastructure component was successfully updated.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"url": {"$ref": "../_common/types/url.json"},
"infraCap": {"$ref": "infraCap.json"},
"backendType": {
"$ref": "backendType.json",
"description": "This field can have a null value."
}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of infrastructure component."
},
"owner_tenant_id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of tenant this infrastructure component belongs to."
},
"location_id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of location this infrastructure component belongs to."
},
"platform_owned": {
"type": "boolean",
"description": "Is infra component owned by Platform."
},
"name": {
"type": "string",
"description": "Human-readable name of infrastructure component that will be displayed to the users."
},
"url": {
"$ref": "#/definitions/url",
"description": "URL for accessing infrastructure component."
},
"capabilities": {
"type": "array",
"description": "Capabilities of infrastructure component.",
"items": {
"$ref": "#/definitions/infraCap"
}
},
"content_url": {
"$ref": "#/definitions/url",
"description": "URL for accessing content of infrastructure component (only for components with `backup` capability)."
},
"content_mobile_url": {
"$ref": "#/definitions/url",
"description": "URL for accessing content of infrastructure component from mobile devices (only for components with `backup` capability)."
},
"backend_type": {
"$ref": "#/definitions/backendType"
},
"version": {
"type": "integer",
"description": "Auto-incremented infrastructure component version."
},
"readonly": {
"type": "boolean",
"description": "True if infra details are accessible in a limited way, e.g. infra is owned by some ancestor."
}
},
"required": [
"backend_type",
"id",
"owner_tenant_id",
"location_id",
"platform_owned",
"name",
"url",
"capabilities",
"version"
]
}
Example:
{
"id": "8fcd353b-0a40-40f2-9a55-ef8137d48800",
"owner_tenant_id": "0bb386ae-e66d-4e7b-84fb-cddcf60002de",
"location_id": "f79546d7-d051-4e19-96f3-4cc68c2c5575",
"platform_owned": true,
"name": "Infrastructure Component",
"url": "acronis+fes://storage20.corp.acronis.com:44445",
"capabilities": ["backup", "disaster_recovery"],
"content_url": "https://browse.storage20.corp.acronis.com/",
"content_mobile_url": "https://browse.storage20.corp.acronis.com/mobile/",
"backend_type": "azure",
"version": 3,
"readonly": false
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get /infra/{infra_id}
Fetches infrastructure component.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- infra_id: required(json)
Infrastructure component ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"url": {"$ref": "../_common/types/url.json"},
"infraCap": {"$ref": "infraCap.json"},
"backendType": {
"$ref": "backendType.json",
"description": "This field can have a null value."
}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of infrastructure component."
},
"owner_tenant_id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of tenant this infrastructure component belongs to."
},
"location_id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of location this infrastructure component belongs to."
},
"platform_owned": {
"type": "boolean",
"description": "Is infra component owned by Platform."
},
"name": {
"type": "string",
"description": "Human-readable name of infrastructure component that will be displayed to the users."
},
"url": {
"$ref": "#/definitions/url",
"description": "URL for accessing infrastructure component."
},
"capabilities": {
"type": "array",
"description": "Capabilities of infrastructure component.",
"items": {
"$ref": "#/definitions/infraCap"
}
},
"content_url": {
"$ref": "#/definitions/url",
"description": "URL for accessing content of infrastructure component (only for components with `backup` capability)."
},
"content_mobile_url": {
"$ref": "#/definitions/url",
"description": "URL for accessing content of infrastructure component from mobile devices (only for components with `backup` capability)."
},
"backend_type": {
"$ref": "#/definitions/backendType"
},
"version": {
"type": "integer",
"description": "Auto-incremented infrastructure component version."
},
"readonly": {
"type": "boolean",
"description": "True if infra details are accessible in a limited way, e.g. infra is owned by some ancestor."
}
},
"required": [
"backend_type",
"id",
"owner_tenant_id",
"location_id",
"platform_owned",
"name",
"url",
"capabilities",
"version"
]
}
Example:
{
"id": "8fcd353b-0a40-40f2-9a55-ef8137d48800",
"owner_tenant_id": "0bb386ae-e66d-4e7b-84fb-cddcf60002de",
"location_id": "f79546d7-d051-4e19-96f3-4cc68c2c5575",
"platform_owned": true,
"name": "Infrastructure Component",
"url": "acronis+fes://storage20.corp.acronis.com:44445",
"capabilities": ["backup", "disaster_recovery"],
"content_url": "https://browse.storage20.corp.acronis.com/",
"content_mobile_url": "https://browse.storage20.corp.acronis.com/mobile/",
"backend_type": "azure",
"version": 3,
"readonly": false
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/locations
Manages infrastructures locations.
get
Fetches a batch of infrastructure locations.
post
Creates a new infrastructures location.
get /locations
Fetches a batch of infrastructure locations.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- uuids: required(string)
Comma-separated list of infrastructures locations' UUIDs.
Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed,248c535a-0ebe-11e7-a80e-bbdaa1d60c7c
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"location": {"$ref": "location.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/location"
}
}
},
"required": [
"items"
]
}
Example:
{
"items": [
{
"id": "8fcd353b-0a40-40f2-9a55-ef8137d48800",
"owner_tenant_id": "0bb386ae-e66d-4e7b-84fb-cddcf60002de",
"platform_owned": true,
"name": "Capetown Infrastructure",
"version": 3,
"readonly": false
},
{
"id": "3d1efc54-4e9a-4db1-abe6-7d2aee50cead",
"owner_tenant_id": "0bb386ae-e66d-4e7b-84fb-cddcf60002de",
"platform_owned": false,
"name": "Singapore Infrastructure",
"version": 5,
"readonly": false
}
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post /locations
Creates a new infrastructures location.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"owner_tenant_id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of tenant this infrastructure location belongs to."
},
"name": {
"type": "string",
"description": "Human-readable name of infrastructure location that will be displayed to the users."
}
},
"required": [
"owner_tenant_id",
"name"
]
}
Example:
{
"owner_tenant_id": "0bb386ae-e66d-4e7b-84fb-cddcf60002de",
"name": "Boston Infrastructure"
}
HTTP status code 201
Infrastructure location was successfully created.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of infrastructure location."
},
"owner_tenant_id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of tenant this infrastructure location belongs to."
},
"platform_owned": {
"type": "boolean",
"description": "Is infra location owned by Platform."
},
"name": {
"type": "string",
"description": "Human-readable name of infrastructure location that will be displayed to the users."
},
"version": {
"type": "integer",
"description": "Auto-incremented infrastructure location version."
},
"readonly": {
"type": "boolean",
"description": "True if location details are accessible in a limited way, e.g. location is owned by some ancestor."
}
},
"required": [
"id",
"owner_tenant_id",
"platform_owned",
"name",
"version"
]
}
Example:
{
"id": "8fcd353b-0a40-40f2-9a55-ef8137d48800",
"owner_tenant_id": "0bb386ae-e66d-4e7b-84fb-cddcf60002de",
"platform_owned": true,
"name": "Boston Infrastructure",
"version": 3,
"readonly": false
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages infrastructure location.
delete
Deletes an infrastructure location by ID.
put
Updates an infrastructure location by ID.
get
Fetches an infrastructure location by ID.
delete /locations/{location_id}
Deletes an infrastructure location by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
URI Parameters
- location_id: required(json)
Infrastructures location ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- version: required(integer)
Growing number of object internal version.
Example:
1559561146223
HTTP status code 204
Infrastructure location was successfully removed.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /locations/{location_id}
Updates an infrastructure location by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
URI Parameters
- location_id: required(json)
Infrastructures location ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Human-readable name of infrastructure location that will be displayed to the users."
},
"version": {
"type": "integer",
"description": "Auto-incremented infrastructure location version."
}
},
"required": [
"name",
"version"
]
}
Example:
{
"name": "Boston Infrastructure",
"version": 10
}
HTTP status code 200
Infrastructure location was successfully updated.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of infrastructure location."
},
"owner_tenant_id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of tenant this infrastructure location belongs to."
},
"platform_owned": {
"type": "boolean",
"description": "Is infra location owned by Platform."
},
"name": {
"type": "string",
"description": "Human-readable name of infrastructure location that will be displayed to the users."
},
"version": {
"type": "integer",
"description": "Auto-incremented infrastructure location version."
},
"readonly": {
"type": "boolean",
"description": "True if location details are accessible in a limited way, e.g. location is owned by some ancestor."
}
},
"required": [
"id",
"owner_tenant_id",
"platform_owned",
"name",
"version"
]
}
Example:
{
"id": "8fcd353b-0a40-40f2-9a55-ef8137d48800",
"owner_tenant_id": "0bb386ae-e66d-4e7b-84fb-cddcf60002de",
"platform_owned": true,
"name": "Boston Infrastructure",
"version": 3,
"readonly": false
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get /locations/{location_id}
Fetches an infrastructure location by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- location_id: required(json)
Infrastructures location ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of infrastructure location."
},
"owner_tenant_id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier of tenant this infrastructure location belongs to."
},
"platform_owned": {
"type": "boolean",
"description": "Is infra location owned by Platform."
},
"name": {
"type": "string",
"description": "Human-readable name of infrastructure location that will be displayed to the users."
},
"version": {
"type": "integer",
"description": "Auto-incremented infrastructure location version."
},
"readonly": {
"type": "boolean",
"description": "True if location details are accessible in a limited way, e.g. location is owned by some ancestor."
}
},
"required": [
"id",
"owner_tenant_id",
"platform_owned",
"name",
"version"
]
}
Example:
{
"id": "8fcd353b-0a40-40f2-9a55-ef8137d48800",
"owner_tenant_id": "0bb386ae-e66d-4e7b-84fb-cddcf60002de",
"platform_owned": true,
"name": "Boston Infrastructure",
"version": 3,
"readonly": false
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages infrastructure components of the provided location.
get
Fetches batch of infrastructure components of the provided location.
get /locations/{location_id}/infra
Fetches batch of infrastructure components of the provided location.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- location_id: required(json)
Infrastructures location ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"properties": {
"infras": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
}
}
}
}
Example:
{
"infras": [
"d9fd4cc3-4309-40a2-bd79-88da24a1c99d",
"7068976a-22c0-476e-ae3b-5f0469981ff1"
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/logic
Logical values management.
get
Fetches a list of supported languages.
get /logic/languages
Fetches a list of supported languages.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"type": "array",
"description": "Languages GET response body.",
"items": {
"properties": {
"code": {
"type": "string",
"description": "ISO code of language."
}
},
"type": "object"
},
"$schema": "http://json-schema.org/draft-04/schema"
}
Example:
[
{
"code": "en"
}
]Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Fetches a list of available color schemes.
get /logic/color_schemes
Fetches a list of available color schemes.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"type": "array",
"description": "Available schemes list.",
"items": {
"type": "string",
"description": "Scheme identifier."
},
"$schema": "http://json-schema.org/draft-04/schema"
}
Example:
[
"blue_and_yellow",
"dark_and_light_blue",
"deep_sky_blue",
"default",
"green",
"light_blue",
"magenta",
"orange",
"purple",
"red",
"red_fire_brick",
"scheme_2",
"scheme_3",
"scheme_4",
"scheme_5",
"scheme_7",
"scheme_8",
"yellow"
]
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/offering_items
Reference endpoints for offering items.
get
Fetches a batch of offering items.
get /offering_items
Fetches a batch of offering items.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
- urn:acronis.com::account-server::tenant_viewer
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- editions: (string)
A filter by comma-separated list of editions.
Example:
standard,advanced,disaster_recovery
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"offeringItemRefOutput": {
"$ref": "offeringItemRefOutput.json"
}
},
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/offeringItemRefOutput"
}
}
},
"required": ["items"]
}
Example:
{
"items": [
{
"name": "vms",
"edition": "standard",
"usage_name": "vms"
},
{
"name": "dre_mobiles",
"edition": "disaster_recovery",
"usage_name": "mobiles"
},
{
"name": "local_storage",
"edition": null,
"usage_name": "local_storage"
},
{
"name": "adv_storage",
"edition": "advanced",
"usage_name": "storage"
}
]
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/registration_tokens
Manages the registration tokens. Registration tokens can be used to register agents with predefined access scope in unattended registration flow (ex. mass deployment).
This endpoint is available on /bc/api/account_server, without /api/2 prefix.
get
DEPRECATED. Use /api/2/tenants/{tenant_id}/registration_tokens.
Fetches a list of registration tokens.
post
DEPRECATED. Use /api/2/tenants/
Creates a registration token.
get /registration_tokens
DEPRECATED. Use /api/2/tenants/{tenant_id}/registration_tokens.
Fetches a list of registration tokens.
Secured by oauth2
Secured by session
Secured by basicAuth
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"registrationToken": { "$ref": "registrationToken.json" }
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/registrationToken"
}
}
},
"required": [
"items"
]
}
Example:
{
"items": [
{
"id": 2,
"token": "27F9-5234-41C3",
"tenant_id": "11",
"tenant_uuid": "4b07e4a1-a49b-4d4e-b8f2-253f1fef98ad",
"created_at": "2022-04-02T18:46:45Z",
"expires_at": "2022-04-05T18:46:45Z",
"scopes": [
"urn:acronis.com:tenant-id:734fe814-748a-41cb-8a94-60e18fb3c442:backup_agent_admin",
"urn:acronis.com::policy_management:4b07e4a1-a49b-4d4e-b8f2-253f1fef98ad|10858a46-db9b-4725-aa60-fff6252841fd:apply_revoke"
]
},
{
"id": 3,
"token": "F8CA-2DD1-41F1",
"tenant_id": "1363521",
"tenant_uuid": "00bc0d4a-9879-40bf-823a-77c01b197dc1",
"created_at": "2022-04-02T18:57:46Z",
"expires_at": "2022-04-05T18:57:46Z",
"scopes": [
"urn:acronis.com:tenant-id:1e3d306e-85ad-454c-b4f6-2bd73c83b9a1:backup_agent_admin"
]
}
]
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by session
Headers
- Cookie: required(string)
Example:
SESSION="c09fef6c-43ba-4e08-9c2b-fa81f6945ace"
HTTP status code 401
The request was denied due to an invalid session token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the current session token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by basicAuth
Headers
- Authorization: required(string - pattern: Basic [0-9a-zA-Z\-\._~+/]*=)
Used to send the base64-encoded "client_id:client_secret" credentials.
Example:
Basic QUJDMTIz=
HTTP status code 403
The request was denied due to the credentials having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post /registration_tokens
DEPRECATED. Use /api/2/tenants/
Creates a registration token.
Secured by oauth2
Secured by session
Secured by basicAuth
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"tenant_id": {
"description": "UUID of the resource owner tenant. If `tenant_id` is not specified, it is obtained from the current user session.",
"$ref": "#/definitions/uuid"
},
"expires_in": {
"description": "Token expiration time in seconds. Should be less than or equal to one year.",
"type": "integer"
},
"scopes": {
"description": "Access scopes that are applied to the registered resource. The following access scope patterns are available:\n- `urn:acronis.com:tenant-id:{personal_tenant_id}:backup_agent_admin` - binds the resource to the user by personal tenant ID specified in `{personal_tenant_id}`.\n- `urn:acronis.com::policy_management:{tenant_id}|{policy_id}:apply_revoke` - applies a protection plan to a resource by policy ID specified in `{policy_id}` from a resource owner tenant specified in `{tenant_id}`.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"expires_in",
"scopes"
]
}
Example:
{
"tenant_id": "72acaf6a-b15a-11e6-80f5-76304dec7eb7",
"expires_in": 3600,
"scopes": [
"urn:acronis.com:tenant-id:734fe814-748a-41cb-8a94-60e18fb3c442:backup_agent_admin"
]
}
HTTP status code 201
Registration token was successfully created.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Initial registration token unique identifier.",
"type": "integer"
},
"token": {
"description": "Initial registration token.",
"type": "string",
"pattern": "[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}"
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Date and time when initial registration token was created."
},
"expires_at": {
"$ref": "#/definitions/dateTime",
"description": "Date and time when initial registration token will expire."
},
"tenant_id": {
"description": "Numeric identifier of the resource owner tenant.",
"type": "string",
"pattern": "\\d+"
},
"tenant_uuid": {
"description": "UUID of the resource owner tenant.",
"$ref": "#/definitions/uuid"
},
"scopes": {
"description": "Access scopes that are applied to the registered resource. The following access scope patterns are available:\n- `urn:acronis.com:tenant-id:{personal_tenant_id}:backup_agent_admin` - binds the resource to the user by personal tenant ID specified in `{personal_tenant_id}`.\n- `urn:acronis.com::policy_management:{tenant_id}|{policy_id}:apply_revoke` - applies a protection plan to a resource by policy ID specified in `{policy_id}` from a resource owner tenant specified in `{tenant_id}`.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["id", "token", "created_at", "expires_at", "tenant_id", "scopes"]
}
Example:
{
"id": 2,
"token": "27F9-5234-41C3",
"tenant_id": "11",
"tenant_uuid": "4b07e4a1-a49b-4d4e-b8f2-253f1fef98ad",
"created_at": "2022-04-02T18:46:45Z",
"expires_at": "2022-04-05T18:46:45Z",
"scopes": [
"urn:acronis.com:tenant-id:734fe814-748a-41cb-8a94-60e18fb3c442:backup_agent_admin",
"urn:acronis.com::policy_management:4b07e4a1-a49b-4d4e-b8f2-253f1fef98ad|10858a46-db9b-4725-aa60-fff6252841fd:apply_revoke"
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by session
Headers
- Cookie: required(string)
Example:
SESSION="c09fef6c-43ba-4e08-9c2b-fa81f6945ace"
HTTP status code 401
The request was denied due to an invalid session token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the current session token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by basicAuth
Headers
- Authorization: required(string - pattern: Basic [0-9a-zA-Z\-\._~+/]*=)
Used to send the base64-encoded "client_id:client_secret" credentials.
Example:
Basic QUJDMTIz=
HTTP status code 403
The request was denied due to the credentials having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages a specific registration token.
Available with /api/2 prefix.
DEPRECATED. Available with /bc/api/account_server prefix.
delete
Deletes a registration token by ID.
delete /registration_tokens/{token_id}
Deletes a registration token by ID.
Secured by oauth2
Secured by session
Secured by basicAuth
URI Parameters
- token_id: required(json)
Registration Token ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 204
Registration token was removed.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by session
Headers
- Cookie: required(string)
Example:
SESSION="c09fef6c-43ba-4e08-9c2b-fa81f6945ace"
HTTP status code 401
The request was denied due to an invalid session token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the current session token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by basicAuth
Headers
- Authorization: required(string - pattern: Basic [0-9a-zA-Z\-\._~+/]*=)
Used to send the base64-encoded "client_id:client_secret" credentials.
Example:
Basic QUJDMTIz=
HTTP status code 403
The request was denied due to the credentials having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/reports
Manages usage reports.
post
Creates a new usage report.
post /reports
Creates a new usage report.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"date": {"$ref": "../_common/types/date.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"recipients": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
},
"description": "IDs of subscribed users."
},
"result_action": {
"type": "string",
"enum": [
"save",
"send"
],
"description": "What to do with report."
},
"parameters": {
"type": "object",
"properties": {
"tenant_id": {
"description": "ID of the tenant that will be the subject of this report.",
"$ref": "#/definitions/uuid"
},
"level": {
"type": "string",
"enum": [
"itself",
"direct_partners",
"all_partners",
"all_customers",
"accounts"
],
"description": "Level of report detail."
},
"kind": {
"type": "string",
"enum": [
"usage_daily",
"usage_summary",
"usage_current",
"usage_breakdown"
],
"description": "Kind of report."
},
"formats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"csv",
"html",
"json_v1",
"csv_v2_0",
"json_v2_0"
]
},
"description": "Report formats."
},
"period": {
"description": "Report period.",
"type": "object",
"properties": {
"start": {
"$ref": "#/definitions/date",
"description": "Starting date of the report period."
},
"end": {
"$ref": "#/definitions/date",
"description": "Ending date of the report period."
}
},
"required": [
"start",
"end"
]
},
"hide_zero_usage": {
"type": "boolean",
"description": "Hide metrics with zero usage in report."
},
"show_skus": {
"type": "boolean",
"description": "Show SKU-related fields in report."
}
},
"required": [
"tenant_id",
"kind",
"level"
]
},
"schedule": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Flag indicating whether the report is enabled (scheduled reports only)."
},
"type": {
"type": "string",
"enum": [
"once",
"monthly"
],
"description": "Type of report schedule."
}
},
"required": [
"type"
]
},
"generation_date": {
"$ref": "#/definitions/date",
"description": "Date when the report should be generated (only one-time reports)."
}
},
"required": [
"recipients",
"parameters",
"schedule",
"result_action"
]
}
Example:
{
"recipients": [
"ca451758-b48a-45d9-9ae6-8f1059f67619",
"ab00e527-219b-481b-b01b-311b5be0ed3c"
],
"parameters": {
"kind": "usage_summary",
"tenant_id": "2a91a14d-ffd3-4ac1-9b4d-3990162c5acc",
"level": "accounts",
"period": {
"start": "2017-05-01",
"end": "2017-05-07"
},
"formats": ["csv", "json_v1", "csv_v2_0", "json_v2_0"],
"hide_zero_usage": true,
"show_skus": false
},
"schedule": {
"type": "once"
},
"generation_date": "2017-05-08",
"result_action": "send"
}
HTTP status code 200
Usage report was successfully created
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"date": {"$ref": "../_common/types/date.json"}
},
"type": "object",
"properties": {
"id": {
"description": "Unique identifier for this configured report.",
"$ref": "#/definitions/uuid"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"result_action": {
"type": "string",
"enum": [
"save",
"send"
],
"description": "What to do with report."
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
},
"description": "IDs of subscribed users."
},
"parameters": {
"type": "object",
"properties": {
"tenant_id": {
"description": "ID of the tenant that will be the subject of this report.",
"$ref": "#/definitions/uuid"
},
"level": {
"type": "string",
"enum": [
"itself",
"direct_partners",
"all_partners",
"all_customers",
"accounts"
],
"description": "Level of report detail."
},
"formats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"csv",
"html",
"json_v1",
"csv_v2_0"
]
},
"description": "Report formats."
},
"kind": {
"type": "string",
"enum": [
"usage_daily",
"usage_summary",
"usage_current",
"usage_breakdown"
],
"description": "Kind of report."
},
"period": {
"description": "Report period.",
"type": "object",
"properties": {
"start": {
"$ref": "#/definitions/date",
"description": "Starting date of the report period."
},
"end": {
"$ref": "#/definitions/date",
"description": "Ending date of the report period."
}
},
"required": [
"start",
"end"
]
},
"hide_zero_usage": {
"type": "boolean",
"description": "Hide metrics with zero usage in report."
},
"show_skus": {
"type": "boolean",
"description": "Show SKU-related fields in report."
}
},
"required": [
"tenant_id",
"kind",
"level",
"period",
"formats"
]
},
"schedule": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Flag indicating whether the report is enabled (scheduled reports only)."
},
"type": {
"type": "string",
"enum": [
"once",
"monthly"
],
"description": "Type of report schedule."
}
},
"required": [
"enabled",
"type"
]
},
"generation_date": {
"$ref": "#/definitions/date",
"description": "Date when the report should be generated."
}
},
"required": [
"id",
"version",
"recipients",
"parameters",
"generation_date",
"schedule",
"result_action"
]
}
Example:
{
"id": "20dffb36-d77b-45c6-b2fa-39276e98d5fc",
"recipients": [
"ca451758-b48a-45d9-9ae6-8f1059f67619",
"ab00e527-219b-481b-b01b-311b5be0ed3c"
],
"version": 2,
"parameters": {
"kind": "usage_summary",
"tenant_id": "2a91a14d-ffd3-4ac1-9b4d-3990162c5acc",
"level": "accounts",
"period": {
"start": "2017-05-01",
"end": "2017-05-07"
},
"formats": ["csv"],
"hide_zero_usage": true,
"show_skus": false
},
"schedule": {
"type": "once",
"enabled": true
},
"result_action": "send",
"generation_date": "2017-05-08"
}
HTTP status code 400
Usage history is not ready and shouldn't be ready yet (from 1 to 6 am).
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": 400,
"message": "Bad Request",
"details": {
"info": "History aggregation is in progress for specified date interval",
"addition": []
},
"domain": "PlatformReportingService",
"context": {}
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
HTTP status code 500
Usage history is not ready but should be available already (after 6 am).
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": 500,
"message": "Internal Server Error",
"details": {
"info": "History aggregation was not finished in time",
"addition": []
},
"domain": "PlatformReportingService",
"context": {}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages the parameters of the specific usage report.
delete
Deletes a usage report by ID.
put
Updates a usage report configuration. Only scheduled reports can be updated.
get
Fetches a usage report configuration.
delete /reports/{report_id}
Deletes a usage report by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- report_id: required(json)
Report ID (UUID)
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- version: required(integer)
Growing number of object internal version.
Example:
1559561146223
HTTP status code 204
Usage report was successfully deleted.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /reports/{report_id}
Updates a usage report configuration. Only scheduled reports can be updated.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- report_id: required(json)
Report ID (UUID)
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"recipients": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
},
"description": "IDs of subscribed users."
},
"parameters": {
"type": "object",
"properties": {
"level": {
"type": "string",
"enum": [
"itself",
"direct_partners",
"all_partners",
"all_customers",
"accounts"
],
"description": "Level of report detail."
},
"kind": {
"type": "string",
"enum": [
"usage_daily",
"usage_summary",
"usage_current",
"usage_breakdown"
],
"description": "Kind of report."
},
"hide_zero_usage": {
"type": "boolean",
"description": "Hide metrics with zero usage in report."
},
"show_skus": {
"type": "boolean",
"description": "Show SKU-related fields in report."
}
}
},
"schedule": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Flag indicating whether the report is enabled."
}
},
"required": [
"enabled"
]
}
}
}
Example:
{
"recipients": [
"ca451758-b48a-45d9-9ae6-8f1059f67619"
],
"parameters": {
"kind": "usage_current",
"tenant_id": "2a91a14d-ffd3-4ac1-9b4d-3990162c5acc",
"level": "direct_partners",
"hide_zero_usage": true,
"show_skus": false
}
}
HTTP status code 200
Usage report was successfully updated.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"date": {"$ref": "../_common/types/date.json"}
},
"type": "object",
"properties": {
"id": {
"description": "Unique identifier for this configured report.",
"$ref": "#/definitions/uuid"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"result_action": {
"type": "string",
"enum": [
"save",
"send"
],
"description": "What to do with report."
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
},
"description": "IDs of subscribed users."
},
"parameters": {
"type": "object",
"properties": {
"tenant_id": {
"description": "ID of the tenant that will be the subject of this report.",
"$ref": "#/definitions/uuid"
},
"level": {
"type": "string",
"enum": [
"itself",
"direct_partners",
"all_partners",
"all_customers",
"accounts"
],
"description": "Level of report detail."
},
"formats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"csv",
"html",
"json_v1",
"csv_v2_0"
]
},
"description": "Report formats."
},
"kind": {
"type": "string",
"enum": [
"usage_daily",
"usage_summary",
"usage_current",
"usage_breakdown"
],
"description": "Kind of report."
},
"period": {
"description": "Report period.",
"type": "object",
"properties": {
"start": {
"$ref": "#/definitions/date",
"description": "Starting date of the report period."
},
"end": {
"$ref": "#/definitions/date",
"description": "Ending date of the report period."
}
},
"required": [
"start",
"end"
]
},
"hide_zero_usage": {
"type": "boolean",
"description": "Hide metrics with zero usage in report."
},
"show_skus": {
"type": "boolean",
"description": "Show SKU-related fields in report."
}
},
"required": [
"tenant_id",
"kind",
"level",
"period",
"formats"
]
},
"schedule": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Flag indicating whether the report is enabled (scheduled reports only)."
},
"type": {
"type": "string",
"enum": [
"once",
"monthly"
],
"description": "Type of report schedule."
}
},
"required": [
"enabled",
"type"
]
},
"generation_date": {
"$ref": "#/definitions/date",
"description": "Date when the report should be generated."
}
},
"required": [
"id",
"version",
"recipients",
"parameters",
"generation_date",
"schedule",
"result_action"
]
}
Example:
{
"id": "20dffb36-d77b-45c6-b2fa-39276e98d5fc",
"recipients": [
"ca451758-b48a-45d9-9ae6-8f1059f67619",
"ab00e527-219b-481b-b01b-311b5be0ed3c"
],
"version": 2,
"parameters": {
"kind": "usage_summary",
"tenant_id": "2a91a14d-ffd3-4ac1-9b4d-3990162c5acc",
"level": "accounts",
"period": {
"start": "2017-05-01",
"end": "2017-05-07"
},
"formats": ["csv"],
"hide_zero_usage": true,
"show_skus": false
},
"schedule": {
"type": "once",
"enabled": true
},
"result_action": "send",
"generation_date": "2017-05-08"
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get /reports/{report_id}
Fetches a usage report configuration.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- report_id: required(json)
Report ID (UUID)
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"date": {"$ref": "../_common/types/date.json"}
},
"type": "object",
"properties": {
"id": {
"description": "Unique identifier for this configured report.",
"$ref": "#/definitions/uuid"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"result_action": {
"type": "string",
"enum": [
"save",
"send"
],
"description": "What to do with report."
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
},
"description": "IDs of subscribed users."
},
"parameters": {
"type": "object",
"properties": {
"tenant_id": {
"description": "ID of the tenant that will be the subject of this report.",
"$ref": "#/definitions/uuid"
},
"level": {
"type": "string",
"enum": [
"itself",
"direct_partners",
"all_partners",
"all_customers",
"accounts"
],
"description": "Level of report detail."
},
"formats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"csv",
"html",
"json_v1",
"csv_v2_0"
]
},
"description": "Report formats."
},
"kind": {
"type": "string",
"enum": [
"usage_daily",
"usage_summary",
"usage_current",
"usage_breakdown"
],
"description": "Kind of report."
},
"period": {
"description": "Report period.",
"type": "object",
"properties": {
"start": {
"$ref": "#/definitions/date",
"description": "Starting date of the report period."
},
"end": {
"$ref": "#/definitions/date",
"description": "Ending date of the report period."
}
},
"required": [
"start",
"end"
]
},
"hide_zero_usage": {
"type": "boolean",
"description": "Hide metrics with zero usage in report."
},
"show_skus": {
"type": "boolean",
"description": "Show SKU-related fields in report."
}
},
"required": [
"tenant_id",
"kind",
"level",
"period",
"formats"
]
},
"schedule": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Flag indicating whether the report is enabled (scheduled reports only)."
},
"type": {
"type": "string",
"enum": [
"once",
"monthly"
],
"description": "Type of report schedule."
}
},
"required": [
"enabled",
"type"
]
},
"generation_date": {
"$ref": "#/definitions/date",
"description": "Date when the report should be generated."
}
},
"required": [
"id",
"version",
"recipients",
"parameters",
"generation_date",
"schedule",
"result_action"
]
}
Example:
{
"id": "20dffb36-d77b-45c6-b2fa-39276e98d5fc",
"recipients": [
"ca451758-b48a-45d9-9ae6-8f1059f67619",
"ab00e527-219b-481b-b01b-311b5be0ed3c"
],
"version": 2,
"parameters": {
"kind": "usage_summary",
"tenant_id": "2a91a14d-ffd3-4ac1-9b4d-3990162c5acc",
"level": "accounts",
"period": {
"start": "2017-05-01",
"end": "2017-05-07"
},
"formats": ["csv"],
"hide_zero_usage": true,
"show_skus": false
},
"schedule": {
"type": "once",
"enabled": true
},
"result_action": "send",
"generation_date": "2017-05-08"
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages stored usage reports.
get
Fetches all stored reports related to the usage report.
get /reports/{report_id}/stored
Fetches all stored reports related to the usage report.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- report_id: required(json)
Report ID (UUID)
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../../_common/types/uuid.json"},
"dateTime": {"$ref": "../../_common/types/dateTime.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid"
},
"report_format": {
"type": "string",
"enum": [
"json_v1",
"csv_v2_0",
"csv",
"html"
],
"description": "Stored report data format."
},
"size": {
"type": "integer",
"description": "Stored report compressed size in bytes."
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Date and time when data was generated."
},
"status": {
"type": "string",
"enum": [
"in_progress",
"saved",
"failed"
],
"description": "Report generation status."
}
},
"required": [
"report_format",
"status",
"created_at"
]
}
}
}
}
Example:
{
"items": [
{
"id": "d6bc3e2e-2378-4099-bb33-6a2603aca94d",
"report_format": "json_v1",
"created_at": "2017-01-01T12:07:53",
"size": 128,
"status": "saved"
},
{
"id": "db3acd0d-272e-4860-beca-fb2c2c4edd3e",
"report_format": "json_v1",
"created_at": "2017-01-01T12:07:53",
"size": 128,
"status": "saved"
},
{
"id": "e3f50d66-896c-4699-970f-0a8706fa5920",
"report_format": "json_v1",
"created_at": "2017-01-01T12:07:53",
"size": 128,
"status": "saved"
}
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages specified stored usage report.
get
Downloads stored report data.
get /reports/{report_id}/stored/{stored_report_id}
Downloads stored report data.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- report_id: required(json)
Report ID (UUID)
- stored_report_id: required(json)
Stored usage report ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
A file in the format that was used to generate the stored report.
Body
Media type: application/octet-stream
Type: any
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages reports for multiple tenants.
post
Creates a new usage report configuration for multiple tenants.
post /reports/bulk
Creates a new usage report configuration for multiple tenants.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"date": {"$ref": "../_common/types/date.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"recipients": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
},
"description": "IDs of subscribed users."
},
"result_action": {
"type": "string",
"enum": [
"save",
"send"
],
"description": "What to do with report."
},
"parameters": {
"type": "object",
"properties": {
"tenant_ids": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
},
"description": "IDs of the tenants that will be the subject of this report."
},
"level": {
"type": "string",
"enum": [
"itself",
"direct_partners",
"all_partners",
"all_customers",
"accounts"
],
"description": "Level of report detail."
},
"kind": {
"type": "string",
"enum": [
"usage_daily",
"usage_summary",
"usage_current",
"usage_breakdown"
],
"description": "Kind of report."
},
"formats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"csv",
"html",
"json_v1",
"csv_v2_0"
]
},
"description": "Report formats."
},
"period": {
"description": "Report period.",
"type": "object",
"properties": {
"start": {
"$ref": "#/definitions/date",
"description": "Starting date of the report period."
},
"end": {
"$ref": "#/definitions/date",
"description": "Ending date of the report period."
}
},
"required": [
"start",
"end"
]
},
"hide_zero_usage": {
"type": "boolean",
"description": "Hide metrics with zero usage in report."
},
"show_skus": {
"type": "boolean",
"description": "Show SKU-related fields in report."
}
},
"required": [
"tenant_ids",
"kind",
"level"
]
},
"schedule": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Flag indicating whether the report is enabled (scheduled reports only)."
},
"type": {
"type": "string",
"enum": [
"once",
"monthly"
],
"description": "Type of report schedule."
}
},
"required": [
"type"
]
},
"generation_date": {
"$ref": "#/definitions/date",
"description": "Date when the report should be generated (only one-time reports)."
}
},
"required": [
"recipients",
"parameters",
"schedule",
"result_action"
]
}
Example:
{
"recipients": [
"ca451758-b48a-45d9-9ae6-8f1059f67619",
"ab00e527-219b-481b-b01b-311b5be0ed3c"
],
"parameters": {
"kind": "usage_summary",
"tenant_ids": [
"2a91a14d-ffd3-4ac1-9b4d-3990162c5acc",
"3fb007c0-591c-4c5e-be56-19afe4406f35",
"fb0b21bb-b7c1-49d2-9900-1f337a2da552"
],
"level": "accounts",
"period": {
"start": "2017-05-01",
"end": "2017-05-07"
},
"formats": ["csv"],
"hide_zero_usage": true,
"show_skus": false
},
"schedule": {
"type": "once"
},
"generation_date": "2017-05-08",
"result_action": "send"
}
HTTP status code 201
Usage report configuration was successfully created.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"date": {"$ref": "../_common/types/date.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "Unique identifier for this configured report.",
"$ref": "#/definitions/uuid"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"result_action": {
"type": "string",
"enum": [
"save",
"send"
],
"description": "What to do with report."
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
},
"description": "IDs of subscribed users."
},
"parameters": {
"type": "object",
"properties": {
"tenant_id": {
"description": "ID of the tenant that will be the subject of this report.",
"$ref": "#/definitions/uuid"
},
"level": {
"type": "string",
"enum": [
"itself",
"direct_partners",
"all_partners",
"all_customers",
"accounts"
],
"description": "Level of report detail."
},
"formats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"csv",
"html",
"json_v1",
"csv_v2_0"
]
},
"description": "Report formats."
},
"kind": {
"type": "string",
"enum": [
"usage_daily",
"usage_summary",
"usage_current",
"usage_breakdown"
],
"description": "Kind of report."
},
"period": {
"description": "Report period.",
"type": "object",
"properties": {
"start": {
"$ref": "#/definitions/date",
"description": "Starting date of the report period."
},
"end": {
"$ref": "#/definitions/date",
"description": "Ending date of the report period."
}
},
"required": [
"start",
"end"
]
},
"hide_zero_usage": {
"type": "boolean",
"description": "Hide metrics with zero usage in report."
},
"show_skus": {
"type": "boolean",
"description": "Show SKU-related fields in report."
}
},
"required": [
"tenant_id",
"kind",
"level",
"period",
"formats"
]
},
"schedule": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Flag indicating whether the report is enabled (scheduled reports only)."
},
"type": {
"type": "string",
"enum": [
"once",
"monthly"
],
"description": "Type of report schedule."
}
},
"required": [
"enabled",
"type"
]
},
"generation_date": {
"$ref": "#/definitions/date",
"description": "Date when the report should be generated."
}
},
"required": [
"id",
"version",
"recipients",
"parameters",
"generation_date",
"schedule",
"result_action"
]
}
}
},
"required": [
"items"
]
}
Example:
{
"items": [
{
"generation_date": "2018-08-14",
"parameters": {
"tenant_id": "fb0b21bb-b7c1-49d2-9900-1f337a2da552",
"period": {
"end": "2018-08-13",
"start": "2018-08-13"
},
"level": "accounts",
"kind": "usage_summary",
"formats": ["csv"],
"hide_zero_usage": true,
"show_skus": false
},
"version": 1,
"schedule": {
"enabled": true,
"type": "once"
},
"id": "05f3c32a-d34a-46c2-b71c-c509be742d6b",
"recipients": [
"ca451758-b48a-45d9-9ae6-8f1059f67619",
"ab00e527-219b-481b-b01b-311b5be0ed3c"
],
"result_action": "send"
},
{
"generation_date": "2018-08-14",
"parameters": {
"tenant_id": "3fb007c0-591c-4c5e-be56-19afe4406f35",
"period": {
"end": "2018-08-13",
"start": "2018-08-13"
},
"level": "accounts",
"kind": "usage_summary",
"formats": ["csv"],
"hide_zero_usage": true,
"show_skus": true
},
"version": 1,
"schedule": {
"enabled": true,
"type": "once"
},
"id": "9fce65d5-9aad-4cb4-91ad-9c252af9a4aa",
"recipients": [
"ca451758-b48a-45d9-9ae6-8f1059f67619",
"ab00e527-219b-481b-b01b-311b5be0ed3c"
],
"result_action": "send"
}
]
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/search
get
Searches for tenants and users.
Tenants are searched by name, custom_id, first_name, last_name and email from contact info.
Users are searched by login, email, first_name and last_name.
Search is case-insensitive.
get /search
Searches for tenants and users.
Tenants are searched by name, custom_id, first_name, last_name and email from contact info.
Users are searched by login, email, first_name and last_name.
Search is case-insensitive.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- tenant: required(string)
An ID of the tenant where the search will be performed.
Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed - text: required(string)
Search in all available properties for the supplied text.
Example:
acronis - limit: (integer - default: 10)
Limit the number of found objects.
- allow_deleted: (boolean)
If true, deleted tenants and users may be returned.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"obj_type": {"type": "string", "enum": ["tenant", "user"]},
"id": {"$ref": "#/definitions/id"},
"parent_id": {"$ref": "#/definitions/id"},
"path": {
"type": "array",
"items": {"type": "string"},
"description": "List of tenants' names between search root and found object."
},
"kind": {"$ref": "#/definitions/group_kind"},
"login": {"type": "string", "description": "User's login."},
"name": {"type": "string", "description": "Tenant's name."},
"first_name": {"type": ["string", "null"], "description": "User's or tenant's contact first name. This field can have a null value."},
"last_name": {"type": ["string", "null"], "description": "User's or tenant's contact last name. This field can have a null value."},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
}
},
"required": ["obj_type", "id", "parent_id", "path"]
}
}
},
"type": "object",
"required": ["items"],
"definitions": {
"id": {"$ref": "../_common/types/uuid.json"},
"group_kind": {"$ref": "../_common/types/tenantKind.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"}
},
"$schema": "http://json-schema.org/draft-04/schema"
}
Example:
{
"items": [
{
"obj_type": "tenant",
"kind": "customer",
"id": "bfe40b45-7d3f-4183-a655-afa62b59b383",
"parent_id": "bfe40b45-7d3f-4183-a655-afa62b59b383",
"path": ["my tenant", "some child"],
"name": "Example group",
"first_name": null,
"last_name": null,
"deleted_at": null
},
{
"obj_type": "user",
"id": "1c234e69-5469-424a-a6d1-ff5658b387a6",
"parent_id": "1c234e69-5469-424a-a6d1-ff5658b387a6",
"path": ["my tenant", "some child", "Example group"],
"login": "admin@example.com",
"first_name": "Example",
"last_name": "Admin",
"deleted_at": "2022-08-10T00:00:00Z"
}
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/tenants
Manages tenants.
get
Available in cloud version only.
Fetches details about multiple tenants specified by their UUIDs or about child tenants of a specific tenant specified by its UUID.
post
Creates a new tenant.
get /tenants
Available in cloud version only.
Fetches details about multiple tenants specified by their UUIDs or about child tenants of a specific tenant specified by its UUID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- uuids: (json)
A filter by comma-separated list of tenants' UUIDs. Maximum of 100 UUIDs. Is mutually exclusive with
subtree_root_idandparent_id.Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed,248c535a-0ebe-11e7-a80e-bbdaa1d60c7c - parent_id: (json)
The UUID of a tenant which child tenants will be fetched. Is mutually exclusive with
subtree_root_idanduuids.Example:
370b7f6a-43ce-4028-ad69-ea47f7b04ee4 - subtree_root_id: (json)
Filter to fetch tenants hierarchy starting from (including) the specified one. Sorting by tenant level is always assumed. Is mutually exclusive with
uuidsandparent_id.Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed - updated_since: (datetime)
A filter by tenants that were updated after the specified RFC3339 timestamp in UTC time zone.
Example:
2016-02-28T16:41:41.090Z - limit: (integer - default: 5000 - minimum: 1)
Number of elements to return in current offering items page of the response.
- after: (string)
Cursor to fetch the next tenants page. The cursor encodes all the filtering and sorting arguments, thus client does not need to provide all them for the next page, only cursor should be provided. Client can get the cursor from
paging.cursors.afterfield of the previous page response. - lod: (one of stamps, basic, full - default: full)
A predefined level of details for the tenant object to return.
The following levels of details can be specified:
stamps- includesid,parent_id,version,created_at,updated_at,deleted_at.basic- includesname,kind,enabled.full- includes all the fields.
- with_contacts: (boolean)
If true, all tenants' referencing contacts will be returned in the response.
- with_offering_items: (boolean)
If true, only tenants with count offering items will be returned in the response.
- with_infra_offering_items: (boolean)
If true, only tenants with infra offering items will be returned in the response.
- expand_offering_items: (boolean)
If true, all tenants' offering items will be returned in the response.
- allow_deleted: (boolean)
If true, deleted tenants may be returned.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"tenant": {"$ref": "./tenantBatchItem.json"}
},
"type": "object",
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/tenant"
}
}
},
"required": [
"items",
"timestamp"
]
}
Examples:
default:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"version": 2,
"name": "The Qwerty Tenant",
"customer_type": "enterprise",
"parent_id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"kind": "partner",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": ["legal"],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"city": "Rivertown",
"zipcode": "12345",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "",
"language": "en",
"fax": "123 Example Street"
},
"contacts": [],
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"customer_id": "123asd",
"brand_id": 1,
"brand_uuid": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"internal_tag": null,
"language": "en",
"owner_id": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"has_children": true,
"ancestral_access": true,
"update_lock": {
"enabled": false,
"owner_id": null
},
"mfa_status": "enabled",
"pricing_mode": "trial",
"production_start_date": null
},
{
"id": "5d92a310-0ee7-11e7-95e6-5f64824358de",
"version": 2,
"name": "The Another Tenant",
"customer_type": "enterprise",
"parent_id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"kind": "partner",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117bec",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": ["legal", "technical"],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"city": "Rivertown",
"zipcode": "12345",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "",
"language": "en",
"fax": "123 Example Street"
},
"contacts": [],
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"customer_id": "123asd",
"brand_id": 1,
"brand_uuid": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"internal_tag": null,
"language": "en",
"owner_id": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"has_children": true,
"ancestral_access": true,
"update_lock": {
"enabled": false,
"owner_id": null
},
"mfa_status": "disabled",
"pricing_mode": "production",
"external_operation_status": "recovering",
"production_start_date": null
}
]
}
withContacts:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"version": 2,
"name": "The Qwerty Tenant",
"customer_type": "enterprise",
"parent_id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"kind": "partner",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:01",
"updated_at": "2020-05-19T11:50:01",
"types": ["legal"],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"city": "Rivertown",
"zipcode": "12345",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "",
"language": "en",
"fax": "123 Example Street"
},
"contacts": [
{
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:01",
"updated_at": "2020-05-19T11:50:01",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"user_id": null,
"types": ["legal"],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"city": "Rivertown",
"zipcode": "12345",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "",
"language": "en",
"fax": "123 Example Street"
},
{
"id": "d8f70f4a-976a-4d66-a651-10d2b3d6e9dd",
"created_at": "2020-05-19T11:50:02",
"updated_at": "2020-05-19T11:50:02",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"user_id": "1bfe361d-fcb8-43ff-8f43-9ecc29a08ea5",
"types": ["primary"],
"email": "primary@mysite.com",
"address1": "1440 River Drive #101",
"address2": "",
"country": "USA",
"state": "CA",
"city": "Rivertown",
"zipcode": "12345",
"phone": "123456789",
"firstname": "Company",
"lastname": "Primary",
"title": "Mr.",
"website": "www.mysite.com",
"industry": "IT",
"organization_size": "50-100",
"email_confirmed": true,
"aan": "",
"language": "en",
"fax": "123 Example Street"
}
],
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"customer_id": "123asd",
"brand_id": 1,
"brand_uuid": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"internal_tag": null,
"language": "en",
"owner_id": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"has_children": true,
"ancestral_access": true,
"update_lock": {
"enabled": false,
"owner_id": null
},
"mfa_status": "enabled",
"pricing_mode": "trial",
"production_start_date": null
},
{
"id": "5d92a310-0ee7-11e7-95e6-5f64824358de",
"version": 2,
"name": "The Another Tenant",
"customer_type": "enterprise",
"parent_id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"kind": "partner",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117bec",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": ["legal", "technical"],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "WA",
"zipcode": "11111",
"city": "Tacoma",
"phone": "123456789",
"firstname": "Kevin",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "",
"language": "en",
"fax": "123 Example Street"
},
"contacts": [
{
"id": "27f6f164-63dd-47df-b5b6-83a0fd117bec",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"tenant_id": "5d92a310-0ee7-11e7-95e6-5f64824358de",
"user_id": null,
"types": ["legal", "technical"],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "WE",
"zipcode": "11111",
"city": "Tacoma",
"phone": "123456789",
"firstname": "Kevin",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "",
"language": "en",
"fax": "123 Example Street"
}
],
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"customer_id": "123asd",
"brand_id": 1,
"brand_uuid": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"internal_tag": null,
"language": "en",
"owner_id": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"has_children": true,
"ancestral_access": true,
"update_lock": {
"enabled": false,
"owner_id": null
},
"mfa_status": "disabled",
"pricing_mode": "production",
"production_start_date": null
}
]
}
withOfferingItems:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"version": 2,
"name": "The Qwerty Tenant",
"customer_type": "enterprise",
"parent_id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"kind": "partner",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:01",
"updated_at": "2020-05-19T11:50:01",
"types": ["legal"],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"city": "Rivertown",
"zipcode": "12345",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"external_id": ""
},
"contacts": [],
"offering_items": [
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "vms",
"edition": "standard",
"usage_name": "vms",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": true,
"type": "count",
"measurement_unit": "quantity",
"quota":
{
"value": 10,
"overage": 10,
"version": 1486479690324
}
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "dre_mobiles",
"edition": "disaster_recovery",
"usage_name": "mobiles",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": false,
"type": "count",
"measurement_unit": "quantity",
"quota":
{
"value": 10,
"overage": 10,
"version": 1486479690324
}
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "local_storage",
"edition": null,
"usage_name": "local_storage",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"type": "feature",
"measurement_unit": "n/a"
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "adv_storage",
"edition": "advanced",
"usage_name": "storage",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": true,
"type": "infra",
"measurement_unit": "bytes",
"infra_id": "ee978065-8caa-463d-82d7-47006376e7f2",
"quota":
{
"value": 1000,
"overage": null,
"version": 1486479690324
}
}
],
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"customer_id": "123asd",
"brand_id": 1,
"brand_uuid": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"internal_tag": null,
"language": "en",
"owner_id": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"has_children": true,
"ancestral_access": true,
"update_lock": {
"enabled": false,
"owner_id": null
},
"mfa_status": "enabled",
"pricing_mode": "trial",
"production_start_date": "2016-06-22T18:25:16"
},
{
"id": "5d92a310-0ee7-11e7-95e6-5f64824358de",
"version": 2,
"name": "The Another Tenant",
"customer_type": "enterprise",
"parent_id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"kind": "partner",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117bec",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": ["legal", "technical"],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "WA",
"zipcode": "11111",
"city": "Tacoma",
"phone": "123456789",
"firstname": "Kevin",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"external_id": ""
},
"contacts": [],
"offering_items": [
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "vms",
"edition": "standard",
"usage_name": "vms",
"tenant_id": "5d92a310-0ee7-11e7-95e6-5f64824358de",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": true,
"type": "count",
"measurement_unit": "quantity",
"quota":
{
"value": 5,
"overage": 5,
"version": 1087473394411
}
}
],
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"customer_id": "123asd",
"brand_id": 1,
"brand_uuid": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"internal_tag": null,
"language": "en",
"owner_id": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"has_children": true,
"ancestral_access": true,
"update_lock": {
"enabled": false,
"owner_id": null
},
"mfa_status": "disabled",
"pricing_mode": "production",
"production_start_date": null
}
]
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "bad request",
"details": {
"info": "Request body contains badly-formed JSON."
}
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post /tenants
Creates a new tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"contactPut": {"$ref": "../_common/contact/contactPut.json"},
"tenantKind": {"$ref": "../_common/types/tenantKind.json"},
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Human-readable name that will be displayed to the users."
},
"parent_id": {
"$ref": "#/definitions/uuid",
"description": "ID of parent tenant."
},
"kind": {
"$ref": "#/definitions/tenantKind",
"description": "Kind (type) of tenant."
},
"contact": {
"$ref": "#/definitions/contactPut"
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the tenant is enabled or disabled."
},
"customer_id": {
"type": "string",
"description": "ID from external system; for reporting purposes."
},
"internal_tag": {
"type": ["string", "null"],
"description": "Internal tag. This field can have a null value."
},
"language": {
"type": "string",
"description": "Preferred locale."
},
"default_idp_id": {
"$ref": "#/definitions/uuid",
"description": "Default identity provider ID."
},
"update_lock": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, updating the tenant via API is not allowed to anyone except for users of the tenant that owns the lock."
}
},
"required": [
"enabled"
]
},
"ancestral_access": {
"type": "boolean",
"description": "Access to newly created tenant from ancestors."
},
"settings": {
"type": "object",
"properties": {
"enhanced_security": {
"type": "boolean",
"description": "Enables PCI DSS mode."
}
}
}
},
"required": [
"name",
"parent_id",
"kind"
]
}
Example:
{
"name": "The Qwerty Tenant",
"parent_id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"kind": "partner",
"contact": {
"email": "su@test.com",
"address1": "Home",
"phone": "123456789"
},
"customer_id": "123asd",
"internal_tag": null,
"language": "pt_BR",
"settings": {
"enhanced_security": false
}
}
HTTP status code 201
Tenant was successfully created.
Body
Media type: application/json
Type: json
Content:
{
"title": "Basic tenant schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"customerType": {"$ref": "../_common/types/customerType.json"},
"contact": {"$ref": "../_common/contact/contact.json"},
"tenantKind": {"$ref": "../_common/types/tenantKind.json"},
"uuid": {"$ref": "../_common/types/uuid.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"pricingMode": {"$ref": "../_common/types/pricingMode.json"}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier."
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Creation timestamp."
},
"updated_at": {
"$ref": "#/definitions/dateTime",
"description": "Last update timestamp, if tenant has just been created - then is equal to `created_at`, if tenant has just been deleted - then is equal to `deleted_at`."
},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
},
"production_start_date": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Tenant trial expiration date."
},
"name": {
"type": "string",
"description": "Human-readable name that will be displayed to the users."
},
"customer_type": {
"$ref": "#/definitions/customerType",
"description": "Business type of the tenant."
},
"parent_id": {
"type": "string",
"description": "ID of parent tenant. For the real root tenant the parent_id is equal to its id"
},
"kind": {
"$ref": "#/definitions/tenantKind",
"description": "Kind (type) of the tenant in hierarchy."
},
"contact": {
"description": "Tenant legal contact.",
"$ref": "#/definitions/contact"
},
"contacts": {
"description": "Empty array by default. Will be populated with all referencing contacts if query param `with_contacts` is provided.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/definitions/contact"
}
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the tenant is enabled or disabled."
},
"customer_id": {
"type": ["string", "null"],
"description": "ID from external system; for reporting purposes. This field can have a null value."
},
"brand_id": {
"type": ["integer", "null"],
"description": "Brand id for API v1."
},
"brand_uuid": {
"$ref": "#/definitions/uuid",
"description": "Brand ID for API v2."
},
"internal_tag": {
"type": ["string", "null"],
"description": "Internal tag. This field can have a null value."
},
"language": {
"type": "string",
"description": "Tenant`s preferred language."
},
"owner_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "Identifier of personal tenant owner user. This field can have a null value."
},
"has_children": {
"type": "boolean",
"description": "Flag, indicates if tenant has children."
},
"default_idp_id": {
"$ref": "#/definitions/uuid",
"description": "Default identity provider ID."
},
"update_lock": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, updating the tenant via API is not allowed to anyone except for users of the tenant that owns the lock."
},
"owner_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "ID of tenant that owns the lock (only users of this tenant can update the tenant in question). This field can have a null value."
}
},
"required": [
"enabled",
"owner_id"
]
},
"ancestral_access": {
"type": "boolean",
"description": "Indicates whether tenant's indirect ancestors have access to it."
},
"mfa_status": {
"type": "string",
"description": "Multi-factor authentication status of the tenant.",
"enum": [
"disabled",
"forcibly_disabled",
"setup_required",
"enabled"
]
},
"pricing_mode": {
"description": "Mode of tenant's pricing.",
"$ref": "#/definitions/pricingMode"
},
"external_operation_status": {
"oneOf": [
{"type": "null"},
{
"type": "string",
"enum": [
"deleting",
"recovering"
]
}
],
"description": "Indicates if some external operation in progress for this tenant."
}
},
"required": [
"id",
"version",
"created_at",
"updated_at",
"deleted_at",
"name",
"customer_type",
"parent_id",
"kind",
"contact",
"contacts",
"enabled",
"brand_id",
"internal_tag",
"language",
"has_children",
"update_lock",
"ancestral_access",
"mfa_status",
"pricing_mode"
]
}
Example:
{
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"version": 2,
"name": "The Qwerty Tenant",
"customer_type": "enterprise",
"parent_id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"kind": "partner",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": ["legal"],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "111111"
},
"contacts": [],
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"customer_id": "123asd",
"brand_id": 1,
"brand_uuid": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"internal_tag": null,
"language": "en",
"owner_id": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"has_children": true,
"ancestral_access": true,
"update_lock": {
"enabled": true,
"owner_id": "7decff12-ee1b-4f8d-b446-59610bfb9203"
},
"mfa_status": "enabled",
"pricing_mode": "production",
"production_start_date": null
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "ApplicationAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Deletes a batch of tenants.
post
Deletes multiple tenants in a single request. Provided tenants must have common parent tenant.
Available in cloud version only.
post /tenants/batch/delete
Deletes multiple tenants in a single request. Provided tenants must have common parent tenant.
Available in cloud version only.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "UUID of tenant."
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
}
},
"required": ["id", "version"]
}
}
},
"required": ["items"]
}
Example:
{
"items": [
{
"id": "14244b25-d085-45a4-8923-ec53ad4b19af",
"version": 323
},
{
"id": "e1108992-6d7c-4acd-8d6b-fd614e6486e5",
"version": 534
}
]
}HTTP status code 204
Tenants were successfully deleted.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Fetches a batch of applications' UUIDs for the provided list of tenants.
get /tenants/applications
Fetches a batch of applications' UUIDs for the provided list of tenants.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- tenants: required(json)
A filter of applications by comma-separated list of tenants' UUIDs.
Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed,248c535a-0ebe-11e7-a80e-bbdaa1d60c7c
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {
"$ref": "../_common/types/uuid.json"
}
},
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tenant": {
"type": "string",
"$ref": "#/definitions/uuid"
},
"applications": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
}
}
},
"required": ["tenant", "applications"]
}
}
},
"required": ["items"]
}
Example:
{
"items": [
{
"tenant": "2b5172d7-4374-40db-8e11-08decbc53878",
"applications": [
"8aaf366b-fe24-4f25-93b3-bd729c86cc95",
"aedde3dc-5954-448a-820a-0220cf32ecb1"
]
},
{
"tenant": "aedde3dc-5954-448a-820a-0220cf32ecb1",
"applications": [
"aedde3dc-5954-448a-820a-0220cf32ecb1"
]
}
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Fetches a batch of the offering items with their states and associated quotas.
get /tenants/offering_items
Fetches a batch of the offering items with their states and associated quotas.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
- urn:acronis.com::account-server::tenant_viewer
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- subtree_root_tenant_id: required(json)
A filter by tenants tree starting from the specified tenant ID. Sorting by tenant level is always assumed.
Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed - usage_names: (string)
A filter of offering items by comma-separated list of usage names.
Example:
storage,local_storage - editions: (string)
A filter of offering items by comma-separated list of editions.
Example:
standard,advanced,disaster_recovery - updated_since: (datetime)
A filter by offering items that were updated after the specified RFC3339 timestamp in UTC time zone.
Example:
2016-02-28T16:41:41.090Z - limit: (integer - default: 5000 - minimum: 1)
Number of elements to return in current offering items page of the response.
- after: (string)
Cursor to fetch the next offering items page. The cursor encodes all the filtering and sorting arguments, thus client does not need to provide all them for the next page, only cursor should be provided. Client can get the cursor from
paging.cursors.afterfield of the previous page response. - allow_deleted: (boolean)
If true, deleted offering items may be returned.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"offeringItemOutput": { "$ref": "offeringItemOutput.json" }
},
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/offeringItemOutput"
}
}
},
"required": [
"items",
"timestamp"
]
}
Example:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "vms",
"edition": "standard",
"usage_name": "vms",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": true,
"type": "count",
"measurement_unit": "quantity",
"quota":
{
"value": 10,
"overage": 10,
"version": 1486479690324
}
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "dre_mobiles",
"edition": "disaster_recovery",
"usage_name": "mobiles",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": false,
"type": "count",
"measurement_unit": "quantity",
"quota":
{
"value": 10,
"overage": 10,
"version": 1486479690324
}
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "local_storage",
"edition": null,
"usage_name": "local_storage",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"type": "feature",
"measurement_unit": "n/a"
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "adv_storage",
"edition": "advanced",
"usage_name": "storage",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": true,
"type": "infra",
"measurement_unit": "bytes",
"infra_id": "ee978065-8caa-463d-82d7-47006376e7f2",
"quota":
{
"value": 1000,
"overage": null,
"version": 1486479690324
}
}
]
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Fetches a batch of usages of the tenant.
put
Updates the values of the usages specified in usage_type or associated with the offering items specified in offering_item.
Depending on the combination of provided fields, the usage may be reported either per tenant or per resource. See the descriptions of the fields for more details.
get /tenants/usages
Fetches a batch of usages of the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- tenants: required(json)
A filter of usages by comma-separated list of tenants' UUIDs.
Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed,248c535a-0ebe-11e7-a80e-bbdaa1d60c7c - usage_names: (string)
A filter of usages by comma-separated list of usage names.
Example:
storage,local_storage - editions: (string)
A filter of usages by comma-separated list of editions.
Example:
standard,advanced,disaster_recovery
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"usageOutput": {
"$ref": "./usageOutput.json"
},
"uuid": {
"$ref": "../_common/types/uuid.json"
}
},
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tenant": {
"type": "string",
"$ref": "#/definitions/uuid"
},
"usages": {
"type": "array",
"items": {
"$ref": "#/definitions/usageOutput"
}
}
},
"required": ["tenant", "usages"]
}
}
},
"required": ["items"]
}
Example:
{
"items": [
{
"tenant": "2b5172d7-4374-40db-8e11-08decbc53878",
"usages": [
{
"application_id": "c6ab7fb4-b461-4214-9257-86fbad8efb85",
"name": "vms",
"edition": "standard",
"usage_name": "vms",
"range_start": "2017-06-01T00:00:00",
"absolute_value": 800,
"value": 800,
"type": "count",
"measurement_unit": "quantity",
"offering_item": {
"status": 1,
"quota": {
"value": 10,
"overage": 10,
"version": 1486479690324
}
}
},
{
"application_id": "c6ab7fb4-b461-4214-9257-86fbad8efb85",
"name": "vm_storage",
"edition": "mixed",
"usage_name": "vm_storage",
"type": "infra",
"measurement_unit": "bytes",
"range_start": "2017-06-01T00:00:00",
"absolute_value": 100000,
"value": 100000
}
]
},
{
"tenant": "aedde3dc-5954-448a-820a-0220cf32ecb1",
"usages": [
{
"application_id": "c6ab7fb4-b461-4214-9257-86fbad8efb85",
"name": "adv_vms",
"edition": "advanced",
"usage_name": "vms",
"range_start": "2017-06-01T00:00:00",
"absolute_value": 500,
"value": 500,
"type": "count",
"measurement_unit": "quantity",
"offering_item": {
"status": 1,
"quota": {
"value": 11,
"overage": 12,
"version": 1486479690324
}
}
},
{
"application_id": "c6ab7fb4-b461-4214-9257-86fbad8efb85",
"name": "vm_storage",
"edition": "mixed",
"usage_name": "vm_storage",
"type": "infra",
"measurement_unit": "bytes",
"range_start": "2017-06-01T00:00:00",
"absolute_value": 110000,
"value": 110000
}
]
}
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /tenants/usages
Updates the values of the usages specified in usage_type or associated with the offering items specified in offering_item.
Depending on the combination of provided fields, the usage may be reported either per tenant or per resource. See the descriptions of the fields for more details.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tenant_id": {
"description": "Tenant ID (UUID). Required for per-tenant reporting.",
"type": "string"
},
"resource_id": {
"description": "Resource ID. Required for per-resource reporting.",
"type": "string"
},
"usage_type": {
"description": "A name of the usage. Required for per-resource reporting and per-tenant reporting by usage for some limited usages.\n\nProvided usage must represent a non-individual entity (f.e., `storage`, `compute_points`).\n\nThis field is ignored if `offering_item` is specified.",
"type": "string"
},
"offering_item": {
"description": "A name of the offering item. Required for per-tenant reporting by offering item.\n\nProvided offering item must be accountable.",
"type": "string"
},
"infra_id": {
"description": "Infrastructure component ID (UUID). Required for per-tenant reporting by offering item of type `infra`.",
"type": "string"
},
"usage_value": { "type": "integer" }
},
"required": ["usage_value"]
}
}
},
"required": ["items"]
}
HTTP status code 200
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"errorScheme": {"$ref": "../_common/error.json"}
},
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tenant_id": {
"description": "Tenant ID. Empty in case of per-resource reporting.",
"type": "string"
},
"resource_id": {
"description": "Resource ID. Empty in case of per-tenant reporting.",
"type": "string"
},
"usage_type": {
"description": "Usage name. Empty in case of per-tenant reporting.",
"type": "string"
},
"offering_item": {
"description": "Offering item name. Empty in case of per-resource reporting.",
"type": "string"
},
"infra_id": {
"description": "Infrastructure component ID. Empty in case of per-resource reporting.",
"type": "string"
},
"error": { "$ref": "#/definitions/errorScheme" }
}
}
}
},
"required": ["items"]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "ApplicationAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
delete
Deletes a tenant by ID.
put
Updates a tenant by ID.
get
Fetches a tenant by ID.
delete /tenants/{tenant_id}
Deletes a tenant by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- version: required(integer)
Growing number of object internal version.
Example:
1559561146223
HTTP status code 204
Tenant was successfully deleted.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /tenants/{tenant_id}
Updates a tenant by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"contactPut": {"$ref": "../_common/contact/contactPut.json"},
"customerType": {"$ref": "../_common/types/customerType.json"},
"tenantKind": {"$ref": "../_common/types/tenantKind.json"},
"uuid": {"$ref": "../_common/types/uuid.json"},
"externalOperationStatus": {"$ref": "../_common/types/externalOperationStatus.json"}
},
"required":[
"version"
],
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": "string",
"description": "Human-readable name that will be displayed to the users."
},
"customer_type": {
"$ref": "#/definitions/customerType",
"description": "Business type of the tenant."
},
"parent_id": {
"$ref": "#/definitions/uuid",
"description": "ID of new parent tenant (move group)."
},
"kind": {
"$ref": "#/definitions/tenantKind",
"description": "Kind (type) of tenant."
},
"contact": {
"$ref": "#/definitions/contactPut"
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the tenant is enabled or disabled."
},
"customer_id": {
"type": ["string", "null"],
"description": "ID from external system; for reporting purposes. This field can have a null value."
},
"version": {
"type": "integer",
"description": "Tenant`s version."
},
"brand_id": {
"type": ["integer", "null"],
"description": "Deprecated field. Brand cannot be changed using this."
},
"internal_tag": {
"type": ["string", "null"],
"description": "Internal tag. This field can have a null value."
},
"language": {
"type": "string",
"description": "Tenant`s preferred language."
},
"default_idp_id": {
"$ref": "#/definitions/uuid",
"description": "Default identity provider ID."
},
"update_lock": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, updating the tenant via API is not allowed to anyone except for users of the tenant that owns the lock."
}
},
"required": [
"enabled"
]
},
"ancestral_access": {
"type": "boolean",
"description": "Indicates whether tenant's indirect ancestors have access to it."
},
"external_operation_status": {
"$ref": "#/definitions/externalOperationStatus",
"description": "External operation performed on the tenant."
}
}
}
Example:
{
"name": "Renamed Tenant",
"version": 1,
"brand_id": 1111,
"internal_tag": null,
"customer_id": null,
"parent_id": "c4878582-6e14-451e-9bda-3ff899b3f700",
"kind": "folder",
"language": "en",
"contact": {
"firstname": "New Name"
}
}
HTTP status code 200
Tenant was successfully updated.
Body
Media type: application/json
Type: json
Content:
{
"title": "Basic tenant schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"customerType": {"$ref": "../_common/types/customerType.json"},
"contact": {"$ref": "../_common/contact/contact.json"},
"tenantKind": {"$ref": "../_common/types/tenantKind.json"},
"uuid": {"$ref": "../_common/types/uuid.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"pricingMode": {"$ref": "../_common/types/pricingMode.json"}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier."
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Creation timestamp."
},
"updated_at": {
"$ref": "#/definitions/dateTime",
"description": "Last update timestamp, if tenant has just been created - then is equal to `created_at`, if tenant has just been deleted - then is equal to `deleted_at`."
},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
},
"production_start_date": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Tenant trial expiration date."
},
"name": {
"type": "string",
"description": "Human-readable name that will be displayed to the users."
},
"customer_type": {
"$ref": "#/definitions/customerType",
"description": "Business type of the tenant."
},
"parent_id": {
"type": "string",
"description": "ID of parent tenant. For the real root tenant the parent_id is equal to its id"
},
"kind": {
"$ref": "#/definitions/tenantKind",
"description": "Kind (type) of the tenant in hierarchy."
},
"contact": {
"description": "Tenant legal contact.",
"$ref": "#/definitions/contact"
},
"contacts": {
"description": "Empty array by default. Will be populated with all referencing contacts if query param `with_contacts` is provided.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/definitions/contact"
}
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the tenant is enabled or disabled."
},
"customer_id": {
"type": ["string", "null"],
"description": "ID from external system; for reporting purposes. This field can have a null value."
},
"brand_id": {
"type": ["integer", "null"],
"description": "Brand id for API v1."
},
"brand_uuid": {
"$ref": "#/definitions/uuid",
"description": "Brand ID for API v2."
},
"internal_tag": {
"type": ["string", "null"],
"description": "Internal tag. This field can have a null value."
},
"language": {
"type": "string",
"description": "Tenant`s preferred language."
},
"owner_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "Identifier of personal tenant owner user. This field can have a null value."
},
"has_children": {
"type": "boolean",
"description": "Flag, indicates if tenant has children."
},
"default_idp_id": {
"$ref": "#/definitions/uuid",
"description": "Default identity provider ID."
},
"update_lock": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, updating the tenant via API is not allowed to anyone except for users of the tenant that owns the lock."
},
"owner_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "ID of tenant that owns the lock (only users of this tenant can update the tenant in question). This field can have a null value."
}
},
"required": [
"enabled",
"owner_id"
]
},
"ancestral_access": {
"type": "boolean",
"description": "Indicates whether tenant's indirect ancestors have access to it."
},
"mfa_status": {
"type": "string",
"description": "Multi-factor authentication status of the tenant.",
"enum": [
"disabled",
"forcibly_disabled",
"setup_required",
"enabled"
]
},
"pricing_mode": {
"description": "Mode of tenant's pricing.",
"$ref": "#/definitions/pricingMode"
},
"external_operation_status": {
"oneOf": [
{"type": "null"},
{
"type": "string",
"enum": [
"deleting",
"recovering"
]
}
],
"description": "Indicates if some external operation in progress for this tenant."
}
},
"required": [
"id",
"version",
"created_at",
"updated_at",
"deleted_at",
"name",
"customer_type",
"parent_id",
"kind",
"contact",
"contacts",
"enabled",
"brand_id",
"internal_tag",
"language",
"has_children",
"update_lock",
"ancestral_access",
"mfa_status",
"pricing_mode"
]
}
Example:
{
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"version": 2,
"name": "The Qwerty Tenant",
"customer_type": "enterprise",
"parent_id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"kind": "partner",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": ["legal"],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "111111"
},
"contacts": [],
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"customer_id": "123asd",
"brand_id": 1,
"brand_uuid": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"internal_tag": null,
"language": "en",
"owner_id": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"has_children": true,
"ancestral_access": true,
"update_lock": {
"enabled": true,
"owner_id": "7decff12-ee1b-4f8d-b446-59610bfb9203"
},
"mfa_status": "enabled",
"pricing_mode": "production",
"production_start_date": null
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1010,
"context": {},
"message": "conflict",
"details": {
"info": "user with specified login already exists in same tenant"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "ApplicationAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get /tenants/{tenant_id}
Fetches a tenant by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- embed_path: (boolean)
If true, tenant path will be embedded in the result.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"title": "Basic tenant schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"customerType": {"$ref": "../_common/types/customerType.json"},
"contact": {"$ref": "../_common/contact/contact.json"},
"tenantKind": {"$ref": "../_common/types/tenantKind.json"},
"uuid": {"$ref": "../_common/types/uuid.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"pricingMode": {"$ref": "../_common/types/pricingMode.json"}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier."
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Creation timestamp."
},
"updated_at": {
"$ref": "#/definitions/dateTime",
"description": "Last update timestamp, if tenant has just been created - then is equal to `created_at`, if tenant has just been deleted - then is equal to `deleted_at`."
},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
},
"production_start_date": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Tenant trial expiration date."
},
"name": {
"type": "string",
"description": "Human-readable name that will be displayed to the users."
},
"customer_type": {
"$ref": "#/definitions/customerType",
"description": "Business type of the tenant."
},
"parent_id": {
"type": "string",
"description": "ID of parent tenant. For the real root tenant the parent_id is equal to its id"
},
"kind": {
"$ref": "#/definitions/tenantKind",
"description": "Kind (type) of the tenant in hierarchy."
},
"contact": {
"description": "Tenant legal contact.",
"$ref": "#/definitions/contact"
},
"contacts": {
"description": "Empty array by default. Will be populated with all referencing contacts if query param `with_contacts` is provided.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/definitions/contact"
}
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the tenant is enabled or disabled."
},
"customer_id": {
"type": ["string", "null"],
"description": "ID from external system; for reporting purposes. This field can have a null value."
},
"brand_id": {
"type": ["integer", "null"],
"description": "Brand id for API v1."
},
"brand_uuid": {
"$ref": "#/definitions/uuid",
"description": "Brand ID for API v2."
},
"internal_tag": {
"type": ["string", "null"],
"description": "Internal tag. This field can have a null value."
},
"language": {
"type": "string",
"description": "Tenant`s preferred language."
},
"owner_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "Identifier of personal tenant owner user. This field can have a null value."
},
"has_children": {
"type": "boolean",
"description": "Flag, indicates if tenant has children."
},
"default_idp_id": {
"$ref": "#/definitions/uuid",
"description": "Default identity provider ID."
},
"update_lock": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, updating the tenant via API is not allowed to anyone except for users of the tenant that owns the lock."
},
"owner_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "ID of tenant that owns the lock (only users of this tenant can update the tenant in question). This field can have a null value."
}
},
"required": [
"enabled",
"owner_id"
]
},
"ancestral_access": {
"type": "boolean",
"description": "Indicates whether tenant's indirect ancestors have access to it."
},
"mfa_status": {
"type": "string",
"description": "Multi-factor authentication status of the tenant.",
"enum": [
"disabled",
"forcibly_disabled",
"setup_required",
"enabled"
]
},
"pricing_mode": {
"description": "Mode of tenant's pricing.",
"$ref": "#/definitions/pricingMode"
},
"external_operation_status": {
"oneOf": [
{"type": "null"},
{
"type": "string",
"enum": [
"deleting",
"recovering"
]
}
],
"description": "Indicates if some external operation in progress for this tenant."
}
},
"required": [
"id",
"version",
"created_at",
"updated_at",
"deleted_at",
"name",
"customer_type",
"parent_id",
"kind",
"contact",
"contacts",
"enabled",
"brand_id",
"internal_tag",
"language",
"has_children",
"update_lock",
"ancestral_access",
"mfa_status",
"pricing_mode"
]
}
Example:
{
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"version": 2,
"name": "The Qwerty Tenant",
"customer_type": "enterprise",
"parent_id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"kind": "partner",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": ["legal"],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "111111"
},
"contacts": [],
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"customer_id": "123asd",
"brand_id": 1,
"brand_uuid": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"internal_tag": null,
"language": "en",
"owner_id": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"has_children": true,
"ancestral_access": true,
"update_lock": {
"enabled": true,
"owner_id": "7decff12-ee1b-4f8d-b446-59610bfb9203"
},
"mfa_status": "enabled",
"pricing_mode": "production",
"production_start_date": null
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages offering items of the tenant.
get
Fetches a list offering items with state and associated quotas.
put
Sets the states and quotas of the offering items for specified applications of the tenant.
get /tenants/{tenant_id}/offering_items
Fetches a list offering items with state and associated quotas.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
- urn:acronis.com::account-server::tenant_viewer
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- for_ui: (boolean)
If true, the list of offering items will be returned in a form that is appropriate for the UI. Currently, offering items on a grace period will be filtered out.
- edition: (string - default: standard)
A filter of the offering items by edition. If "*" is provided, all editions will be returned. Offering items without an edition are not filtered out in any case.
Example:
* - usage_names: (string)
A filter by comma-separated list of usage names.
Example:
storage,local_storage - available_only: (string)
If true, return only infrastructures and offering items available for the enablement according to internal business rules.
Example:
true, false, 0, 1 - type: (json)
A filter by offering item type.
Example:
count - status: (json)
A filter by offering item status.
1 - active 0 - not active
- infra_uuid: (json)
A filter by infrastructure UUID.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"offeringItemOutput": { "$ref": "offeringItemOutput.json" }
},
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/offeringItemOutput"
}
}
},
"required": [
"items",
"timestamp"
]
}
Example:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "vms",
"edition": "standard",
"usage_name": "vms",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": true,
"type": "count",
"measurement_unit": "quantity",
"quota":
{
"value": 10,
"overage": 10,
"version": 1486479690324
}
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "dre_mobiles",
"edition": "disaster_recovery",
"usage_name": "mobiles",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": false,
"type": "count",
"measurement_unit": "quantity",
"quota":
{
"value": 10,
"overage": 10,
"version": 1486479690324
}
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "local_storage",
"edition": null,
"usage_name": "local_storage",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"type": "feature",
"measurement_unit": "n/a"
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "adv_storage",
"edition": "advanced",
"usage_name": "storage",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": true,
"type": "infra",
"measurement_unit": "bytes",
"infra_id": "ee978065-8caa-463d-82d7-47006376e7f2",
"quota":
{
"value": 1000,
"overage": null,
"version": 1486479690324
}
}
]
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "bad request",
"details": {
"info": "Request body contains badly-formed JSON."
}
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1010,
"context": {},
"message": "conflict",
"details": {
"info": "user with specified login already exists in same tenant"
}
}
}
HTTP status code 426
Server refuses to fulfill the request using the current protocol
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1001,
"context": {},
"message": "upgrade required",
"details": {
"info": "entity version mismatch, probably entity was updated in another session"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /tenants/{tenant_id}/offering_items
Sets the states and quotas of the offering items for specified applications of the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"definitions": {
"offeringItem": {
"$ref": "offeringItem.json"
}
},
"properties": {
"offering_items": {
"type": "array",
"items": {
"$ref": "#/definitions/offeringItem"
}
},
"check_usage": {
"type": "boolean",
"description": "If true, check whether offering items being turned off have no usage."
}
},
"required": ["offering_items"]
}
Example:
{
"offering_items": [
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "vms",
"status": 1,
"quota": {
"value": 10,
"overage": 10,
"version": 1486479690324
}
}, {
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "workstations",
"status": 0
}, {
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "storage",
"infra_id": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"status": 1,
"quota": {
"value": 10000,
"overage": 100000,
"version": 1486479690324
}
}, {
"application_id": "71739a04-177f-4603-84ad-54a326ba76e4",
"name": "fc_storage",
"infra_id": "4fff10c4-1378-4bfc-877d-b66a0f8805ed",
"status": 1,
"quota": {
"value": 100000,
"overage": 100000,
"version": 1486479690324
}
}, {
"application_id": "71739a04-177f-4603-84ad-54a326ba76e4",
"name": "fc_seats",
"status": 1
}
],
"check_usage": true
}
HTTP status code 200
Offering Items states were successfully set.
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"offeringItemOutput": { "$ref": "offeringItemOutput.json" }
},
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/offeringItemOutput"
}
}
},
"required": [
"items",
"timestamp"
]
}
Example:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "vms",
"edition": "standard",
"usage_name": "vms",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": true,
"type": "count",
"measurement_unit": "quantity",
"quota":
{
"value": 10,
"overage": 10,
"version": 1486479690324
}
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "dre_mobiles",
"edition": "disaster_recovery",
"usage_name": "mobiles",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": false,
"type": "count",
"measurement_unit": "quantity",
"quota":
{
"value": 10,
"overage": 10,
"version": 1486479690324
}
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "local_storage",
"edition": null,
"usage_name": "local_storage",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"type": "feature",
"measurement_unit": "n/a"
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "adv_storage",
"edition": "advanced",
"usage_name": "storage",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": true,
"type": "infra",
"measurement_unit": "bytes",
"infra_id": "ee978065-8caa-463d-82d7-47006376e7f2",
"quota":
{
"value": 1000,
"overage": null,
"version": 1486479690324
}
}
]
}
HTTP status code 400
Offering items states were not successfully set.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": 1049,
"message": "It is not possible to disable the following offering items: adv_vms, adv_storage(infra_id=e45a9efb-deb5-4ffc-ab31-2f3c159f0351). The usages are being updated at the moment and their value might be more than zero.",
"details": {
"info": "It is not possible to disable the following offering items: adv_vms, adv_storage(infra_id=e45a9efb-deb5-4ffc-ab31-2f3c159f0351). The usages are being updated at the moment and their value might be more than zero.",
"addition": [{
"offering_items": [
{
"name": "adv_vms"
},
{
"name": "adv_storage",
"infra_id": "e45a9efb-deb5-4ffc-ab31-2f3c159f0351"
}
]
}]
},
"context": {
"offering_items": [
{
"name": "adv_vms"
},
{
"name": "adv_storage",
"infra_id": "e45a9efb-deb5-4ffc-ab31-2f3c159f0351"
}
]
},
"domain": "PlatformAccountServer"
}
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1010,
"context": {},
"message": "conflict",
"details": {
"info": "user with specified login already exists in same tenant"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Fetches available offering items for a hypothetical child tenant with provided parameters.
get /tenants/{tenant_id}/offering_items/available_for_child
Fetches available offering items for a hypothetical child tenant with provided parameters.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- kind: (string)
A kind of hypothetical child tenant for which available offering items will be returned.
Example:
unit - edition: (string - default: standard)
A filter of the offering items by edition. If "*" is provided, all editions will be returned. Offering items without an edition are not filtered out in any case.
Example:
*
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"offeringItemOutput": { "$ref": "offeringItemOutput.json" }
},
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/offeringItemOutput"
}
}
},
"required": [
"items",
"timestamp"
]
}
Example:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "vms",
"edition": "standard",
"usage_name": "vms",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": true,
"type": "count",
"measurement_unit": "quantity",
"quota":
{
"value": 10,
"overage": 10,
"version": 1486479690324
}
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "dre_mobiles",
"edition": "disaster_recovery",
"usage_name": "mobiles",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": false,
"type": "count",
"measurement_unit": "quantity",
"quota":
{
"value": 10,
"overage": 10,
"version": 1486479690324
}
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "local_storage",
"edition": null,
"usage_name": "local_storage",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"type": "feature",
"measurement_unit": "n/a"
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "adv_storage",
"edition": "advanced",
"usage_name": "storage",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": true,
"type": "infra",
"measurement_unit": "bytes",
"infra_id": "ee978065-8caa-463d-82d7-47006376e7f2",
"quota":
{
"value": 1000,
"overage": null,
"version": 1486479690324
}
}
]
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages offering items price for the tenant.
get
Fetches a list of prices of the offering items for the tenant.
put
Updates the prices of the offering items for the tenant.
get /tenants/{tenant_id}/offering_items/pricing
Fetches a list of prices of the offering items for the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"application_id": {
"description": "ID of the offering item's owner application.",
"$ref": "#/definitions/uuid"
},
"infra_id": {
"description": "ID of the offering item's infrastructure component (for items that are bound to a component).",
"$ref": "#/definitions/uuid"
},
"name": {
"type": "string",
"description": "Usage name (type)."
},
"price": {
"description": "Price of offering item. Passed as a string to preserve decimal accuracy.",
"type": "string"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
}
},
"required": [
"application_id",
"name",
"price",
"version"
]
}
}
},
"required": [
"items"
]
}Example:
{
"items": [
{
"application_id": "b037d1f6-25cf-4a9c-98f1-d3e41c100948",
"name": "storage",
"infra_id": "05348371-d95e-4cab-af2a-8e2cadafc30d",
"price": "0.05",
"version": 1497533157730
},
{
"application_id": "b037d1f6-25cf-4a9c-98f1-d3e41c100948",
"name": "servers",
"price": "600",
"version": 1497533157730
}
]
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /tenants/{tenant_id}/offering_items/pricing
Updates the prices of the offering items for the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"application_id": {
"description": "ID of the offering item's owner application.",
"$ref": "#/definitions/uuid"
},
"infra_id": {
"description": "ID of the offering item's infrastructure component (for items that are bound to a component).",
"$ref": "#/definitions/uuid"
},
"name": {
"type": "string",
"description": "Usage name (type)."
},
"price": {
"description": "Price of offering item. Passed as a string to preserve decimal accuracy.",
"type": "string"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
}
},
"required": [
"application_id",
"name",
"price"
]
}
}
},
"required": [
"items"
]
}Example:
{
"items": [
{
"application_id": "b037d1f6-25cf-4a9c-98f1-d3e41c100948",
"name": "storage",
"infra_id": "05348371-d95e-4cab-af2a-8e2cadafc30d",
"price": "0.05",
"version": 1497533157730
},
{
"application_id": "b037d1f6-25cf-4a9c-98f1-d3e41c100948",
"name": "servers",
"price": "600",
"version": 1497533157730
},
{
"application_id": "b037d1f6-25cf-4a9c-98f1-d3e41c100948",
"name": "vms",
"price": "0",
"version": 1497533157730
}
]
}HTTP status code 200
Prices were successfully updated.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"application_id": {
"description": "ID of the offering item's owner application.",
"$ref": "#/definitions/uuid"
},
"infra_id": {
"description": "ID of the offering item's infrastructure component (for items that are bound to a component).",
"$ref": "#/definitions/uuid"
},
"name": {
"type": "string",
"description": "Usage name (type)."
},
"price": {
"description": "Price of offering item. Passed as a string to preserve decimal accuracy.",
"type": "string"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
}
},
"required": [
"application_id",
"name",
"price",
"version"
]
}
}
},
"required": [
"items"
]
}Example:
{
"items": [
{
"application_id": "b037d1f6-25cf-4a9c-98f1-d3e41c100948",
"name": "storage",
"infra_id": "05348371-d95e-4cab-af2a-8e2cadafc30d",
"price": "0.05",
"version": 1497533157730
},
{
"application_id": "b037d1f6-25cf-4a9c-98f1-d3e41c100948",
"name": "servers",
"price": "600",
"version": 1497533157730
}
]
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Performs edition switching check for the tenant.
put
Switches the edition for the tenant.
get /tenants/{tenant_id}/edition
Performs edition switching check for the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- target_edition: required(string)
A target edition to switch to.
Example:
disaster_recovery - application_id: required(string)
Application UUID.
HTTP status code 200
Edition switch can be performed.
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"warnings": {
"type": "array",
"description": "Warning codes that should be displayed on edition switch.",
"items": {
"type": "string"
}
}
},
"required": ["warnings"]
}Example:
{
"warnings": [
"OldFeaturesBecomeUnavailable",
"NewFeaturesBecomeAvailable",
"SomePlansWillStopWorking",
"AllDevicesWithBackupsPreserved",
"UsageStatisticsWillMigrate",
"AdvCyberProtectBecomeUnavailable"
]
}HTTP status code 400
Edition switch cannot be performed due to unavailable offering items. List of these offering items will be returned in error.context.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": 1048,
"message": "Cannot switch edition. Following offering items cannot be turned on in the target edition: adv_vms, adv_storage(infra_id=e45a9efb-deb5-4ffc-ab31-2f3c159f0351)",
"details": {
"info": "Cannot switch edition. Following offering items cannot be turned on in the target edition: adv_vms, adv_storage(infra_id=e45a9efb-deb5-4ffc-ab31-2f3c159f0351)",
"addition": [{
"offering_items": [
{
"name": "adv_vms"
},
{
"name": "adv_storage",
"infra_id": "e45a9efb-deb5-4ffc-ab31-2f3c159f0351"
}
]
}]
},
"context": {
"offering_items": [
{
"name": "adv_vms"
},
{
"name": "adv_storage",
"infra_id": "e45a9efb-deb5-4ffc-ab31-2f3c159f0351"
}
]
},
"domain": "PlatformAccountServer"
}
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /tenants/{tenant_id}/edition
Switches the edition for the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"properties": {
"target_edition": {
"description": "Target edition to switch to.",
"type": "string"
},
"application_id": {
"description": "Related application ID.",
"$ref": "#/definitions/uuid"
}
},
"required": ["target_edition", "application_id"],
"type": "object",
"additionalProperties": false
}Example:
{
"target_edition": "disaster_recovery",
"application_id": "c6ab7fb4-b461-4214-9257-86fbad8efb85"
}HTTP status code 200
Edition was successfully switched.
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"offeringItemOutput": { "$ref": "offeringItemOutput.json" }
},
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/offeringItemOutput"
}
}
},
"required": [
"items",
"timestamp"
]
}
Example:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "vms",
"edition": "standard",
"usage_name": "vms",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": true,
"type": "count",
"measurement_unit": "quantity",
"quota":
{
"value": 10,
"overage": 10,
"version": 1486479690324
}
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "dre_mobiles",
"edition": "disaster_recovery",
"usage_name": "mobiles",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": false,
"type": "count",
"measurement_unit": "quantity",
"quota":
{
"value": 10,
"overage": 10,
"version": 1486479690324
}
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "local_storage",
"edition": null,
"usage_name": "local_storage",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"type": "feature",
"measurement_unit": "n/a"
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "adv_storage",
"edition": "advanced",
"usage_name": "storage",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": true,
"type": "infra",
"measurement_unit": "bytes",
"infra_id": "ee978065-8caa-463d-82d7-47006376e7f2",
"quota":
{
"value": 1000,
"overage": null,
"version": 1486479690324
}
}
]
}
HTTP status code 400
Edition was not switched due to unavailable offering items. List of these offering items will be returned in error.context.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": 1048,
"message": "Cannot switch edition. Following offering items cannot be turned on in the target edition: adv_vms, adv_storage(infra_id=e45a9efb-deb5-4ffc-ab31-2f3c159f0351)",
"details": {
"info": "Cannot switch edition. Following offering items cannot be turned on in the target edition: adv_vms, adv_storage(infra_id=e45a9efb-deb5-4ffc-ab31-2f3c159f0351)",
"addition": [{
"offering_items": [
{
"name": "adv_vms"
},
{
"name": "adv_storage",
"infra_id": "e45a9efb-deb5-4ffc-ab31-2f3c159f0351"
}
]
}]
},
"context": {
"offering_items": [
{
"name": "adv_vms"
},
{
"name": "adv_storage",
"infra_id": "e45a9efb-deb5-4ffc-ab31-2f3c159f0351"
}
]
},
"domain": "PlatformAccountServer"
}
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages registration tokens of the tenant. Registration tokens can be used to register agents with predefined access scope in unattended registration flow (ex. mass deployment).
get
Fetches registration tokens.
post
Creates registration token for the tenant.
get /tenants/{tenant_id}/registration_tokens
Fetches registration tokens.
Secured by oauth2
Secured by session
Secured by basicAuth
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"registrationToken": { "$ref": "registrationToken.json" }
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/registrationToken"
}
}
},
"required": [
"items"
]
}
Example:
{
"items": [
{
"id": 2,
"token": "27F9-5234-41C3",
"tenant_id": "11",
"tenant_uuid": "4b07e4a1-a49b-4d4e-b8f2-253f1fef98ad",
"created_at": "2022-04-02T18:46:45Z",
"expires_at": "2022-04-05T18:46:45Z",
"scopes": [
"urn:acronis.com:tenant-id:734fe814-748a-41cb-8a94-60e18fb3c442:backup_agent_admin",
"urn:acronis.com::policy_management:4b07e4a1-a49b-4d4e-b8f2-253f1fef98ad|10858a46-db9b-4725-aa60-fff6252841fd:apply_revoke"
]
},
{
"id": 3,
"token": "F8CA-2DD1-41F1",
"tenant_id": "1363521",
"tenant_uuid": "00bc0d4a-9879-40bf-823a-77c01b197dc1",
"created_at": "2022-04-02T18:57:46Z",
"expires_at": "2022-04-05T18:57:46Z",
"scopes": [
"urn:acronis.com:tenant-id:1e3d306e-85ad-454c-b4f6-2bd73c83b9a1:backup_agent_admin"
]
}
]
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by session
Headers
- Cookie: required(string)
Example:
SESSION="c09fef6c-43ba-4e08-9c2b-fa81f6945ace"
HTTP status code 401
The request was denied due to an invalid session token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the current session token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by basicAuth
Headers
- Authorization: required(string - pattern: Basic [0-9a-zA-Z\-\._~+/]*=)
Used to send the base64-encoded "client_id:client_secret" credentials.
Example:
Basic QUJDMTIz=
HTTP status code 403
The request was denied due to the credentials having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post /tenants/{tenant_id}/registration_tokens
Creates registration token for the tenant.
Secured by oauth2
Secured by session
Secured by basicAuth
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"expires_in": {
"description": "Token expiration time in seconds. Should be less than or equal to one year.",
"type": "integer"
},
"scopes": {
"description": "Access scopes that are applied to the registered resource. The following access scope patterns are available:\n- `urn:acronis.com:tenant-id:{personal_tenant_id}:backup_agent_admin` - binds the resource to the user by personal tenant ID specified in `{personal_tenant_id}`.\n- `urn:acronis.com::policy_management:{tenant_id}|{policy_id}:apply_revoke` - applies a protection plan to a resource by policy ID specified in `{policy_id}` from a resource owner tenant specified in `{tenant_id}`.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"expires_in",
"scopes"
]
}
Example:
{
"expires_in": 3600,
"scopes": [
"urn:acronis.com:tenant-id:734fe814-748a-41cb-8a94-60e18fb3c442:backup_agent_admin",
"urn:acronis.com::policy_management:20435cc8-0b12-4b57-94c7-33afb28f0f34|10858a46-db9b-4725-aa60-fff6252841fd:apply_revoke"
]
}
HTTP status code 200
Registration token was successfully created.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"description": "Initial registration token unique identifier.",
"type": "integer"
},
"token": {
"description": "Initial registration token.",
"type": "string",
"pattern": "[A-Z0-9]{4}-[A-Z0-9]{4}-[A-Z0-9]{4}"
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Date and time when initial registration token was created."
},
"expires_at": {
"$ref": "#/definitions/dateTime",
"description": "Date and time when initial registration token will expire."
},
"tenant_id": {
"description": "Numeric identifier of the resource owner tenant.",
"type": "string",
"pattern": "\\d+"
},
"tenant_uuid": {
"description": "UUID of the resource owner tenant.",
"$ref": "#/definitions/uuid"
},
"scopes": {
"description": "Access scopes that are applied to the registered resource. The following access scope patterns are available:\n- `urn:acronis.com:tenant-id:{personal_tenant_id}:backup_agent_admin` - binds the resource to the user by personal tenant ID specified in `{personal_tenant_id}`.\n- `urn:acronis.com::policy_management:{tenant_id}|{policy_id}:apply_revoke` - applies a protection plan to a resource by policy ID specified in `{policy_id}` from a resource owner tenant specified in `{tenant_id}`.",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": ["id", "token", "created_at", "expires_at", "tenant_id", "scopes"]
}
Example:
{
"id": 2,
"token": "27F9-5234-41C3",
"tenant_id": "11",
"tenant_uuid": "4b07e4a1-a49b-4d4e-b8f2-253f1fef98ad",
"created_at": "2022-04-02T18:46:45Z",
"expires_at": "2022-04-05T18:46:45Z",
"scopes": [
"urn:acronis.com:tenant-id:734fe814-748a-41cb-8a94-60e18fb3c442:backup_agent_admin",
"urn:acronis.com::policy_management:4b07e4a1-a49b-4d4e-b8f2-253f1fef98ad|10858a46-db9b-4725-aa60-fff6252841fd:apply_revoke"
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by session
Headers
- Cookie: required(string)
Example:
SESSION="c09fef6c-43ba-4e08-9c2b-fa81f6945ace"
HTTP status code 401
The request was denied due to an invalid session token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the current session token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by basicAuth
Headers
- Authorization: required(string - pattern: Basic [0-9a-zA-Z\-\._~+/]*=)
Used to send the base64-encoded "client_id:client_secret" credentials.
Example:
Basic QUJDMTIz=
HTTP status code 403
The request was denied due to the credentials having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Fetches a list of applications available to the tenant.
get /tenants/{tenant_id}/applications
Fetches a list of applications available to the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- for_ui: (boolean)
If true, the list of applications will be returned in a form that is appropriate for the UI. Currently, applications on a grace period will be filtered out.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "types/uuid.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
}
}
},
"required": [
"items"
]
}
Example:
{
"items":[
"aa4f8923-8950-4804-8827-c6d78388e5b6",
"4eb7b320-48b4-4552-9bf8-f7482538da23"
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Fetches a list of the applications' roles available to the tenant.
get /tenants/{tenant_id}/applications/roles
Fetches a list of the applications' roles available to the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- _issues: (string)
If set true then roles will be returned in extended format.
Example:
embed_detailed
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"application_id": { "$ref": "#/definitions/uuid" },
"is_default": { "type": "boolean" },
"role": { "type": "string" },
"type": { "type": "string" },
"_issues": {
"type": "object",
"properties": {
"target": {
"type": "string",
"description": "Role text representation."
},
"severity": {
"type": "string",
"enum": ["error", "warning"],
"description": "Error severity."
},
"error": {
"type": "object",
"description": "Error details.",
"properties": {
"domain": {
"type": "string"
},
"code": {
"type": "integer",
"description": "Business error code."
},
"message": {
"type": "string",
"description": "Business error message."
}
}
}
}
}
},
"required": [
"role",
"type"
]
}
}
}
}
Example:
{
"items": [
{
"role": "root_admin",
"is_default": true,
"type": "admin",
"application_id": "8aaf366b-fe24-4f25-93b3-bd729c86cc95"
},
{
"role": "readonly_admin",
"is_default": false,
"type": "admin",
"application_id": "8aaf366b-fe24-4f25-93b3-bd729c86cc95"
}
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Fetches a list of the application's roles available to the tenant.
get /tenants/{tenant_id}/applications/{application_id}/roles
Fetches a list of the application's roles available to the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
- application_id: required(json)
Application UUID.
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- _issues: (string)
If set true then roles will be returned in extended format.
Example:
embed_detailed
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"application_id": { "$ref": "#/definitions/uuid" },
"is_default": { "type": "boolean" },
"role": { "type": "string" },
"type": { "type": "string" },
"_issues": {
"type": "object",
"properties": {
"target": {
"type": "string",
"description": "Role text representation."
},
"severity": {
"type": "string",
"enum": ["error", "warning"],
"description": "Error severity."
},
"error": {
"type": "object",
"description": "Error details.",
"properties": {
"domain": {
"type": "string"
},
"code": {
"type": "integer",
"description": "Business error code."
},
"message": {
"type": "string",
"description": "Business error message."
}
}
}
}
}
},
"required": [
"role",
"type"
]
}
}
}
}
Example:
{
"items": [
{
"role": "root_admin",
"is_default": true,
"type": "admin",
"application_id": "8aaf366b-fe24-4f25-93b3-bd729c86cc95"
},
{
"role": "readonly_admin",
"is_default": false,
"type": "admin",
"application_id": "8aaf366b-fe24-4f25-93b3-bd729c86cc95"
}
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages offering items of the tenant's application.
get
Fetches a batch of offering items with a state and associated quotas for the tenant's application.
get /tenants/{tenant_id}/applications/{application_id}/offering_items
Fetches a batch of offering items with a state and associated quotas for the tenant's application.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
- application_id: required(json)
Application UUID.
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- edition: (string - default: standard)
A filter of the offering items by edition. If "*" is provided, all editions will be returned. Offering items without an edition are not filtered out in any case.
Example:
*
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"offeringItemOutput": { "$ref": "offeringItemOutput.json" }
},
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/offeringItemOutput"
}
}
},
"required": [
"items",
"timestamp"
]
}
Example:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "vms",
"edition": "standard",
"usage_name": "vms",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": true,
"type": "count",
"measurement_unit": "quantity",
"quota":
{
"value": 10,
"overage": 10,
"version": 1486479690324
}
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "dre_mobiles",
"edition": "disaster_recovery",
"usage_name": "mobiles",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": false,
"type": "count",
"measurement_unit": "quantity",
"quota":
{
"value": 10,
"overage": 10,
"version": 1486479690324
}
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "local_storage",
"edition": null,
"usage_name": "local_storage",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"type": "feature",
"measurement_unit": "n/a"
},
{
"application_id": "a9fd8016-0e00-4ade-949e-6efe8672dac0",
"name": "adv_storage",
"edition": "advanced",
"usage_name": "storage",
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"status": 1,
"locked": true,
"type": "infra",
"measurement_unit": "bytes",
"infra_id": "ee978065-8caa-463d-82d7-47006376e7f2",
"quota":
{
"value": 1000,
"overage": null,
"version": 1486479690324
}
}
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Fetches application's usages metrics for the tenant.
get /tenants/{tenant_id}/applications/{application_id}/usages
Fetches application's usages metrics for the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
- application_id: required(json)
Application UUID.
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"usageOutput": {
"$ref": "./usageOutput.json"
}
},
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/usageOutput"
}
}
},
"required": ["items"]
}
Example:
{
"items": [
{
"application_id": "c6ab7fb4-b461-4214-9257-86fbad8efb85",
"name": "adv_vms",
"edition": "advanced",
"usage_name": "vms",
"type": "count",
"measurement_unit": "quantity",
"range_start": "2017-06-01T00:00:00",
"absolute_value": 800,
"value": 800,
"offering_item": {
"status": 1,
"quota": {
"value": 10,
"overage": 10,
"version": 1486479690324
}
}
},
{
"application_id": "c6ab7fb4-b461-4214-9257-86fbad8efb85",
"name": "storage",
"edition": "standard",
"usage_name": "storage",
"type": "infra",
"measurement_unit": "bytes",
"infra_id": "df476eec-c470-40b0-9b10-37223b7f4a2b",
"range_start": "2017-06-22T00:00:00",
"absolute_value": 800,
"value": 800,
"offering_item": {
"status": 1,
"quota": {
"value": 1000,
"overage": 2000,
"version": 1486479690324
}
}
},
{
"application_id": "c6ab7fb4-b461-4214-9257-86fbad8efb85",
"name": "vm_storage",
"edition": "standard",
"usage_name": "vm_storage",
"range_start": "2017-06-01T00:00:00",
"type": "infra",
"measurement_unit": "bytes",
"absolute_value": 100000,
"value": 100000
}
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Fetches application's usage metric for the tenant.
get /tenants/{tenant_id}/applications/{application_id}/usages/{offering_item_name}
Fetches application's usage metric for the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
- application_id: required(json)
Application UUID.
- offering_item_name: required(string)
Name of the particular offering item associated with usage metric. Non-existing offering item name is skipped, application usages are returned
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"usageOutput": {
"$ref": "./usageOutput.json"
}
},
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/usageOutput"
}
}
},
"required": ["items"]
}
Example:
{
"items": [
{
"application_id": "c6ab7fb4-b461-4214-9257-86fbad8efb85",
"name": "adv_vms",
"edition": "advanced",
"usage_name": "vms",
"type": "count",
"measurement_unit": "quantity",
"range_start": "2017-06-01T00:00:00",
"absolute_value": 800,
"value": 800,
"offering_item": {
"status": 1,
"quota": {
"value": 10,
"overage": 10,
"version": 1486479690324
}
}
},
{
"application_id": "c6ab7fb4-b461-4214-9257-86fbad8efb85",
"name": "storage",
"edition": "standard",
"usage_name": "storage",
"type": "infra",
"measurement_unit": "bytes",
"infra_id": "df476eec-c470-40b0-9b10-37223b7f4a2b",
"range_start": "2017-06-22T00:00:00",
"absolute_value": 800,
"value": 800,
"offering_item": {
"status": 1,
"quota": {
"value": 1000,
"overage": 2000,
"version": 1486479690324
}
}
},
{
"application_id": "c6ab7fb4-b461-4214-9257-86fbad8efb85",
"name": "vm_storage",
"edition": "standard",
"usage_name": "vm_storage",
"range_start": "2017-06-01T00:00:00",
"type": "infra",
"measurement_unit": "bytes",
"absolute_value": 100000,
"value": 100000
}
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages OAuth 2.0 / OpenID Connect clients of the tenant.
get
Fetches a list of OAuth 2.0 / OpenID Connect clients registered with the tenant.
get /tenants/{tenant_id}/clients
Fetches a list of OAuth 2.0 / OpenID Connect clients registered with the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "types/uuid.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
}
}
},
"required": [
"items"
]
}
Example:
{
"items":[
"aa4f8923-8950-4804-8827-c6d78388e5b6",
"4eb7b320-48b4-4552-9bf8-f7482538da23"
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages users of the tenant.
get
Fetches a list of UUIDs of the tenant's users.
get /tenants/{tenant_id}/users
Fetches a list of UUIDs of the tenant's users.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- include_grand_children: (boolean - default: false)
If true, UUIDs of the users from child tenants may be included in the response.
- include_hidden: (boolean - default: false)
If true, hidden users may be included in the response.
- order: (string - default: name)
Orders the result by one of parameters:
as_is,login,status,name,roles,level,usage,mfa_status,contact_types. Reverse order can be performed using the-operator before the parameter.To order by
usage, the usage name should be specified after a dot, e.g.usage.workstations.For storage-dependent usages, the storage UUID is not required.
Default value is
name- order by first name and last name or login if names were not provided.Example:
-login - allow_deleted: (boolean)
If true, deleted users may be returned.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "types/uuid.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
}
}
},
"required": [
"items"
]
}
Example:
{
"items":[
"aa4f8923-8950-4804-8827-c6d78388e5b6",
"4eb7b320-48b4-4552-9bf8-f7482538da23"
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages tenant's children.
get
Fetches a list of UUIDs of the tenant's children.
get /tenants/{tenant_id}/children
Fetches a list of UUIDs of the tenant's children.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- order: (string - default: name)
Orders the result by one of parameters:
as_is,name,status,usage. Reverse order can be performed using the-operator before the parameter.For order by
usage, the usage name should be specified after a dot, e.g.usage.workstations.For storage-dependent usages, the storage UUID should be added after a dot, e.g.
usage.storage.c05d399b-ba6b-41e9-a638-cd7ffc7ec87a.Example:
-status - allow_deleted: (boolean)
If true, children may be returned.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "types/uuid.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
}
}
},
"required": [
"items"
]
}
Example:
{
"items":[
"aa4f8923-8950-4804-8827-c6d78388e5b6",
"4eb7b320-48b4-4552-9bf8-f7482538da23"
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages tenant reports.
get
Fetches a list of reports' UUIDs available to the tenant.
get /tenants/{tenant_id}/reports
Fetches a list of reports' UUIDs available to the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "types/uuid.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
}
}
},
"required": [
"items"
]
}
Example:
{
"items":[
"aa4f8923-8950-4804-8827-c6d78388e5b6",
"4eb7b320-48b4-4552-9bf8-f7482538da23"
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages tenant's identity providers.
get
Fetches a list of identity providers available to the tenant including registered and inherited from parent tenants.
get /tenants/{tenant_id}/identity_providers
Fetches a list of identity providers available to the tenant including registered and inherited from parent tenants.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
}
}
}
}
Example:
{
"items": ["1abc15ae-5349-4bb8-9262-89c5de9e9a5d", "84595658-c287-4752-a231-4a4245bdf7b8"]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages tenant's infrastructure components.
get
Fetches a list of infrastructure components owned by the tenant.
get /tenants/{tenant_id}/infra
Fetches a list of infrastructure components owned by the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"properties": {
"infras": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
}
}
}
}
Example:
{
"infras": [
"d9fd4cc3-4309-40a2-bd79-88da24a1c99d",
"7068976a-22c0-476e-ae3b-5f0469981ff1"
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages Tenant Infrastructure Locations
get
Fetches a list of infrastructure locations owned by the tenant.
get /tenants/{tenant_id}/locations
Fetches a list of infrastructure locations owned by the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"properties": {
"locations": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
}
}
}
}
Example:
{
"locations": [
"d9fd4cc3-4309-40a2-bd79-88da24a1c99d",
"7068976a-22c0-476e-ae3b-5f0469981ff1"
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages tenant's usages.
get
Fetches a list of common usage metrics of the tenant.
get /tenants/{tenant_id}/usages
Fetches a list of common usage metrics of the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- usage_names: (string)
A filter by comma-separated list of usage names.
Example:
storage,local_storage - editions: (string)
A filter by comma-separated list of editions.
Example:
standard,advanced,disaster_recovery
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"type": "object",
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"usageOutput": {
"$ref": "./usageOutput.json"
}
},
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/usageOutput"
}
}
},
"required": ["items"]
}
Example:
{
"items": [
{
"application_id": "c6ab7fb4-b461-4214-9257-86fbad8efb85",
"name": "adv_vms",
"edition": "advanced",
"usage_name": "vms",
"type": "count",
"measurement_unit": "quantity",
"range_start": "2017-06-01T00:00:00",
"absolute_value": 800,
"value": 800,
"offering_item": {
"status": 1,
"quota": {
"value": 10,
"overage": 10,
"version": 1486479690324
}
}
},
{
"application_id": "c6ab7fb4-b461-4214-9257-86fbad8efb85",
"name": "storage",
"edition": "standard",
"usage_name": "storage",
"type": "infra",
"measurement_unit": "bytes",
"infra_id": "df476eec-c470-40b0-9b10-37223b7f4a2b",
"range_start": "2017-06-22T00:00:00",
"absolute_value": 800,
"value": 800,
"offering_item": {
"status": 1,
"quota": {
"value": 1000,
"overage": 2000,
"version": 1486479690324
}
}
},
{
"application_id": "c6ab7fb4-b461-4214-9257-86fbad8efb85",
"name": "vm_storage",
"edition": "standard",
"usage_name": "vm_storage",
"range_start": "2017-06-01T00:00:00",
"type": "infra",
"measurement_unit": "bytes",
"absolute_value": 100000,
"value": 100000
}
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages pricing settings of the tenant.
get
Fetches pricing settings of the tenant.
put
Updates pricing settings of the tenant.
get /tenants/{tenant_id}/pricing
Fetches pricing settings of the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"definitions": {
"currency": {"$ref": "../_common/types/currency.json"},
"mode": {"$ref": "../_common/types/pricingMode.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"}
},
"properties": {
"mode": {
"description": "Mode of tenant's pricing.",
"$ref": "#/definitions/mode"
},
"currency": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/currency"}
],
"description": "Currency of all offering item prices for this tenant. This field can have a null value."
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"production_start_date": {
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/dateTime" }
],
"description": "Production pricing mode start date (timestamp)."
}
},
"required": [
"currency",
"mode",
"production_start_date",
"version"
]
}
Example:
{
"version": 1497533157730,
"mode": "production",
"currency": "USD",
"production_start_date": "2020-05-19T00:00:00"
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /tenants/{tenant_id}/pricing
Updates pricing settings of the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"definitions": {
"currency": {"$ref": "../_common/types/currency.json"},
"mode": {"$ref": "../_common/types/pricingMode.json"}
},
"properties": {
"mode": {
"description": "Mode of tenant's pricing.",
"$ref": "#/definitions/mode"
},
"currency": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/currency"}
],
"description": "Currency of all offering item prices for this tenant. This field can have a null value."
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
}
},
"required": [
"version"
]
}
Example:
{
"version": 1497533157730,
"mode": "production",
"currency": "USD"
}HTTP status code 200
Pricing settings was successfully updated.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"definitions": {
"currency": {"$ref": "../_common/types/currency.json"},
"mode": {"$ref": "../_common/types/pricingMode.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"}
},
"properties": {
"mode": {
"description": "Mode of tenant's pricing.",
"$ref": "#/definitions/mode"
},
"currency": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/currency"}
],
"description": "Currency of all offering item prices for this tenant. This field can have a null value."
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"production_start_date": {
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/dateTime" }
],
"description": "Production pricing mode start date (timestamp)."
}
},
"required": [
"currency",
"mode",
"production_start_date",
"version"
]
}
Example:
{
"version": 1497533157730,
"mode": "production",
"currency": "USD",
"production_start_date": "2020-05-19T00:00:00"
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages custom branding settings of the tenant.
delete
Disables custom branding for the tenant.
get
Fetches branding options of the tenant.
post
Enables custom branding options for the tenant.
This operation cannot be performed on customer and unit tenants.
put
Modifies custom branding options.
delete /tenants/{tenant_id}/brand
Disables custom branding for the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- version: required(integer)
Growing number of object internal version.
Example:
1559561146223
HTTP status code 204
Custom branding has been disabled.
Body
Media type: application/json
Type: json
Content:
{
"title": "Basic tenant schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"customerType": {"$ref": "../_common/types/customerType.json"},
"contact": {"$ref": "../_common/contact/contact.json"},
"tenantKind": {"$ref": "../_common/types/tenantKind.json"},
"uuid": {"$ref": "../_common/types/uuid.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"pricingMode": {"$ref": "../_common/types/pricingMode.json"}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier."
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Creation timestamp."
},
"updated_at": {
"$ref": "#/definitions/dateTime",
"description": "Last update timestamp, if tenant has just been created - then is equal to `created_at`, if tenant has just been deleted - then is equal to `deleted_at`."
},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
},
"production_start_date": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Tenant trial expiration date."
},
"name": {
"type": "string",
"description": "Human-readable name that will be displayed to the users."
},
"customer_type": {
"$ref": "#/definitions/customerType",
"description": "Business type of the tenant."
},
"parent_id": {
"type": "string",
"description": "ID of parent tenant. For the real root tenant the parent_id is equal to its id"
},
"kind": {
"$ref": "#/definitions/tenantKind",
"description": "Kind (type) of the tenant in hierarchy."
},
"contact": {
"description": "Tenant legal contact.",
"$ref": "#/definitions/contact"
},
"contacts": {
"description": "Empty array by default. Will be populated with all referencing contacts if query param `with_contacts` is provided.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/definitions/contact"
}
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the tenant is enabled or disabled."
},
"customer_id": {
"type": ["string", "null"],
"description": "ID from external system; for reporting purposes. This field can have a null value."
},
"brand_id": {
"type": ["integer", "null"],
"description": "Brand id for API v1."
},
"brand_uuid": {
"$ref": "#/definitions/uuid",
"description": "Brand ID for API v2."
},
"internal_tag": {
"type": ["string", "null"],
"description": "Internal tag. This field can have a null value."
},
"language": {
"type": "string",
"description": "Tenant`s preferred language."
},
"owner_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "Identifier of personal tenant owner user. This field can have a null value."
},
"has_children": {
"type": "boolean",
"description": "Flag, indicates if tenant has children."
},
"default_idp_id": {
"$ref": "#/definitions/uuid",
"description": "Default identity provider ID."
},
"update_lock": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, updating the tenant via API is not allowed to anyone except for users of the tenant that owns the lock."
},
"owner_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "ID of tenant that owns the lock (only users of this tenant can update the tenant in question). This field can have a null value."
}
},
"required": [
"enabled",
"owner_id"
]
},
"ancestral_access": {
"type": "boolean",
"description": "Indicates whether tenant's indirect ancestors have access to it."
},
"mfa_status": {
"type": "string",
"description": "Multi-factor authentication status of the tenant.",
"enum": [
"disabled",
"forcibly_disabled",
"setup_required",
"enabled"
]
},
"pricing_mode": {
"description": "Mode of tenant's pricing.",
"$ref": "#/definitions/pricingMode"
},
"external_operation_status": {
"oneOf": [
{"type": "null"},
{
"type": "string",
"enum": [
"deleting",
"recovering"
]
}
],
"description": "Indicates if some external operation in progress for this tenant."
}
},
"required": [
"id",
"version",
"created_at",
"updated_at",
"deleted_at",
"name",
"customer_type",
"parent_id",
"kind",
"contact",
"contacts",
"enabled",
"brand_id",
"internal_tag",
"language",
"has_children",
"update_lock",
"ancestral_access",
"mfa_status",
"pricing_mode"
]
}
Example:
{
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"version": 2,
"name": "The Qwerty Tenant",
"customer_type": "enterprise",
"parent_id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"kind": "partner",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": ["legal"],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "111111"
},
"contacts": [],
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"customer_id": "123asd",
"brand_id": 1,
"brand_uuid": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"internal_tag": null,
"language": "en",
"owner_id": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"has_children": true,
"ancestral_access": true,
"update_lock": {
"enabled": true,
"owner_id": "7decff12-ee1b-4f8d-b446-59610bfb9203"
},
"mfa_status": "enabled",
"pricing_mode": "production",
"production_start_date": null
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get /tenants/{tenant_id}/brand
Fetches branding options of the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"allOf": [
{
"$ref": "#/definitions/brand",
"required": ["support_phone", "id", "account_server_url", "support_url", "mobile_app_android_download_url", "upsell_url", "backup_console_url", "terms_url", "home_url", "knowledgebase_url", "platform_terms_url", "user_guide_url", "mobile_app_ios_download_url", "color", "company_name", "color_scheme", "service_name", "reg_server_url", "router_url", "agent_gateway_url", "help_url", "privacy_policy_url", "white_labeled_agent"]
},
{
"$ref": "#/definitions/smtp_settings",
"required": ["smtp_override", "smtp_reply_address", "smtp_server", "smtp_port", "smtp_user", "smtp_password", "smtp_encryption"]
}
],
"definitions": {
"brand": {"$ref": "brand_public.json"},
"smtp_settings": {"$ref": "smtp_settings.json"}
},
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema"
}
Example:
{
"account_server_url": "mc-cloud.acronis.com",
"backup_console_url": "mc-cloud.acronis.com/bc",
"color": "FFFFFF",
"color_scheme": "default",
"company_name": "acronis",
"help_url": "api/ams/links/help",
"hide_predefined": 1,
"home_url": "www.acronis.com",
"knowledgebase_url": "kb.acronis.com/errorcode/",
"logotype": "2f8ad2e2-28f2-11e7-aad1-5ffe2ad47151",
"mobile_app_android_download_url": "www.mobile.com/download",
"mobile_app_ios_download_url": "www.mobile.com/download",
"owns_custom_legal_docs": true,
"white_labeled_agent": true,
"platform_terms_url": "terms.acronis.com",
"privacy_policy_url": "https://www.acronis.com/company/privacy.html",
"reg_server_url": "https://rs.custom-cloud.acronis.com",
"router_url": "cloud.acronis.com",
"agent_gateway_url": "https://agents.custom-cloud.acronis.com",
"service_name": "myservice",
"smtp_encryption": "TLS",
"smtp_override": 1,
"smtp_password": "",
"smtp_port": 465,
"smtp_reply_address": "noreply@mycompany.com",
"smtp_server": "smtp.mycompany.com",
"smtp_user": "smtpuser",
"support_phone": "+1 1111 1111111",
"support_url": "support.acronis.com",
"terms_url": "terms.acronis.com",
"upsell_url": "www.partner.com/buy",
"user_guide_url": "guide.acronis.com"
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post /tenants/{tenant_id}/brand
Enables custom branding options for the tenant.
This operation cannot be performed on customer and unit tenants.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- version: required(integer)
Growing number of object internal version.
Example:
1559561146223
Body
Media type: application/json
Type: any
HTTP status code 201
Custom branding has been enabled.
Body
Media type: application/json
Type: json
Content:
{
"title": "Basic tenant schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"customerType": {"$ref": "../_common/types/customerType.json"},
"contact": {"$ref": "../_common/contact/contact.json"},
"tenantKind": {"$ref": "../_common/types/tenantKind.json"},
"uuid": {"$ref": "../_common/types/uuid.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"pricingMode": {"$ref": "../_common/types/pricingMode.json"}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier."
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Creation timestamp."
},
"updated_at": {
"$ref": "#/definitions/dateTime",
"description": "Last update timestamp, if tenant has just been created - then is equal to `created_at`, if tenant has just been deleted - then is equal to `deleted_at`."
},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
},
"production_start_date": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Tenant trial expiration date."
},
"name": {
"type": "string",
"description": "Human-readable name that will be displayed to the users."
},
"customer_type": {
"$ref": "#/definitions/customerType",
"description": "Business type of the tenant."
},
"parent_id": {
"type": "string",
"description": "ID of parent tenant. For the real root tenant the parent_id is equal to its id"
},
"kind": {
"$ref": "#/definitions/tenantKind",
"description": "Kind (type) of the tenant in hierarchy."
},
"contact": {
"description": "Tenant legal contact.",
"$ref": "#/definitions/contact"
},
"contacts": {
"description": "Empty array by default. Will be populated with all referencing contacts if query param `with_contacts` is provided.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/definitions/contact"
}
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the tenant is enabled or disabled."
},
"customer_id": {
"type": ["string", "null"],
"description": "ID from external system; for reporting purposes. This field can have a null value."
},
"brand_id": {
"type": ["integer", "null"],
"description": "Brand id for API v1."
},
"brand_uuid": {
"$ref": "#/definitions/uuid",
"description": "Brand ID for API v2."
},
"internal_tag": {
"type": ["string", "null"],
"description": "Internal tag. This field can have a null value."
},
"language": {
"type": "string",
"description": "Tenant`s preferred language."
},
"owner_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "Identifier of personal tenant owner user. This field can have a null value."
},
"has_children": {
"type": "boolean",
"description": "Flag, indicates if tenant has children."
},
"default_idp_id": {
"$ref": "#/definitions/uuid",
"description": "Default identity provider ID."
},
"update_lock": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, updating the tenant via API is not allowed to anyone except for users of the tenant that owns the lock."
},
"owner_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "ID of tenant that owns the lock (only users of this tenant can update the tenant in question). This field can have a null value."
}
},
"required": [
"enabled",
"owner_id"
]
},
"ancestral_access": {
"type": "boolean",
"description": "Indicates whether tenant's indirect ancestors have access to it."
},
"mfa_status": {
"type": "string",
"description": "Multi-factor authentication status of the tenant.",
"enum": [
"disabled",
"forcibly_disabled",
"setup_required",
"enabled"
]
},
"pricing_mode": {
"description": "Mode of tenant's pricing.",
"$ref": "#/definitions/pricingMode"
},
"external_operation_status": {
"oneOf": [
{"type": "null"},
{
"type": "string",
"enum": [
"deleting",
"recovering"
]
}
],
"description": "Indicates if some external operation in progress for this tenant."
}
},
"required": [
"id",
"version",
"created_at",
"updated_at",
"deleted_at",
"name",
"customer_type",
"parent_id",
"kind",
"contact",
"contacts",
"enabled",
"brand_id",
"internal_tag",
"language",
"has_children",
"update_lock",
"ancestral_access",
"mfa_status",
"pricing_mode"
]
}
Example:
{
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"version": 2,
"name": "The Qwerty Tenant",
"customer_type": "enterprise",
"parent_id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"kind": "partner",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": ["legal"],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "111111"
},
"contacts": [],
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"customer_id": "123asd",
"brand_id": 1,
"brand_uuid": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"internal_tag": null,
"language": "en",
"owner_id": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"has_children": true,
"ancestral_access": true,
"update_lock": {
"enabled": true,
"owner_id": "7decff12-ee1b-4f8d-b446-59610bfb9203"
},
"mfa_status": "enabled",
"pricing_mode": "production",
"production_start_date": null
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /tenants/{tenant_id}/brand
Modifies custom branding options.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- version: required(integer)
Growing number of object internal version.
Example:
1559561146223
Body
Media type: application/json
Type: json
Content:
{
"allOf": [
{
"$ref": "#/definitions/brand"
},
{
"$ref": "#/definitions/smtp_settings"
}
],
"definitions": {
"brand": {"$ref": "brand_public.json"},
"smtp_settings": {"$ref": "smtp_settings.json"}
},
"type": "object",
"$schema": "http://json-schema.org/draft-04/schema"
}
Example:
{
"account_server_url": "mc-cloud.acronis.com",
"color": "FFFFFF",
"color_scheme": "default",
"company_name": "mycompany",
"help_url": "help.acronis.com",
"home_url": "www.baas.com",
"knowledgebase_url": "kb.acronis.com/errorcode/",
"logotype": "2f8ad2e2-28f2-11e7-aad1-5ffe2ad47151",
"mobile_app_android_download_url": "www.mobile.com/download",
"mobile_app_ios_download_url": "www.mobile.com/download",
"owns_custom_legal_docs": false,
"white_labeled_agent": false,
"platform_terms_url": "terms.acronis.com",
"privacy_policy_url": "https://www.acronis.com/company/privacy.html",
"reg_server_url": "https://rs.custom-cloud.acronis.com",
"router_url": "cloud.acronis.com",
"agent_gateway_url": "https://agents.custom-cloud.acronis.com",
"service_name": "myservice",
"smtp_encryption": "TLS",
"smtp_override": 1,
"smtp_password": "**********",
"smtp_port": 465,
"smtp_reply_address": "noreply@mycompany.com",
"smtp_server": "smtp.mycompany.com",
"smtp_user": "smtpuser",
"support_phone": "+1 1111 1111111",
"support_url": "support.acronis.com",
"terms_url": "terms.acronis.com",
"upsell_url": "www.partner.com/buy",
"user_guide_url": "guide.acronis.com"
}
HTTP status code 200
Custom branding has been updated.
Body
Media type: application/json
Type: json
Content:
{
"title": "Basic tenant schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"customerType": {"$ref": "../_common/types/customerType.json"},
"contact": {"$ref": "../_common/contact/contact.json"},
"tenantKind": {"$ref": "../_common/types/tenantKind.json"},
"uuid": {"$ref": "../_common/types/uuid.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"pricingMode": {"$ref": "../_common/types/pricingMode.json"}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier."
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Creation timestamp."
},
"updated_at": {
"$ref": "#/definitions/dateTime",
"description": "Last update timestamp, if tenant has just been created - then is equal to `created_at`, if tenant has just been deleted - then is equal to `deleted_at`."
},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
},
"production_start_date": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Tenant trial expiration date."
},
"name": {
"type": "string",
"description": "Human-readable name that will be displayed to the users."
},
"customer_type": {
"$ref": "#/definitions/customerType",
"description": "Business type of the tenant."
},
"parent_id": {
"type": "string",
"description": "ID of parent tenant. For the real root tenant the parent_id is equal to its id"
},
"kind": {
"$ref": "#/definitions/tenantKind",
"description": "Kind (type) of the tenant in hierarchy."
},
"contact": {
"description": "Tenant legal contact.",
"$ref": "#/definitions/contact"
},
"contacts": {
"description": "Empty array by default. Will be populated with all referencing contacts if query param `with_contacts` is provided.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/definitions/contact"
}
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the tenant is enabled or disabled."
},
"customer_id": {
"type": ["string", "null"],
"description": "ID from external system; for reporting purposes. This field can have a null value."
},
"brand_id": {
"type": ["integer", "null"],
"description": "Brand id for API v1."
},
"brand_uuid": {
"$ref": "#/definitions/uuid",
"description": "Brand ID for API v2."
},
"internal_tag": {
"type": ["string", "null"],
"description": "Internal tag. This field can have a null value."
},
"language": {
"type": "string",
"description": "Tenant`s preferred language."
},
"owner_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "Identifier of personal tenant owner user. This field can have a null value."
},
"has_children": {
"type": "boolean",
"description": "Flag, indicates if tenant has children."
},
"default_idp_id": {
"$ref": "#/definitions/uuid",
"description": "Default identity provider ID."
},
"update_lock": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, updating the tenant via API is not allowed to anyone except for users of the tenant that owns the lock."
},
"owner_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "ID of tenant that owns the lock (only users of this tenant can update the tenant in question). This field can have a null value."
}
},
"required": [
"enabled",
"owner_id"
]
},
"ancestral_access": {
"type": "boolean",
"description": "Indicates whether tenant's indirect ancestors have access to it."
},
"mfa_status": {
"type": "string",
"description": "Multi-factor authentication status of the tenant.",
"enum": [
"disabled",
"forcibly_disabled",
"setup_required",
"enabled"
]
},
"pricing_mode": {
"description": "Mode of tenant's pricing.",
"$ref": "#/definitions/pricingMode"
},
"external_operation_status": {
"oneOf": [
{"type": "null"},
{
"type": "string",
"enum": [
"deleting",
"recovering"
]
}
],
"description": "Indicates if some external operation in progress for this tenant."
}
},
"required": [
"id",
"version",
"created_at",
"updated_at",
"deleted_at",
"name",
"customer_type",
"parent_id",
"kind",
"contact",
"contacts",
"enabled",
"brand_id",
"internal_tag",
"language",
"has_children",
"update_lock",
"ancestral_access",
"mfa_status",
"pricing_mode"
]
}
Example:
{
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"version": 2,
"name": "The Qwerty Tenant",
"customer_type": "enterprise",
"parent_id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"kind": "partner",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": ["legal"],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "111111"
},
"contacts": [],
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"customer_id": "123asd",
"brand_id": 1,
"brand_uuid": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"internal_tag": null,
"language": "en",
"owner_id": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"has_children": true,
"ancestral_access": true,
"update_lock": {
"enabled": true,
"owner_id": "7decff12-ee1b-4f8d-b446-59610bfb9203"
},
"mfa_status": "enabled",
"pricing_mode": "production",
"production_start_date": null
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages brand's logo.
get
Fetches tenant's brand logo.
post
Uploads a new tenant's brand logo.
get /tenants/{tenant_id}/brand/logo
Fetches tenant's brand logo.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Headers
- Cache-Control: (string)
Example:
max-age=86400, must-revalidate - Content-Length: required(integer)
Body
Media type: image/png
Type: any
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post /tenants/{tenant_id}/brand/logo
Uploads a new tenant's brand logo.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Headers
- Content-Length: required(integer)
Query Parameters
- version: required(integer)
Growing number of object internal version.
Example:
1559561146223
Body
Media type: image/png
Type: any
HTTP status code 201
Body
Media type: application/json
Type: json
Content:
{
"title": "Basic tenant schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"customerType": {"$ref": "../_common/types/customerType.json"},
"contact": {"$ref": "../_common/contact/contact.json"},
"tenantKind": {"$ref": "../_common/types/tenantKind.json"},
"uuid": {"$ref": "../_common/types/uuid.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"pricingMode": {"$ref": "../_common/types/pricingMode.json"}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier."
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Creation timestamp."
},
"updated_at": {
"$ref": "#/definitions/dateTime",
"description": "Last update timestamp, if tenant has just been created - then is equal to `created_at`, if tenant has just been deleted - then is equal to `deleted_at`."
},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
},
"production_start_date": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Tenant trial expiration date."
},
"name": {
"type": "string",
"description": "Human-readable name that will be displayed to the users."
},
"customer_type": {
"$ref": "#/definitions/customerType",
"description": "Business type of the tenant."
},
"parent_id": {
"type": "string",
"description": "ID of parent tenant. For the real root tenant the parent_id is equal to its id"
},
"kind": {
"$ref": "#/definitions/tenantKind",
"description": "Kind (type) of the tenant in hierarchy."
},
"contact": {
"description": "Tenant legal contact.",
"$ref": "#/definitions/contact"
},
"contacts": {
"description": "Empty array by default. Will be populated with all referencing contacts if query param `with_contacts` is provided.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/definitions/contact"
}
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the tenant is enabled or disabled."
},
"customer_id": {
"type": ["string", "null"],
"description": "ID from external system; for reporting purposes. This field can have a null value."
},
"brand_id": {
"type": ["integer", "null"],
"description": "Brand id for API v1."
},
"brand_uuid": {
"$ref": "#/definitions/uuid",
"description": "Brand ID for API v2."
},
"internal_tag": {
"type": ["string", "null"],
"description": "Internal tag. This field can have a null value."
},
"language": {
"type": "string",
"description": "Tenant`s preferred language."
},
"owner_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "Identifier of personal tenant owner user. This field can have a null value."
},
"has_children": {
"type": "boolean",
"description": "Flag, indicates if tenant has children."
},
"default_idp_id": {
"$ref": "#/definitions/uuid",
"description": "Default identity provider ID."
},
"update_lock": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, updating the tenant via API is not allowed to anyone except for users of the tenant that owns the lock."
},
"owner_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "ID of tenant that owns the lock (only users of this tenant can update the tenant in question). This field can have a null value."
}
},
"required": [
"enabled",
"owner_id"
]
},
"ancestral_access": {
"type": "boolean",
"description": "Indicates whether tenant's indirect ancestors have access to it."
},
"mfa_status": {
"type": "string",
"description": "Multi-factor authentication status of the tenant.",
"enum": [
"disabled",
"forcibly_disabled",
"setup_required",
"enabled"
]
},
"pricing_mode": {
"description": "Mode of tenant's pricing.",
"$ref": "#/definitions/pricingMode"
},
"external_operation_status": {
"oneOf": [
{"type": "null"},
{
"type": "string",
"enum": [
"deleting",
"recovering"
]
}
],
"description": "Indicates if some external operation in progress for this tenant."
}
},
"required": [
"id",
"version",
"created_at",
"updated_at",
"deleted_at",
"name",
"customer_type",
"parent_id",
"kind",
"contact",
"contacts",
"enabled",
"brand_id",
"internal_tag",
"language",
"has_children",
"update_lock",
"ancestral_access",
"mfa_status",
"pricing_mode"
]
}
Example:
{
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"version": 2,
"name": "The Qwerty Tenant",
"customer_type": "enterprise",
"parent_id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"kind": "partner",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": ["legal"],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "111111"
},
"contacts": [],
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"customer_id": "123asd",
"brand_id": 1,
"brand_uuid": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"internal_tag": null,
"language": "en",
"owner_id": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"has_children": true,
"ancestral_access": true,
"update_lock": {
"enabled": true,
"owner_id": "7decff12-ee1b-4f8d-b446-59610bfb9203"
},
"mfa_status": "enabled",
"pricing_mode": "production",
"production_start_date": null
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages legal documents of the tenant.
get
Fetches legal documents of the tenant.
Available in cloud version only.
post
Available in cloud version only.
Creates a new legal document associated with the tenant.
get /tenants/{tenant_id}/legal_documents
Fetches legal documents of the tenant.
Available in cloud version only.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"agreement": {"$ref": "legalDocument.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/agreement"
}
}
},
"additionalProperties": false,
"required": [
"items"
]
}
Example:
{
"items": [
{
"document_version": "2019-04-04",
"comment": "comment",
"created": "2016-06-22T19:25:16",
"id": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"link": "https://acronis.com/eula-2019-04-04?language=[Language]",
"added_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"changed_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"covered_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"common_part_update": true,
"owner_tenant": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"added_by": "e6ac14fe-b53a-4120-862d-1c9d7cdc7980",
"published": "2016-06-22T19:25:16",
"grace_period": 30,
"document_type": "eula",
"version": 1497533157730
},
{
"document_version": "2019-04-04",
"comment": "comment",
"created": "2016-06-22T19:25:16",
"id": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"link": "https://acronis.com/eula-2019-04-04?language=[Language]",
"added_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"changed_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"covered_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"common_part_update": false,
"owner_tenant": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"added_by": "e6ac14fe-b53a-4120-862d-1c9d7cdc7980",
"published": null,
"grace_period": 30,
"document_type": "privacy_statement",
"version": 1497533157730
},
{
"document_version": "2019-04-04",
"comment": "comment",
"created": "2016-06-22T19:25:16",
"id": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"link": "https://acronis.com/eula-2019-04-04?language=[Language]",
"added_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"changed_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"covered_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"common_part_update": true,
"owner_tenant": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"added_by": "e6ac14fe-b53a-4120-862d-1c9d7cdc7980",
"published": null,
"grace_period": 30,
"document_type": "platform_terms",
"version": 1497533157730
}
]
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post /tenants/{tenant_id}/legal_documents
Available in cloud version only.
Creates a new legal document associated with the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"url": {"$ref": "../_common/types/url.json"}
},
"properties": {
"document_type": {
"description": "Type of a document.",
"type": "string"
},
"comment": {
"description": "Document description.",
"type": "string"
},
"common_part_update": {
"description": "Flag that represents if document contains common part update.",
"type": "boolean"
},
"changed_items": {
"description": "Items changed in a given version compared to a previous one.",
"type": "object",
"properties": {
"offering_items": {
"type": "array",
"items": {
"type": "string"
}
},
"backend_types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"link": {
"description": "Link to a document.",
"$ref": "#/definitions/url"
},
"grace_period": {
"description": "Grace period for accepting given document.\nCountdown will start after a first preposition to sign it.",
"type": "integer"
}
},
"required": [
"document_type",
"common_part_update",
"changed_items",
"link"
],
"additionalProperties": false,
"type": "object"
}
Example:
{
"comment": "End-user license agreement",
"document_type": "eula",
"link": "https://acronis.com/eula-2019-04-04?language=[Language]",
"common_part_update": true,
"changed_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
}
}
HTTP status code 201
Legal document was successfully created.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"date": {"$ref": "../_common/types/date.json"},
"datetime": {"$ref": "../_common/types/dateTime.json"},
"url": {"$ref": "../_common/types/url.json"},
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"properties": {
"comment": {
"description": "Document description. This field can have a null value.",
"type": ["string", "null"]
},
"common_part_update": {
"description": "Flag that represents if document contains common part update.",
"type": "boolean"
},
"changed_items": {
"description": "Items changed in a given version compared to a previous one.",
"type": "object",
"properties": {
"offering_items": {
"type": "array",
"items": {
"type": "string"
}
},
"backend_types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"covered_items": {
"description": "Full set of items covered by a given document.",
"type": "object",
"properties": {
"offering_items": {
"type": "array",
"items": {
"type": "string"
}
},
"backend_types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"added_items": {
"description": "Set of items that appeared just in a current version.",
"type": "object",
"properties": {
"offering_items": {
"type": "array",
"items": {
"type": "string"
}
},
"backend_types": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"grace_period": {
"description": "Grace period for accepting given document.\nCountdown will start after a first preposition to sign it.",
"type": "integer"
},
"id": {
"description": "Unique identifier for this document.",
"$ref": "#/definitions/uuid"
},
"link": {
"description": "Link to a document.",
"$ref": "#/definitions/url"
},
"owner_tenant": {
"description": "Owner tenant uuid.",
"$ref": "#/definitions/uuid"
},
"added_by": {
"description": "User which added document.",
"$ref": "#/definitions/uuid"
},
"published": {
"description": "Publication time if document was made available for partners, null if document still could be changed. This field can have a null value.",
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/datetime"
}
]
},
"document_type": {
"type": "string",
"description": "Type of a document.",
"enum": ["eula", "privacy_statement", "platform_terms"]
},
"document_version": {
"$ref": "#/definitions/date",
"description": "Document version (provided by parsing document url)."
},
"created": {
"$ref": "#/definitions/datetime",
"description": "Time of document creation."
},
"version": {
"type": "integer",
"description": "Internal version (auto-incremented entity version)."
}
},
"additionalProperties": false,
"required": [
"comment",
"common_part_update",
"changed_items",
"covered_items",
"created",
"document_type",
"grace_period",
"id",
"link",
"owner_tenant",
"published",
"document_version",
"version"
],
"type": "object"
}
Example:
{
"document_version": "2019-04-04",
"created": "2016-06-22T19:25:16",
"comment": "End-user licence agreement",
"id": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"link": "https://acronis.com/eula-2019-04-04?language=[Language]",
"added_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"changed_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"covered_items": {
"offering_items": [
"workstations",
"vms"
],
"backend_types": [
"azure"
]
},
"common_part_update": false,
"owner_tenant": "4a2cbe2d-b7ab-4b17-9cba-10c7eb55de01",
"added_by": "e6ac14fe-b53a-4120-862d-1c9d7cdc7980",
"published": "2016-06-22T19:25:16",
"grace_period": 30,
"document_type": "eula",
"version": 1497533157730
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages multi-factor authentication (MFA) settings of the tenant.
put
Toggles MFA status for the tenant. This operation cannot be performed on folder and unit tenants.
get
Provides MFA status for tenant and progress of TOTP enablement by users.
put /tenants/{tenant_id}/mfa/status
Toggles MFA status for the tenant. This operation cannot be performed on folder and unit tenants.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"description": "Status of MFA for tenant."
}
},
"required": [
"enabled"
]
}
Example:
{
"enabled": true
}
HTTP status code 200
MFA status was successfully changed.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"mfa_status": {
"type": "string",
"description": "Status of MFA for tenant.",
"enum": [
"disabled",
"disable_in_progress",
"enabled"
]
},
"users": {
"type": "integer",
"description": "Total number of active users in this tenant (including child folders or units of the same organization)."
},
"users_with_totp_enabled": {
"type": "integer",
"description": "Number of users in this tenant (including child folders or units of the same organization) with TOTP configured."
},
"update_allowed": {
"type": "boolean",
"description": "True if logged in user can change MFA status for this tenant."
}
},
"required": [
"mfa_status",
"users_count",
"users_with_totp_enabled_count",
"update_allowed"
]
}
Example:
{
"mfa_status": "enabled",
"users_count": 100,
"users_with_totp_enabled_count": 20,
"update_allowed": true
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get /tenants/{tenant_id}/mfa/status
Provides MFA status for tenant and progress of TOTP enablement by users.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"mfa_status": {
"type": "string",
"description": "Status of MFA for tenant.",
"enum": [
"disabled",
"disable_in_progress",
"enabled"
]
},
"users": {
"type": "integer",
"description": "Total number of active users in this tenant (including child folders or units of the same organization)."
},
"users_with_totp_enabled": {
"type": "integer",
"description": "Number of users in this tenant (including child folders or units of the same organization) with TOTP configured."
},
"update_allowed": {
"type": "boolean",
"description": "True if logged in user can change MFA status for this tenant."
}
},
"required": [
"mfa_status",
"users_count",
"users_with_totp_enabled_count",
"update_allowed"
]
}
Example:
{
"mfa_status": "enabled",
"users_count": 100,
"users_with_totp_enabled_count": 20,
"update_allowed": true
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages tenant's contacts.
get
Fetches a list of contacts' UUIDs referenced with the tenant.
get /tenants/{tenant_id}/contacts
Fetches a list of contacts' UUIDs referenced with the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- allow_deleted: (boolean - default: false)
If true, deleted contacts may be returned.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "types/uuid.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
}
}
},
"required": [
"items"
]
}
Example:
{
"items":[
"aa4f8923-8950-4804-8827-c6d78388e5b6",
"4eb7b320-48b4-4552-9bf8-f7482538da23"
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Update tenant default identity provider id
put
Updates Tenant default_idp_id.
put /tenants/{tenant_id}/default_idp
Updates Tenant default_idp_id.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"required":[
"version",
"idp_id",
"apply_to_children"
],
"type": "object",
"additionalProperties": false,
"properties": {
"version": {
"type": "integer",
"description": "Tenant`s version."
},
"idp_id": {
"$ref": "#/definitions/uuid",
"description": "identity provider ID to be set as default for tenant"
},
"apply_to_children": {
"type": "boolean",
"description": "If True - new default identity provider ID will be set to tenant's children as well"
}
}
}
Example:
{
"version": 1,
"idp_id": "c4878582-6e14-451e-9bda-3ff899b3f700",
"apply_to_children": true
}
HTTP status code 200
Tenant default_idp_id successfully updated
Body
Media type: application/json
Type: json
Content:
{
"title": "Basic tenant schema",
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"customerType": {"$ref": "../_common/types/customerType.json"},
"contact": {"$ref": "../_common/contact/contact.json"},
"tenantKind": {"$ref": "../_common/types/tenantKind.json"},
"uuid": {"$ref": "../_common/types/uuid.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"pricingMode": {"$ref": "../_common/types/pricingMode.json"}
},
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/uuid",
"description": "Unique identifier."
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Creation timestamp."
},
"updated_at": {
"$ref": "#/definitions/dateTime",
"description": "Last update timestamp, if tenant has just been created - then is equal to `created_at`, if tenant has just been deleted - then is equal to `deleted_at`."
},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
},
"production_start_date": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Tenant trial expiration date."
},
"name": {
"type": "string",
"description": "Human-readable name that will be displayed to the users."
},
"customer_type": {
"$ref": "#/definitions/customerType",
"description": "Business type of the tenant."
},
"parent_id": {
"type": "string",
"description": "ID of parent tenant. For the real root tenant the parent_id is equal to its id"
},
"kind": {
"$ref": "#/definitions/tenantKind",
"description": "Kind (type) of the tenant in hierarchy."
},
"contact": {
"description": "Tenant legal contact.",
"$ref": "#/definitions/contact"
},
"contacts": {
"description": "Empty array by default. Will be populated with all referencing contacts if query param `with_contacts` is provided.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/definitions/contact"
}
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the tenant is enabled or disabled."
},
"customer_id": {
"type": ["string", "null"],
"description": "ID from external system; for reporting purposes. This field can have a null value."
},
"brand_id": {
"type": ["integer", "null"],
"description": "Brand id for API v1."
},
"brand_uuid": {
"$ref": "#/definitions/uuid",
"description": "Brand ID for API v2."
},
"internal_tag": {
"type": ["string", "null"],
"description": "Internal tag. This field can have a null value."
},
"language": {
"type": "string",
"description": "Tenant`s preferred language."
},
"owner_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "Identifier of personal tenant owner user. This field can have a null value."
},
"has_children": {
"type": "boolean",
"description": "Flag, indicates if tenant has children."
},
"default_idp_id": {
"$ref": "#/definitions/uuid",
"description": "Default identity provider ID."
},
"update_lock": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "If true, updating the tenant via API is not allowed to anyone except for users of the tenant that owns the lock."
},
"owner_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "ID of tenant that owns the lock (only users of this tenant can update the tenant in question). This field can have a null value."
}
},
"required": [
"enabled",
"owner_id"
]
},
"ancestral_access": {
"type": "boolean",
"description": "Indicates whether tenant's indirect ancestors have access to it."
},
"mfa_status": {
"type": "string",
"description": "Multi-factor authentication status of the tenant.",
"enum": [
"disabled",
"forcibly_disabled",
"setup_required",
"enabled"
]
},
"pricing_mode": {
"description": "Mode of tenant's pricing.",
"$ref": "#/definitions/pricingMode"
},
"external_operation_status": {
"oneOf": [
{"type": "null"},
{
"type": "string",
"enum": [
"deleting",
"recovering"
]
}
],
"description": "Indicates if some external operation in progress for this tenant."
}
},
"required": [
"id",
"version",
"created_at",
"updated_at",
"deleted_at",
"name",
"customer_type",
"parent_id",
"kind",
"contact",
"contacts",
"enabled",
"brand_id",
"internal_tag",
"language",
"has_children",
"update_lock",
"ancestral_access",
"mfa_status",
"pricing_mode"
]
}
Example:
{
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"version": 2,
"name": "The Qwerty Tenant",
"customer_type": "enterprise",
"parent_id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"kind": "partner",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": ["legal"],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "111111"
},
"contacts": [],
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"customer_id": "123asd",
"brand_id": 1,
"brand_uuid": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"internal_tag": null,
"language": "en",
"owner_id": "03fa8bf4-28f2-11e7-ba28-cbe99c3c450a",
"has_children": true,
"ancestral_access": true,
"update_lock": {
"enabled": true,
"owner_id": "7decff12-ee1b-4f8d-b446-59610bfb9203"
},
"mfa_status": "enabled",
"pricing_mode": "production",
"production_start_date": null
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post
Restores previously soft deleted tenant.
post /tenants/{tenant_id}/restore
Restores previously soft deleted tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- force: (boolean)
Defines if tenant should be restored in in case of a conflict with another tenant or user who has taken the same name or login. In such a case restored tenant will have postfix added.
HTTP status code 204
Tenant was successfully restored.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages tenant's access policies
get
Fetches a list of access policies of the tenant.
get /tenants/{tenant_id}/access_policies
Fetches a list of access policies of the tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- trusteeType: (one of user, client, user_group)
Filters policies by provided trustee types. Empty parameter disables filtering.
The following trustee types can be specified:
userclientuser_group
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"accessPolicy": {"$ref": "./accessPolicy.json"}
},
"type": "object",
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/accessPolicy"
}
}
},
"required": [
"items",
"timestamp"
]
}
Example:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"id": "00000000-0000-0000-0000-000000000005",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "hci_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "hci",
"resource_path": "res1"
},
{
"id": "00000000-0000-0000-0000-000000000004",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "notary_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "notary",
"resource_path": "res4/res5"
},
{
"id": "00000000-0000-0000-0000-000000000002",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "pds_operator",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5"
},
{
"id": "00000000-0000-0000-0000-000000000003",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "pds_support",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5"
}
]
}HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "bad request",
"details": {
"info": "Request body contains badly-formed JSON."
}
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages tenant's settings
get
Fetches application settings for the provided tenant.
get /tenants/{tenant_id}/settings
Fetches application settings for the provided tenant.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- tenant_id: required(json)
Tenant ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"settings": {
"type": "array",
"items": {
"$ref": "setting.json"
}
}
},
"required": [
"settings"
]
}
Example:
{
"settings": [
{
"name": "setting_1",
"application_id": "2f2a4239-f140-4337-a107-bed298fed3f1",
"own": {
"value": "new_stuff",
"lock": false,
"exclusive": false
},
"effective": {
"owner": {
"type": "tenant",
"id": "81129b10-9f2a-4ee7-bf90-8698c4af055c"
},
"hidden": false,
"value": "old_Stuff",
"lock": false
}
}
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/tenants:resolve_ids
post
Resolves tenants' numeric IDs to UUIDs.
post /tenants:resolve_ids
Resolves tenants' numeric IDs to UUIDs.
Secured by oauth2 with scopes:
- urn:acronis.com::acep::consumer
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"definitions": {
"id": {"$ref": "../_common/types/id.json"}
},
"properties": {
"items": {
"type": "array",
"maxItems": 100,
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/id",
"description": "Numeric identifier of tenant."
}
},
"required": ["id"]
}
}
},
"required": ["items"]
}
Example:
{
"items": [
{
"id": 1
},
{
"id": 2
}
]
}HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"definitions": {
"id": {"$ref": "../_common/types/id.json"},
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"$ref": "#/definitions/id",
"description": "Numeric identifier of tenant."
},
"uuid": {
"$ref": "#/definitions/uuid",
"description": "UUID of tenant."
}
},
"required": ["id", "uuid"]
}
}
},
"required": ["items"]
}
Example:
{
"items": [
{
"id": 1,
"uuid": "14244b25-d085-45a4-8923-ec53ad4b19af"
},
{
"id": 2,
"uuid": "e1108992-6d7c-4acd-8d6b-fd614e6486e5"
}
]
}HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/users
Manages Users
get
Fetches a batch of users.
Available in cloud version only.
post
Creates a new user. If the user is created in a customer tenant and below - a personal tenant will be created and attached to it.
get /users
Fetches a batch of users.
Available in cloud version only.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- uuids: (json)
A filter by comma-separated list of users' UUIDs. Maximum of 100 UUIDs. Is mutually exclusive with
subtree_root_tenant_id,external_idsandtenant_id. - origin_id: (string)
A filter by specific origin ID
Example:
pillr.mdr - external_ids: (string)
A filter by comma-separated list of users' UUIDs in the external Identity Provider. Maximum of 100 UUIDs. Is mutually exclusive with
subtree_root_tenant_idanduuids.Example:
fae84e50-0eef-11e7-bc3f-d39de3f5fe32,fae84e50-0eef-11e7-bc3f-d39de3f5fe32 - tenant_id: (json)
A filter by specific tenant ID. Required when searching the users by
external_id. Not used otherwise.Example:
fae84e50-0eef-11e7-bc3f-d39de3f5fe32 - subtree_root_tenant_id: (json)
A filter by tenants tree starting from the specified tenant ID. Is mutually exclusive with
uuidsandtenant_id.Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed - updated_since: (datetime)
A filter by users that were updated after the specified RFC3339 timestamp in UTC time zone.
Example:
2016-02-28T16:41:41.090Z - limit: (integer - default: 2000 - minimum: 1)
Number of elements in current users page of the response.
- after: (string)
Cursor to fetch the next users page. The cursor encodes all the filtering and sorting arguments, thus client does not need to provide all them for the next page, only cursor should be provided. Client can get the cursor from
paging.cursors.afterfield of the previous page response. - lod: (one of stamps, basic, full - default: full)
A predefined level of details for the user object to return.
The following levels of details can be specified:
stamps- includesid,tenant_id,version,created_at,updated_at,deleted_at.basic- includeslogin,personal_tenant_id,enabled.full- includes all the fields.
- with_access_policies: (boolean)
If true, all users' access policies will be returned in the response.
- allow_deleted: (boolean)
If true, deleted users may be returned.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"user": {"$ref": "./user.json"}
},
"type": "object",
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/user"
}
}
},
"required": [
"items",
"timestamp"
]
}
Examples:
default:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"id": "fae84e50-0eef-11e7-bc3f-d39de3f5fe32",
"version": 2,
"tenant_id": "7ea1cf00-0ef0-11e7-8741-bb83f58f591f",
"login": "some_login_1",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": [],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "",
"language": "en",
"fax": "123 Example Street"
},
"activated": true,
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"language": "en",
"personal_tenant_id": "2f8ad2e2-28f2-11e7-aad1-5ffe2ad47151",
"business_types": [],
"origin_id": "pillr.mdr",
"origin_external_id": "c66b1af2-2ac5-4764-8db6-97b054e7d27e",
"disable_after": "2017-06-22T18:25:16",
"notifications": [
"maintenance",
"quota",
"reports",
"backup_error",
"backup_warning",
"backup_info",
"backup_daily_report",
"backup_critical",
"device_control_warning",
"certificate_management_error",
"certificate_management_warning",
"certificate_management_info"
]
},
{
"id": "76137b0e-0ef0-11e7-b5c2-1f8159df2571",
"version": 2,
"tenant_id": "7ea1cf00-0ef0-11e7-8741-bb83f58f591f",
"login": "some_login_2",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": [],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Smith",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "",
"fax": "123 Example Street",
"language": "en"
},
"activated": true,
"enabled": true,
"created_at": "2016-06-22T18:27:11",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"language": "ru",
"personal_tenant_id": "2f8ad2e2-28f2-11e7-aad1-5ffe2ad47151",
"business_types": ["buyer"],
"origin_id": "pillr.mdr",
"origin_external_id": "c66b1af2-2ac5-4764-8db6-97b054e7d27e",
"disable_after": "2017-06-22T18:25:16",
"notifications": [
"maintenance",
"quota",
"reports",
"backup_error",
"backup_warning",
"backup_info",
"backup_daily_report",
"backup_critical",
"device_control_warning"
],
"external_operation_status": "recovering"
}
]
}
withAccessPolicies:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"id": "fae84e50-0eef-11e7-bc3f-d39de3f5fe32",
"version": 2,
"tenant_id": "7ea1cf00-0ef0-11e7-8741-bb83f58f591f",
"login": "some_login_1",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": [],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"external_id": "111111"
},
"activated": true,
"origin_id": "pillr.mdr",
"origin_external_id": "c66b1af2-2ac5-4764-8db6-97b054e7d27e",
"disable_after": "2017-06-22T18:25:16",
"enabled": true,
"access_policies": [
{
"id": "fb261178-06bc-4268-9337-9639e049e1c8",
"issuer_id": "48ef84eb-b0dc-4ade-83d1-0662c8b54f6d",
"trustee_id": "fae84e50-0eef-11e7-bc3f-d39de3f5fe32",
"trustee_type": "user",
"tenant_id": "7ea1cf00-0ef0-11e7-8741-bb83f58f591f",
"role_id": "unit_admin",
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"version": 1
}
],
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"language": "en",
"personal_tenant_id": "2f8ad2e2-28f2-11e7-aad1-5ffe2ad47151",
"business_types": [],
"notifications": [
"maintenance",
"quota",
"reports",
"backup_error",
"backup_warning",
"backup_info",
"backup_daily_report",
"backup_critical"
]
},
{
"id": "76137b0e-0ef0-11e7-b5c2-1f8159df2571",
"version": 2,
"tenant_id": "7ea1cf00-0ef0-11e7-8741-bb83f58f591f",
"login": "some_login_2",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": [],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Smith",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"external_id": "111111"
},
"activated": true,
"enabled": true,
"origin_id": "pillr.mdr",
"origin_external_id": "c66b1af2-2ac5-4764-8db6-97b054e7d27e",
"disable_after": "2017-06-22T18:25:16",
"access_policies": [
{
"id": "fb261178-06bc-4268-9337-9639e049e1c8",
"issuer_id": "48ef84eb-b0dc-4ade-83d1-0662c8b54f6d",
"trustee_id": "76137b0e-0ef0-11e7-b5c2-1f8159df2571",
"trustee_type": "user",
"tenant_id": "7ea1cf00-0ef0-11e7-8741-bb83f58f591f",
"role_id": "unit_admin",
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"version": 1
}
],
"created_at": "2016-06-22T18:27:11",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"language": "ru",
"personal_tenant_id": "2f8ad2e2-28f2-11e7-aad1-5ffe2ad47151",
"business_types": ["buyer"],
"notifications": [
"maintenance",
"quota",
"reports",
"backup_error",
"backup_warning",
"backup_info",
"backup_daily_report",
"backup_critical"
]
}
]
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "bad request",
"details": {
"info": "Request body contains badly-formed JSON."
}
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post /users
Creates a new user. If the user is created in a customer tenant and below - a personal tenant will be created and attached to it.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"commonContactPost": {"$ref": "../_common/contact/contactPost.json"},
"uuid": {"$ref": "../_common/types/uuid.json"},
"business_types": {"$ref": "../_common/types/business_types.json"},
"userNotifications": {"$ref": "../_common/types/userNotifications.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"tenant_id": {
"type": "string",
"description": "ID of tenant this user belongs to."
},
"login": {
"type": "string",
"description": "User's login."
},
"external_id": {
"type": "string",
"description": "User's ID in external identity provider (e.g. SID in AD)."
},
"idp_id": {
"$ref": "#/definitions/uuid",
"description": "Identity provider UUID."
},
"contact": {
"$ref": "#/definitions/commonContactPost"
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the user is enabled or disabled."
},
"language": {
"type": "string",
"description": "Preferred locale."
},
"business_types": {
"$ref": "#/definitions/business_types"
},
"notifications": {
"$ref": "#/definitions/userNotifications",
"_comment": "possible values are: [maintenance, quota, reports, backup_error, backup_warning, backup_info, backup_daily_report, backup_critical, device_control_warning, certificate_management_error, certificate_management_warning, certificate_management_info]"
},
"use_existing_identity": {
"type": "boolean",
"description": "Use existing identity (user with same login already exists)."
},
"origin_id": {
"type": "string",
"description": "User's origin ID, for example, ID of a Cyber Application responsible for creating this user."
},
"origin_external_id": {
"type": "string",
"description": "User's external origin ID."
},
"disable_after": {
"$ref": "#/definitions/dateTime",
"description": "Timestamp indicating when the user will be disabled."
}
},
"required": [
"tenant_id"
]
}
Example:
{
"tenant_id": "0ef03214-6e47-4e50-87f2-a5955ba6095c",
"login": "mylogin",
"contact": {
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe"
},
"enabled": true,
"origin_id": "pillr.mdr",
"origin_external_id": "c66b1af2-2ac5-4764-8db6-97b054e7d27e",
"disable_after": "2017-06-22T18:25:16",
"language": "ru",
"business_types": ["buyer"],
"notifications": [
"maintenance",
"quota",
"reports",
"backup_error",
"backup_warning",
"backup_info",
"backup_daily_report",
"backup_critical",
"device_control_warning",
"certificate_management_error",
"certificate_management_warning",
"certificate_management_info"
]
}
HTTP status code 200
User was successfully created.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"contact": {"$ref": "../_common/contact/contact.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"business_types": {"$ref": "../_common/types/business_types.json"},
"userNotifications": {"$ref": "../_common/types/userNotifications.json"}
},
"type": "object",
"properties": {
"id": {
"description": "Unique identifier.",
"$ref": "#/definitions/uuid"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"tenant_id": {
"description": "ID of tenant this user belongs to.",
"$ref": "#/definitions/uuid"
},
"login": {
"type": "string",
"description": "User's login."
},
"contact": {
"$ref": "#/definitions/contact"
},
"activated": {
"type": "boolean",
"description": "Flag, indicates whether the user has been activated or not."
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the user is enabled or disabled."
},
"access_policies": {
"description": "Will be returned with all user access policies if query param `with_access_policies` is provided.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "../access_policies/accessPolicy.json"
}
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Date and time when user was created."
},
"updated_at": {
"$ref": "#/definitions/dateTime",
"description": "Last update timestamp, if user has just been created - then is equal to `created_at`, if user has just been deleted - then is equal to `deleted_at`."
},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
},
"language": {
"type": "string",
"description": "Preferred locale."
},
"idp_id": {
"$ref": "#/definitions/uuid",
"description": "Identity provider UUID."
},
"external_id": {
"type": "string",
"description": "User's ID in external identity provider (e.g. SID in AD)."
},
"origin_id": {
"type": "string",
"description": "User's origin ID, for example, ID of a Cyber Application responsible for creating this user."
},
"origin_external_id": {
"type": "string",
"description": "User's external origin ID."
},
"disable_after": {
"$ref": "#/definitions/dateTime",
"description": "Timestamp indicating when the user will be disabled."
},
"personal_tenant_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "UUID of user's personal tenant. This field can have a null value."
},
"business_types": {
"$ref": "#/definitions/business_types"
},
"notifications": {
"$ref": "#/definitions/userNotifications",
"_comment": "possible values are: [maintenance, quota, reports, backup_error, backup_warning, backup_info, backup_daily_report, backup_critical, device_control_warning, certificate_management_error, certificate_management_warning, certificate_management_info]"
},
"mfa_status": {
"type": "string",
"description": "Multi-factor authentication status of the user.",
"enum": [
"disabled",
"forcibly_disabled",
"setup_required",
"enabled"
]
},
"external_operation_status": {
"oneOf": [
{"type": "null"},
{
"type": "string",
"enum": [
"deleting",
"recovering"
]
}
],
"description": "Indicates if some external operation in progress for this user (his personal tenant)."
}
},
"required": [
"id",
"version",
"tenant_id",
"login",
"contact",
"activated",
"enabled",
"created_at",
"updated_at",
"deleted_at",
"language",
"business_types",
"notifications"
]
}
Example:
{
"id": "948efcf2-b740-4c40-bb2d-4e4a46adfd87",
"version": 2,
"tenant_id": "0ef03214-6e47-4e50-87f2-a5955ba6095c",
"login": "mylogin",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": [],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "111111",
"deleted_at": "2020-05-19T11:50:00"
},
"activated": true,
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"language": "ru",
"idp_id": "e6f73a28-ff2e-4728-8f78-49eb74b20fce",
"external_id": "S-1-5-21-917267712-1342860078-1792151419-500",
"personal_tenant_id": "2f8ad2e2-28f2-11e7-aad1-5ffe2ad47151",
"business_types": [],
"notifications": [
"maintenance",
"quota",
"reports",
"backup_error",
"backup_warning",
"backup_info",
"backup_daily_report",
"backup_critical",
"device_control_warning",
"certificate_management_error",
"certificate_management_warning",
"certificate_management_info"
],
"mfa_status": "setup_required",
"origin_id": "pillr.mdr",
"origin_external_id": "c66b1af2-2ac5-4764-8db6-97b054e7d27e",
"disable_after": "2017-06-22T18:25:16"
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Checks availability of the login name (username).
get
Checks whether the login name (username) is available or already taken.
get /users/check_login
Checks whether the login name (username) is available or already taken.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- username: required(string)
A login name to check.
HTTP status code 204
Login name is available.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 406
Provided arguments are not acceptable.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "not_acceptable",
"context": {},
"domain": "PlatformAccountServer",
"message": "Not acceptable",
"details": {
"info": "Not acceptable"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post
Checks whether a password was previously exposed in data breaches.
post /users/check_password
Checks whether a password was previously exposed in data breaches.
Secured by oauth2
Secured by session
Secured by basicAuth
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"password": {
"type": "string",
"description": "Password (SHA-1 hash) to check."
}
},
"required": [
"password"
]
}
Example:
{
"password": "970C2D1A9869F18291D85BC389B33F0739496DE9"
}
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"compromised": {
"type": "boolean",
"description": "Flag that specifies whether the password was previously exposed in data breaches. True if the password was exposed; false otherwise."
}
},
"required": [
"compromised"
]
}
Example:
{
"compromised": true
}HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by session
Headers
- Cookie: required(string)
Example:
SESSION="c09fef6c-43ba-4e08-9c2b-fa81f6945ace"
HTTP status code 401
The request was denied due to an invalid session token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the current session token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by basicAuth
Headers
- Authorization: required(string - pattern: Basic [0-9a-zA-Z\-\._~+/]*=)
Used to send the base64-encoded "client_id:client_secret" credentials.
Example:
Basic QUJDMTIz=
HTTP status code 403
The request was denied due to the credentials having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages users maintenance notifications.
get
Fetches a list of maintenance notifications.
get /users/maintenance_notifications
Fetches a list of maintenance notifications.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- limit: (integer - default: 100 - minimum: 0 - maximum: 10000)
Limit the number of found objects. Default limit (100) used if 0 passed. Must be greater or equal 0. Maximum allowed value is 10000.
- last_user_id: (integer - default: 100)
Cursor to fetch the next page.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"maintenanceUser": {"$ref": "./maintenanceUser.json"}
},
"type": "object",
"properties": {
"timestamp": { "$ref": "#/definitions/dateTime" },
"users": {
"type": "array",
"items": {
"$ref": "#/definitions/maintenanceUser"
}
},
"paging": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Page size limit."
},
"last_user_id": {
"type": "integer",
"description": "Paging cursor. Represents last user id."
}
},
"required": [
"limit",
"last_user_id"
]
}
},
"required": [
"timestamp",
"paging"
]
}
Example:
{
"timestamp": "2016-06-22T18:25:16",
"users": [
{
"id": "fae84e50-0eef-11e7-bc3f-d39de3f5fe32",
"login": "some_login_1",
"email": "me@mysite.com",
"notifications": [
"maintenance",
"quota",
"reports",
"backup_error",
"backup_warning",
"backup_info",
"backup_daily_report",
"backup_critical",
"device_control_warning",
"certificate_management_error",
"certificate_management_warning",
"certificate_management_info"
]
}
],
"paging": {
"limit": 100,
"last_user_id": 112342
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages current user.
get
Fetches information about the currently authenticated user.
Available in cloud version only.
get /users/me
Fetches information about the currently authenticated user.
Available in cloud version only.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"contact": {"$ref": "../_common/contact/contact.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"business_types": {"$ref": "../_common/types/business_types.json"},
"userNotifications": {"$ref": "../_common/types/userNotifications.json"}
},
"type": "object",
"properties": {
"id": {
"description": "Unique identifier.",
"$ref": "#/definitions/uuid"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"tenant_id": {
"description": "ID of tenant this user belongs to.",
"$ref": "#/definitions/uuid"
},
"login": {
"type": "string",
"description": "User's login."
},
"contact": {
"$ref": "#/definitions/contact"
},
"activated": {
"type": "boolean",
"description": "Flag, indicates whether the user has been activated or not."
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the user is enabled or disabled."
},
"access_policies": {
"description": "Will be returned with all user access policies if query param `with_access_policies` is provided.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "../access_policies/accessPolicy.json"
}
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Date and time when user was created."
},
"updated_at": {
"$ref": "#/definitions/dateTime",
"description": "Last update timestamp, if user has just been created - then is equal to `created_at`, if user has just been deleted - then is equal to `deleted_at`."
},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
},
"language": {
"type": "string",
"description": "Preferred locale."
},
"idp_id": {
"$ref": "#/definitions/uuid",
"description": "Identity provider UUID."
},
"external_id": {
"type": "string",
"description": "User's ID in external identity provider (e.g. SID in AD)."
},
"origin_id": {
"type": "string",
"description": "User's origin ID, for example, ID of a Cyber Application responsible for creating this user."
},
"origin_external_id": {
"type": "string",
"description": "User's external origin ID."
},
"disable_after": {
"$ref": "#/definitions/dateTime",
"description": "Timestamp indicating when the user will be disabled."
},
"personal_tenant_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "UUID of user's personal tenant. This field can have a null value."
},
"business_types": {
"$ref": "#/definitions/business_types"
},
"notifications": {
"$ref": "#/definitions/userNotifications",
"_comment": "possible values are: [maintenance, quota, reports, backup_error, backup_warning, backup_info, backup_daily_report, backup_critical, device_control_warning, certificate_management_error, certificate_management_warning, certificate_management_info]"
},
"mfa_status": {
"type": "string",
"description": "Multi-factor authentication status of the user.",
"enum": [
"disabled",
"forcibly_disabled",
"setup_required",
"enabled"
]
},
"external_operation_status": {
"oneOf": [
{"type": "null"},
{
"type": "string",
"enum": [
"deleting",
"recovering"
]
}
],
"description": "Indicates if some external operation in progress for this user (his personal tenant)."
}
},
"required": [
"id",
"version",
"tenant_id",
"login",
"contact",
"activated",
"enabled",
"created_at",
"updated_at",
"deleted_at",
"language",
"business_types",
"notifications"
]
}
Example:
{
"id": "948efcf2-b740-4c40-bb2d-4e4a46adfd87",
"version": 2,
"tenant_id": "0ef03214-6e47-4e50-87f2-a5955ba6095c",
"login": "mylogin",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": [],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "111111",
"deleted_at": "2020-05-19T11:50:00"
},
"activated": true,
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"language": "ru",
"idp_id": "e6f73a28-ff2e-4728-8f78-49eb74b20fce",
"external_id": "S-1-5-21-917267712-1342860078-1792151419-500",
"personal_tenant_id": "2f8ad2e2-28f2-11e7-aad1-5ffe2ad47151",
"business_types": [],
"notifications": [
"maintenance",
"quota",
"reports",
"backup_error",
"backup_warning",
"backup_info",
"backup_daily_report",
"backup_critical",
"device_control_warning",
"certificate_management_error",
"certificate_management_warning",
"certificate_management_info"
],
"mfa_status": "setup_required",
"origin_id": "pillr.mdr",
"origin_external_id": "c66b1af2-2ac5-4764-8db6-97b054e7d27e",
"disable_after": "2017-06-22T18:25:16"
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages current user's applications.
get
Fetches information about applications available to the user.
Available in cloud version only.
get /users/me/applications
Fetches information about applications available to the user.
Available in cloud version only.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- for_ui: (boolean)
If true, the list of applications will be returned in a form that is appropriate for the UI.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"application": {"$ref": "./application.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/application"
}
}
},
"required": [
"items"
]
}
Example:
{
"items": [
{
"type": "backup",
"api_base_url": "/bc/",
"name": "Backup",
"id": "6e6d758d-8e74-3ae3-ac84-50eb0dff12eb",
"usages": [
"assigned_compute_points",
"child_storages",
"cloud_to_cloud_backup",
"compute_points",
"dr_cloud_servers",
"dr_internet_access",
"dr_storage",
"google_drive_storage",
"google_mail_storage",
"google_team_drive_storage",
"group_mailbox_storage",
"group_site_storage",
"gsuite_seats",
"local_storage",
"mailbox_instance_size",
"mailbox_storage",
"mailboxes",
"mobile_storage",
"mobiles",
"onedrive_storage",
"public_ips",
"server_storage",
"servers",
"sharepoint_online_site_storage",
"site_collection_storage",
"storage",
"total_storage",
"universal_devices",
"universal_devices_storage",
"virtualhost_storage",
"virtualhosts",
"vm_storage",
"vms",
"website_storage",
"websites",
"win_server_essentials",
"win_server_essentials_storage",
"workstation_storage",
"workstations"
]
},
{
"type": "physical_data_shipping",
"api_base_url": "/pds/",
"name": "Physical Data Shipping",
"id": "b71b2c18-590a-303c-9d5a-8444fbe713ac",
"usages": [
"drives_shipped_from_cloud",
"drives_shipped_to_cloud"
]
},
{
"type": "files_cloud",
"api_base_url": "/fc/",
"name": "File Sync & Share",
"id": "dfd85a5f-a464-32ab-81fd-99bcc66a070f",
"usages": [
"fc_child_storages",
"fc_seats",
"fc_storage",
"fc_total_storage"
]
},
{
"type": "notary",
"api_base_url": "/notary/console",
"name": "Notary",
"id": "f9c5744e-bd1a-36b6-b0f0-ecd7483e1796",
"usages": [
"esignatures",
"esignatures_api",
"notarizations",
"notarizations_api",
"notarizations_total",
"notary_storage"
]
},
{
"type": "hci",
"api_base_url": "/hci/",
"name": "Acronis Storage SPLA",
"id": "cc29685d-a9ca-3e87-a83d-069f18b588f0",
"usages": [
"hci_cifs_storage",
"hci_compute_points",
"hci_iscsi_storage",
"hci_nfs_storage",
"hci_s3_storage",
"hci_storage",
"hci_total_cifs_storage",
"hci_total_compute_points",
"hci_total_iscsi_storage",
"hci_total_nfs_storage",
"hci_total_s3_storage",
"hci_total_storage",
"hci_total_vm_provisioned_cpu",
"hci_total_vm_provisioned_ram",
"hci_total_vm_storage",
"hci_total_vtl_storage",
"hci_vm_provisioned_cpu",
"hci_vm_provisioned_ram",
"hci_vm_storage",
"hci_vtl_storage"
]
},
{
"type": "platform",
"api_base_url": "/mc/",
"name": "Management Portal",
"id": "7459244f-68f3-3bf4-9f53-5f63ecc1d91f",
"usages": []
}
]
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages a specific user.
delete
Deletes a user by ID.
put
Updates a user by ID.
get
Fetches a user by ID.
delete /users/{user_id}
Deletes a user by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- version: required(integer)
Growing number of object internal version.
Example:
1559561146223
HTTP status code 204
User was successfully deleted.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /users/{user_id}
Updates a user by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"contactPut": {"$ref": "../_common/contact/contactPut.json"},
"userNotifications": {"$ref": "../_common/types/userNotifications.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"login": {
"type": "string",
"description": "User's login."
},
"external_id": {
"type": "string",
"description": "User's ID in external identity provider (e.g. SID in AD)."
},
"idp_id": {
"$ref": "#/definitions/uuid",
"description": "Identity provider UUID."
},
"contact": {
"$ref": "#/definitions/contactPut"
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the user is enabled or disabled."
},
"language": {
"type": "string",
"description": "Preferred locale."
},
"notifications": {
"$ref": "#/definitions/userNotifications",
"_comment": "possible values are: [maintenance, quota, reports, backup_error, backup_warning, backup_info, backup_daily_report, backup_critical, device_control_warning, certificate_management_error, certificate_management_warning, certificate_management_info]"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"disable_after": {
"$ref": "#/definitions/dateTime",
"description": "Timestamp indicating when the user will be disabled."
}
},
"required": [
"version"
]
}
Example:
{
"contact":{
"firstname": "John"
},
"notifications": [],
"disable_after": "2017-06-22T18:25:16",
"version": 2
}
HTTP status code 200
User was successfully updated.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"contact": {"$ref": "../_common/contact/contact.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"business_types": {"$ref": "../_common/types/business_types.json"},
"userNotifications": {"$ref": "../_common/types/userNotifications.json"}
},
"type": "object",
"properties": {
"id": {
"description": "Unique identifier.",
"$ref": "#/definitions/uuid"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"tenant_id": {
"description": "ID of tenant this user belongs to.",
"$ref": "#/definitions/uuid"
},
"login": {
"type": "string",
"description": "User's login."
},
"contact": {
"$ref": "#/definitions/contact"
},
"activated": {
"type": "boolean",
"description": "Flag, indicates whether the user has been activated or not."
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the user is enabled or disabled."
},
"access_policies": {
"description": "Will be returned with all user access policies if query param `with_access_policies` is provided.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "../access_policies/accessPolicy.json"
}
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Date and time when user was created."
},
"updated_at": {
"$ref": "#/definitions/dateTime",
"description": "Last update timestamp, if user has just been created - then is equal to `created_at`, if user has just been deleted - then is equal to `deleted_at`."
},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
},
"language": {
"type": "string",
"description": "Preferred locale."
},
"idp_id": {
"$ref": "#/definitions/uuid",
"description": "Identity provider UUID."
},
"external_id": {
"type": "string",
"description": "User's ID in external identity provider (e.g. SID in AD)."
},
"origin_id": {
"type": "string",
"description": "User's origin ID, for example, ID of a Cyber Application responsible for creating this user."
},
"origin_external_id": {
"type": "string",
"description": "User's external origin ID."
},
"disable_after": {
"$ref": "#/definitions/dateTime",
"description": "Timestamp indicating when the user will be disabled."
},
"personal_tenant_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "UUID of user's personal tenant. This field can have a null value."
},
"business_types": {
"$ref": "#/definitions/business_types"
},
"notifications": {
"$ref": "#/definitions/userNotifications",
"_comment": "possible values are: [maintenance, quota, reports, backup_error, backup_warning, backup_info, backup_daily_report, backup_critical, device_control_warning, certificate_management_error, certificate_management_warning, certificate_management_info]"
},
"mfa_status": {
"type": "string",
"description": "Multi-factor authentication status of the user.",
"enum": [
"disabled",
"forcibly_disabled",
"setup_required",
"enabled"
]
},
"external_operation_status": {
"oneOf": [
{"type": "null"},
{
"type": "string",
"enum": [
"deleting",
"recovering"
]
}
],
"description": "Indicates if some external operation in progress for this user (his personal tenant)."
}
},
"required": [
"id",
"version",
"tenant_id",
"login",
"contact",
"activated",
"enabled",
"created_at",
"updated_at",
"deleted_at",
"language",
"business_types",
"notifications"
]
}
Example:
{
"id": "948efcf2-b740-4c40-bb2d-4e4a46adfd87",
"version": 2,
"tenant_id": "0ef03214-6e47-4e50-87f2-a5955ba6095c",
"login": "mylogin",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": [],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "111111",
"deleted_at": "2020-05-19T11:50:00"
},
"activated": true,
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"language": "ru",
"idp_id": "e6f73a28-ff2e-4728-8f78-49eb74b20fce",
"external_id": "S-1-5-21-917267712-1342860078-1792151419-500",
"personal_tenant_id": "2f8ad2e2-28f2-11e7-aad1-5ffe2ad47151",
"business_types": [],
"notifications": [
"maintenance",
"quota",
"reports",
"backup_error",
"backup_warning",
"backup_info",
"backup_daily_report",
"backup_critical",
"device_control_warning",
"certificate_management_error",
"certificate_management_warning",
"certificate_management_info"
],
"mfa_status": "setup_required",
"origin_id": "pillr.mdr",
"origin_external_id": "c66b1af2-2ac5-4764-8db6-97b054e7d27e",
"disable_after": "2017-06-22T18:25:16"
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get /users/{user_id}
Fetches a user by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- allow_deleted: (boolean - default: false)
If true, deleted users may be returned.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"contact": {"$ref": "../_common/contact/contact.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"business_types": {"$ref": "../_common/types/business_types.json"},
"userNotifications": {"$ref": "../_common/types/userNotifications.json"}
},
"type": "object",
"properties": {
"id": {
"description": "Unique identifier.",
"$ref": "#/definitions/uuid"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"tenant_id": {
"description": "ID of tenant this user belongs to.",
"$ref": "#/definitions/uuid"
},
"login": {
"type": "string",
"description": "User's login."
},
"contact": {
"$ref": "#/definitions/contact"
},
"activated": {
"type": "boolean",
"description": "Flag, indicates whether the user has been activated or not."
},
"enabled": {
"type": "boolean",
"description": "Flag, indicates whether the user is enabled or disabled."
},
"access_policies": {
"description": "Will be returned with all user access policies if query param `with_access_policies` is provided.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "../access_policies/accessPolicy.json"
}
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Date and time when user was created."
},
"updated_at": {
"$ref": "#/definitions/dateTime",
"description": "Last update timestamp, if user has just been created - then is equal to `created_at`, if user has just been deleted - then is equal to `deleted_at`."
},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
},
"language": {
"type": "string",
"description": "Preferred locale."
},
"idp_id": {
"$ref": "#/definitions/uuid",
"description": "Identity provider UUID."
},
"external_id": {
"type": "string",
"description": "User's ID in external identity provider (e.g. SID in AD)."
},
"origin_id": {
"type": "string",
"description": "User's origin ID, for example, ID of a Cyber Application responsible for creating this user."
},
"origin_external_id": {
"type": "string",
"description": "User's external origin ID."
},
"disable_after": {
"$ref": "#/definitions/dateTime",
"description": "Timestamp indicating when the user will be disabled."
},
"personal_tenant_id": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/uuid"}
],
"description": "UUID of user's personal tenant. This field can have a null value."
},
"business_types": {
"$ref": "#/definitions/business_types"
},
"notifications": {
"$ref": "#/definitions/userNotifications",
"_comment": "possible values are: [maintenance, quota, reports, backup_error, backup_warning, backup_info, backup_daily_report, backup_critical, device_control_warning, certificate_management_error, certificate_management_warning, certificate_management_info]"
},
"mfa_status": {
"type": "string",
"description": "Multi-factor authentication status of the user.",
"enum": [
"disabled",
"forcibly_disabled",
"setup_required",
"enabled"
]
},
"external_operation_status": {
"oneOf": [
{"type": "null"},
{
"type": "string",
"enum": [
"deleting",
"recovering"
]
}
],
"description": "Indicates if some external operation in progress for this user (his personal tenant)."
}
},
"required": [
"id",
"version",
"tenant_id",
"login",
"contact",
"activated",
"enabled",
"created_at",
"updated_at",
"deleted_at",
"language",
"business_types",
"notifications"
]
}
Example:
{
"id": "948efcf2-b740-4c40-bb2d-4e4a46adfd87",
"version": 2,
"tenant_id": "0ef03214-6e47-4e50-87f2-a5955ba6095c",
"login": "mylogin",
"contact": {
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"types": [],
"email": "me@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"zipcode": "12345",
"city": "Rivertown",
"phone": "123456789",
"firstname": "John",
"lastname": "Doe",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "111111",
"deleted_at": "2020-05-19T11:50:00"
},
"activated": true,
"enabled": true,
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null,
"language": "ru",
"idp_id": "e6f73a28-ff2e-4728-8f78-49eb74b20fce",
"external_id": "S-1-5-21-917267712-1342860078-1792151419-500",
"personal_tenant_id": "2f8ad2e2-28f2-11e7-aad1-5ffe2ad47151",
"business_types": [],
"notifications": [
"maintenance",
"quota",
"reports",
"backup_error",
"backup_warning",
"backup_info",
"backup_daily_report",
"backup_critical",
"device_control_warning",
"certificate_management_error",
"certificate_management_warning",
"certificate_management_info"
],
"mfa_status": "setup_required",
"origin_id": "pillr.mdr",
"origin_external_id": "c66b1af2-2ac5-4764-8db6-97b054e7d27e",
"disable_after": "2017-06-22T18:25:16"
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Available in on-premises version only.
Fetches user's login info by ID.
get /users/{user_id}/login_info
Available in on-premises version only.
Fetches user's login info by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"dateTime": {"$ref": "../_common/types/dateTime.json"}
},
"type": "object",
"properties": {
"password_expiration": {
"properties": {
"status": {
"type": "string",
"enum": ["expired", "never_expires", "expirable"]
},
"time": {
"description": "Password expiration date.",
"$ref": "#/definitions/dateTime"
}
},
"required": [
"status"
]
},
"last_login": {
"description": "Information about last login.",
"type": "object",
"properties": {
"time": {
"description": "Time of last login.",
"$ref": "#/definitions/dateTime"
},
"remote_address": {
"type": "string"
},
"failed_attempts": {
"type": "integer"
},
"user_agent": {
"type": "string"
},
"idp_type": {
"type": "string"
}
},
"required": [
"failed_attempts"
]
}
},
"required": [
"password_expiration",
"last_login"
]
}
Example:
{
"password_expiration": {
"status": "never_expires"
},
"last_login": {
"time": "2017-12-14T14:57:25Z",
"remote_address": "::1",
"failed_attempts": 0,
"user_agent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/63.0.3239.84 Safari/537.36",
"idp_type": "SSPI"
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Fetches a list of user's access policies.
put
Rewrites user's access policies.
post
Creates user access policy.
get /users/{user_id}/access_policies
Fetches a list of user's access policies.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- includeUserGroupPolicies: (boolean)
If set true, security group policies will be included in response.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"accessPolicy": {"$ref": "./accessPolicy.json"}
},
"type": "object",
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/accessPolicy"
}
}
},
"required": [
"items",
"timestamp"
]
}
Example:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"id": "00000000-0000-0000-0000-000000000005",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "hci_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "hci",
"resource_path": "res1"
},
{
"id": "00000000-0000-0000-0000-000000000004",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "notary_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "notary",
"resource_path": "res4/res5"
},
{
"id": "00000000-0000-0000-0000-000000000002",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "pds_operator",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5"
},
{
"id": "00000000-0000-0000-0000-000000000003",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "pds_support",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5"
}
]
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /users/{user_id}/access_policies
Rewrites user's access policies.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"accessPolicy": {"$ref": "./accessPolicy.json"}
},
"type": "object",
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/accessPolicy"
}
}
},
"required": [
"items",
"timestamp"
]
}
Example:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"id": "00000000-0000-0000-0000-000000000005",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "hci_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "hci",
"resource_path": "res1"
},
{
"id": "00000000-0000-0000-0000-000000000004",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "notary_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "notary",
"resource_path": "res4/res5"
},
{
"id": "00000000-0000-0000-0000-000000000002",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "pds_operator",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5"
},
{
"id": "00000000-0000-0000-0000-000000000003",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "pds_support",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5"
}
]
}HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"accessPolicy": {"$ref": "./accessPolicy.json"}
},
"type": "object",
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/accessPolicy"
}
}
},
"required": [
"items",
"timestamp"
]
}
Example:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"id": "00000000-0000-0000-0000-000000000005",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "hci_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "hci",
"resource_path": "res1"
},
{
"id": "00000000-0000-0000-0000-000000000004",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "notary_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "notary",
"resource_path": "res4/res5"
},
{
"id": "00000000-0000-0000-0000-000000000002",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "pds_operator",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5"
},
{
"id": "00000000-0000-0000-0000-000000000003",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "pds_support",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5"
}
]
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1010,
"context": {},
"message": "conflict",
"details": {
"info": "user with specified login already exists in same tenant"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "ApplicationAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post /users/{user_id}/access_policies
Creates user access policy.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"userRole": {"$ref": "../_common/types/userRole.json"}
},
"type": "object",
"properties": {
"tenant_id": {
"description": "Tenant unique identifier.",
"type": "string"
},
"role_id": {
"description": "Role identifier",
"$ref": "#/definitions/userRole"
},
"resource_server_id": {
"description": "Tenant unique identifier.",
"type": "string"
},
"resource_namespace": {
"description": "Resource namespace.",
"type": "string"
},
"resource_path": {
"description": "Resource path.",
"type": "string"
}
},
"required": ["tenant_id", "role_id", "resource_server_id", "resource_namespace", "resource_path"]
}
Example:
{
"tenant_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"role_id": "pds_operator",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5",
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331"
}
HTTP status code 201
Policy was successfully created.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"userRole": {"$ref": "../_common/types/userRole.json"}
},
"type": "object",
"properties": {
"id": {
"description": "Access policy unique identifier.",
"type": "string"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"created_at": {
"$ref": "#/definitions/dateTime",
"description": "Creation timestamp."
},
"updated_at": {
"$ref": "#/definitions/dateTime",
"description": "Last update timestamp, if tenant has just been created - then equals to `created_at`, if tenant has just been deleted - then equals to `deleted_at`."
},
"deleted_at": {
"oneOf": [
{"type": "null"},
{"$ref": "#/definitions/dateTime"}
],
"description": "Soft deletion timestamp."
},
"trustee_id": {
"description": "Unique identifier of the Subject for whom access policy is granted.",
"type": "string"
},
"trustee_type": {
"description": "Type of the Subject for whom access policy is granted.",
"type": "string",
"enum": ["user", "user_group", "client"]
},
"issuer_id": {
"description": "Issuer unique identifier.",
"type": "string"
},
"tenant_id": {
"description": "Tenant unique identifier.",
"type": "string"
},
"resource_server_id": {
"description": "Tenant unique identifier.",
"type": "string"
},
"resource_namespace": {
"description": "Resource namespace.",
"type": "string"
},
"resource_path": {
"description": "Resource path.",
"type": "string"
},
"role_id": {
"$ref": "#/definitions/userRole",
"description": "Role identifier"
}
},
"required": ["id", "version", "created_at", "updated_at", "deleted_at", "trustee_id", "trustee_type", "tenant_id", "issuer_id", "role_id"]
}
Example:
{
"id": "00000000-0000-0000-0000-000000000004",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "notary_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "notary",
"resource_path": "res4/res5"
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1010,
"context": {},
"message": "conflict",
"details": {
"info": "user with specified login already exists in same tenant"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "ApplicationAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages user's report subscriptions.
get
Fetches a list of UUIDs of all reports the user is subscribed to.
post
Subscribes the user to a usage report.
get /users/{user_id}/report-subscriptions
Fetches a list of UUIDs of all reports the user is subscribed to.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "types/uuid.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
}
}
},
"required": [
"items"
]
}
Example:
{
"items":[
"aa4f8923-8950-4804-8827-c6d78388e5b6",
"4eb7b320-48b4-4552-9bf8-f7482538da23"
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post /users/{user_id}/report-subscriptions
Subscribes the user to a usage report.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"report_id": {
"description": "ID of report to subscribe to.",
"$ref": "#/definitions/uuid"
}
},
"required": [
"report_id"
]
}
Example:
{
"report_id": "75e2cf23-4da7-4f8e-b9cd-0be006648b4e"
}
HTTP status code 201
User was successfully subscribed.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"date": {"$ref": "../_common/types/date.json"}
},
"type": "object",
"properties": {
"id": {
"description": "Unique identifier for this configured report.",
"$ref": "#/definitions/uuid"
},
"version": {
"type": "integer",
"description": "Auto-incremented entity version."
},
"result_action": {
"type": "string",
"enum": [
"save",
"send"
],
"description": "What to do with report."
},
"recipients": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
},
"description": "IDs of subscribed users."
},
"parameters": {
"type": "object",
"properties": {
"tenant_id": {
"description": "ID of the tenant that will be the subject of this report.",
"$ref": "#/definitions/uuid"
},
"level": {
"type": "string",
"enum": [
"itself",
"direct_partners",
"all_partners",
"all_customers",
"accounts"
],
"description": "Level of report detail."
},
"formats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"csv",
"html",
"json_v1",
"csv_v2_0"
]
},
"description": "Report formats."
},
"kind": {
"type": "string",
"enum": [
"usage_daily",
"usage_summary",
"usage_current",
"usage_breakdown"
],
"description": "Kind of report."
},
"period": {
"description": "Report period.",
"type": "object",
"properties": {
"start": {
"$ref": "#/definitions/date",
"description": "Starting date of the report period."
},
"end": {
"$ref": "#/definitions/date",
"description": "Ending date of the report period."
}
},
"required": [
"start",
"end"
]
},
"hide_zero_usage": {
"type": "boolean",
"description": "Hide metrics with zero usage in report."
},
"show_skus": {
"type": "boolean",
"description": "Show SKU-related fields in report."
}
},
"required": [
"tenant_id",
"kind",
"level",
"period",
"formats"
]
},
"schedule": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Flag indicating whether the report is enabled (scheduled reports only)."
},
"type": {
"type": "string",
"enum": [
"once",
"monthly"
],
"description": "Type of report schedule."
}
},
"required": [
"enabled",
"type"
]
},
"generation_date": {
"$ref": "#/definitions/date",
"description": "Date when the report should be generated."
}
},
"required": [
"id",
"version",
"recipients",
"parameters",
"generation_date",
"schedule",
"result_action"
]
}
Example:
{
"id": "20dffb36-d77b-45c6-b2fa-39276e98d5fc",
"recipients": [
"ca451758-b48a-45d9-9ae6-8f1059f67619",
"ab00e527-219b-481b-b01b-311b5be0ed3c"
],
"version": 2,
"parameters": {
"kind": "usage_summary",
"tenant_id": "2a91a14d-ffd3-4ac1-9b4d-3990162c5acc",
"level": "accounts",
"period": {
"start": "2017-05-01",
"end": "2017-05-07"
},
"formats": ["csv"],
"hide_zero_usage": true,
"show_skus": false
},
"schedule": {
"type": "once",
"enabled": true
},
"result_action": "send",
"generation_date": "2017-05-08"
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages user's subscription to the usage report.
delete
Unsubscribes the user from the usage report.
delete /users/{user_id}/report-subscriptions/{report_id}
Unsubscribes the user from the usage report.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
- report_id: required(json)
Report ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 204
User subscription was successfully removed.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Email actions for provided user.
post
Sends emails to test branding and SMTP settings.
post /users/{user_id}/email/test_branding
Sends emails to test branding and SMTP settings.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../../_common/types/uuid.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"tenant_id": {
"$ref": "#/definitions/uuid",
"description": "ID of the tenant to send test branding email from."
}
},
"required": [
"tenant_id"
]
}
Example:
{
"tenant_id": "cadb39f4-3182-4300-861b-75ed232f3ecb"
}
HTTP status code 204
Email was successfully queued.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages user's legal documents.
get
Fetches legal documents which the user have to sign.
post
Signs listed legal documents.
get /users/{user_id}/legal_documents
Fetches legal documents which the user have to sign.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"user_document_status": {"$ref": "userLegalDocumentStatus.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/user_document_status"
}
}
},
"additionalProperties": false,
"required": [
"items"
]
}
Example:
{
"items": [
{
"id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"sign_until": "2018-08-13"
},
{
"id": "fa6859a9-f5e1-4faf-a56c-5a0ae866dc4f",
"sign_until": null
}
]
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post /users/{user_id}/legal_documents
Signs listed legal documents.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "types/uuid.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/uuid"
}
}
},
"required": [
"items"
]
}
Example:
{
"items":[
"aa4f8923-8950-4804-8827-c6d78388e5b6",
"4eb7b320-48b4-4552-9bf8-f7482538da23"
]
}
HTTP status code 200
Legal documents were successfully signed.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages multi-factor authentication (MFA) settings of the user.
put
Manages MFA status for the user.
put /users/{user_id}/mfa/status
Manages MFA status for the user.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean",
"description": "Status of MFA for user."
}
},
"required": [
"enabled"
]
}
Example:
{
"enabled": true
}
HTTP status code 200
MFA settings status was successfully changed.
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
delete
Resets TOTP settings for the user.
delete /users/{user_id}/totp/reset
Resets TOTP settings for the user.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: any
HTTP status code 204
TOTP settings were successfully reset.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post
Remembers browser as trusted.
delete
Forgets all trusted browsers for user.
post /users/{user_id}/totp/trusted-browsers
Remembers browser as trusted.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: any
HTTP status code 200
Browser was successfully remembered as trusted.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
delete /users/{user_id}/totp/trusted-browsers
Forgets all trusted browsers for user.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: any
HTTP status code 204
Trusted browsers were successfully forgotten.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post
This method can be accessed only by OAuth 2.0 / OpenID Connect client.
Sets user's password.
post /users/{user_id}/password
This method can be accessed only by OAuth 2.0 / OpenID Connect client.
Sets user's password.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::users_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"password": {
"type": "string",
"description": "Password."
}
},
"required": ["password"]
}
Example:
{
"password": "testSECRETpassword123"
}HTTP status code 204
Password was successfully set.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post
Sends an activation email to the user.
post /users/{user_id}/send-activation-email
Sends an activation email to the user.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::users_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Body
Media type: application/json
Type: any
HTTP status code 204
Email was successfully queued.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post
Restores previously soft-deleted user.
post /users/{user_id}/restore
Restores previously soft-deleted user.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- user_id: required(json)
User ID (UUID).
Annotations
- roles_lib.x-tags
["public"]
Query Parameters
- force: (boolean)
Defines if the user should be restored in case of a conflict with another user who has taken the same login. In such a case restored user will have a postfix added.
- enable: (boolean)
Defines if the user should be re-enabled.
HTTP status code 204
User was successfully restored.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1010,
"context": {},
"message": "conflict",
"details": {
"info": "user with specified login already exists in same tenant"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/security_groups
Manages Groups of principals (users and service accounts / clients)
get
Fetches a batch of security groups.
post
Creates a new security groups.
get /security_groups
Fetches a batch of security groups.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::security_groups_admin
- urn:acronis.com::account-server::security_groups_viewer
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- ids: (json)
A filter by comma-separated list of security groups' IDs. Maximum of 100 IDs.
Example:
fae84e50-0eef-11e7-bc3f-d39de3f5fe32,fae84e50-0eef-11e7-bc3f-d39de3f5fe32 - tenant_id: (string)
A filter by specific tenant ID.
Example:
fae84e50-0eef-11e7-bc3f-d39de3f5fe32 - limit: (integer - default: 1000 - minimum: 1)
Number of elements in current page of the response.
- after: (string)
Cursor to fetch the next page. The cursor encodes all the filtering and sorting arguments, thus client does not need to provide all them for the next page, only cursor should be provided. Client can get the cursor from
paging.cursors.afterfield of the previous page response.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"securityGroup": {"$ref": "./securityGroup.json"}
},
"type": "object",
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/securityGroup"
}
}
},
"required": [
"items",
"timestamp"
]
}
Example:
default:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"id": "948efcf2-b740-4c40-bb2d-4e4a46adfd87",
"version": 2,
"tenant_id": "0ef03214-6e47-4e50-87f2-a5955ba6095c",
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null
},
{
"id": "048efcf2-b740-4c40-bb2d-4e4a46adfd87",
"version": 2,
"tenant_id": "0ef03214-6e47-4e50-87f2-a5955ba6095c",
"created_at": "2016-06-22T18:25:16",
"updated_at": "2016-06-22T18:25:16",
"deleted_at": null
}
]
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post /security_groups
Creates a new security groups.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::security_groups_admin
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier. Can be provided by client."
},
"tenant_id": {
"$ref": "#/definitions/uuid",
"description": "ID of tenant this security group belongs to."
}
},
"required": [
"tenant_id"
]
}
Example:
{
"id": "948efcf2-b740-4c40-bb2d-4e4a46adfd87",
"tenant_id": "0ef03214-6e47-4e50-87f2-a5955ba6095c"
}
HTTP status code 201
Security group was successfully created.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages a specific security group.
delete
Deletes a security group by ID.
delete /security_groups/{security_group_id}
Deletes a security group by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::security_groups_admin
URI Parameters
- security_group_id: required(json)
Security group ID.
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- version: required(integer)
Growing number of object internal version.
Example:
1559561146223
HTTP status code 204
Security group was successfully deleted.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Fetches members of security group.
patch
Patches members of a security group by ID.
get /security_groups/{security_group_id}/members
Fetches members of security group.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::security_groups_admin
- urn:acronis.com::account-server::security_groups_viewer
URI Parameters
- security_group_id: required(json)
Security group ID.
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- limit: (integer - default: 1000 - minimum: 1)
Number of elements in current page of the response.
- after: (string)
Cursor to fetch the next page. The cursor encodes all the filtering and sorting arguments, thus client does not need to provide all them for the next page, only cursor should be provided. Client can get the cursor from
paging.cursors.afterfield of the previous page response.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"securityGroupMember": {"$ref": "./securityGroupMember.json"}
},
"type": "object",
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/securityGroupMember"
}
}
},
"required": [
"items",
"timestamp"
]
}
Example:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{ "id": "008efcf2-b740-4c40-bb2d-4e4a46adfd87", "type": "client" },
{ "id": "118efcf2-b740-4c40-bb2d-4e4a46adfd87", "type": "client" }
]
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"details": {
"info": "Bad Request"
},
"message": "Bad Request",
"domain": "PlatformAccountServer",
"context": {},
"code": 400
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
patch /security_groups/{security_group_id}/members
Patches members of a security group by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::security_groups_admin
URI Parameters
- security_group_id: required(json)
Security group ID.
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- version: required(integer)
Growing number of object internal version.
Example:
1559561146223
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"securityGroupMember": {"$ref": "./securityGroupMember.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"items_to_add": {
"description": "Members to add.",
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/definitions/securityGroupMember"
}
},
"items_to_remove": {
"description": "Members to remove (delete).",
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/definitions/securityGroupMember"
}
}
},
"required": [
"items_to_add",
"items_to_remove"
]
}
Example:
{
"items_to_add": [
{ "id": "008efcf2-b740-4c40-bb2d-4e4a46adfd87", "type": "client" }
],
"items_to_remove": [
{ "id": "118efcf2-b740-4c40-bb2d-4e4a46adfd87", "type": "client" }
]
}
HTTP status code 204
Security group members were successfully patched.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
get
Fetches a list of security group's access policies.
put
Rewrites security group's access policies.
get /security_groups/{security_group_id}/access_policies
Fetches a list of security group's access policies.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::security_groups_admin
- urn:acronis.com::account-server::security_groups_viewer
URI Parameters
- security_group_id: required(json)
Security group ID.
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"accessPolicy": {"$ref": "./accessPolicy.json"}
},
"type": "object",
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/accessPolicy"
}
}
},
"required": [
"items",
"timestamp"
]
}
Example:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"id": "00000000-0000-0000-0000-000000000005",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "hci_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "hci",
"resource_path": "res1"
},
{
"id": "00000000-0000-0000-0000-000000000004",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "notary_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "notary",
"resource_path": "res4/res5"
},
{
"id": "00000000-0000-0000-0000-000000000002",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "pds_operator",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5"
},
{
"id": "00000000-0000-0000-0000-000000000003",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "pds_support",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5"
}
]
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "application_not_found",
"context": {
"id": "f313ecf6-9256-4afd-9d47-72e032ee81d0"
},
"domain": "PlatformAccountServer",
"message": "Application was not found",
"details": {
"info": "Application f313ecf6-9256-4afd-9d47-72e032ee81d0 was not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /security_groups/{security_group_id}/access_policies
Rewrites security group's access policies.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::security_groups_admin
URI Parameters
- security_group_id: required(json)
Security group ID.
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"accessPolicy": {"$ref": "./accessPolicy.json"}
},
"type": "object",
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/accessPolicy"
}
}
},
"required": [
"items",
"timestamp"
]
}
Example:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"id": "00000000-0000-0000-0000-000000000005",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "hci_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "hci",
"resource_path": "res1"
},
{
"id": "00000000-0000-0000-0000-000000000004",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "notary_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "notary",
"resource_path": "res4/res5"
},
{
"id": "00000000-0000-0000-0000-000000000002",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "pds_operator",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5"
},
{
"id": "00000000-0000-0000-0000-000000000003",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "pds_support",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5"
}
]
}HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"paging": {"$ref": "../_common/types/paging.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"},
"accessPolicy": {"$ref": "./accessPolicy.json"}
},
"type": "object",
"properties": {
"paging": { "$ref": "#/definitions/paging" },
"timestamp": { "$ref": "#/definitions/dateTime" },
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/accessPolicy"
}
}
},
"required": [
"items",
"timestamp"
]
}
Example:
{
"timestamp": "2016-06-22T18:25:16",
"items": [
{
"id": "00000000-0000-0000-0000-000000000005",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "hci_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "hci",
"resource_path": "res1"
},
{
"id": "00000000-0000-0000-0000-000000000004",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "notary_admin",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "notary",
"resource_path": "res4/res5"
},
{
"id": "00000000-0000-0000-0000-000000000002",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "pds_operator",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5"
},
{
"id": "00000000-0000-0000-0000-000000000003",
"version": 0,
"trustee_id": "2a0402b8-3867-4578-8ebc-e874a2864e79",
"trustee_type": "user",
"issuer_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"tenant_id": "b7028817-d180-44c1-ae3d-b99f4b3f844a",
"role_id": "pds_support",
"created_at": "1970-01-01T00:00:00Z",
"updated_at": "2022-03-22T21:45:47Z",
"deleted_at": null,
"resource_server_id": "53a2a450-8e4e-11e7-96dd-f45c89947331",
"resource_namespace": "physical_data_shipping",
"resource_path": "res4/res5"
}
]
}HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "conflict",
"context": {},
"domain": "PlatformAccountServer",
"message": "Conflict",
"details": {
"info": "Conflict"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "PlatformAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/contacts
Manages Contacts
get
Fetches a batch of contacts.
Available in cloud version only.
post
Creates a new contact.
Available in cloud version only.
get /contacts
Fetches a batch of contacts.
Available in cloud version only.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- allow_deleted: (boolean - default: false)
If true, deleted contacts may be returned.
- uuids: required(string)
Comma-separated list of contacts' UUIDs.
Example:
1e4d7438-0ebe-11e7-b131-c7b5bde6feed,248c535a-0ebe-11e7-a80e-bbdaa1d60c7c
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"contact": {"$ref": "contactGet.json"}
},
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/contact"
}
}
},
"required": [
"items"
]
}Example:
{
"items": [
{
"id": "27f6f164-63dd-47df-b5b6-83a0fd117beb",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"tenant_id": "5fea5f90-9833-417c-af63-c7ccf1609af1",
"user_id": null,
"types": ["legal"],
"email": "",
"address1": "",
"address2": "",
"country": "",
"state": "",
"city": "",
"zipcode": "",
"phone": "",
"firstname": "",
"lastname": "",
"title": "",
"website": "",
"industry": "",
"organization_size": "",
"email_confirmed": false,
"aan": "111111",
"language": "en",
"fax": "123 Example Street",
"deleted_at": "2020-05-19T11:50:00"
},
{
"id": "d8f70f4a-976a-4d66-a651-10d2b3d6e9dd",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"tenant_id": "5fea5f90-9833-417c-af63-c7ccf1609af1",
"user_id": "1bfe361d-fcb8-43ff-8f43-9ecc29a08ea5",
"types": ["primary"],
"email": "owner@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"city": "Rivertown",
"zipcode": "12345",
"phone": "123456789",
"firstname": "Company",
"lastname": "Owner",
"title": "Mr.",
"website": "www.mysite.com",
"industry": "IT",
"organization_size": "50-100",
"email_confirmed": true,
"aan": "111111",
"language": "en",
"fax": "123 Example Street",
"deleted_at": "2020-05-19T11:50:00"
},
{
"id": "1f45fe4e-83f0-46f3-b36c-8827806ba6ef",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"tenant_id": "5fea5f90-9833-417c-af63-c7ccf1609af1",
"user_id": null,
"types": ["billing","technical"],
"email": "billing@mysite.com",
"address1": "",
"address2": "",
"country": "",
"state": "WA",
"city": "Seattle",
"zipcode": "12345",
"phone": "123456789",
"firstname": "Billing",
"lastname": "Master",
"title": "Mr.",
"website": "www.mysite.com",
"industry": "IT",
"organization_size": "50-100",
"email_confirmed": false,
"aan": "111111",
"language": "en",
"fax": "123 Example Street",
"deleted_at": "2020-05-19T11:50:00"
},
{
"id": "bb8dc98d-3594-4e32-81df-b0ec10198852",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"tenant_id": "5fea5f90-9833-417c-af63-c7ccf1609af1",
"user_id": null,
"types": ["technical"],
"email": "technical@mysite.com",
"address1": "Some Lane 118",
"address2": "",
"country": "USA",
"state": "AZ",
"zipcode": "12345",
"city": "Phoenix",
"phone": "+000123456789",
"firstname": "Technical",
"lastname": "Guru",
"title": "Mr.",
"website": "www.mysite.com",
"industry": "IT",
"organization_size": "50-100",
"email_confirmed": true,
"aan": "111111",
"language": "en",
"fax": "123 Example Street",
"deleted_at": "2020-05-19T11:50:00"
}
]
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "bad request",
"details": {
"info": "Request body contains badly-formed JSON."
}
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post /contacts
Creates a new contact.
Available in cloud version only.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"email": {"$ref": "../_common/types/email.json"},
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"tenant_id": { "$ref": "#/definitions/uuid" },
"user_id": { "$ref": "#/definitions/uuid" },
"types": {
"type": "array",
"items": {
"type": "string",
"enum": ["primary", "billing", "technical", "management"]
},
"minItems": 1,
"uniqueItems": true
},
"email": { "$ref": "#/definitions/email" },
"address1": { "type": ["string", "null"] },
"address2": { "type": ["string", "null"] },
"country": { "type": ["string", "null"] },
"state": { "type": ["string", "null"] },
"city": { "type": ["string", "null"] },
"zipcode": { "type": ["string", "null"] },
"phone": { "type": ["string", "null"] },
"firstname": { "type": ["string", "null"] },
"lastname": { "type": ["string", "null"] },
"title": { "type": ["string", "null"] },
"website": { "type": ["string", "null"] },
"industry": { "type": ["string", "null"] },
"organization_size": { "type": ["string", "null"] },
"email_confirmed": { "type": ["boolean", "null"] },
"aan": { "type": ["string", "null"] },
"language": { "type": ["string", "null"] },
"fax": { "type": ["string", "null"] }
},
"required": [
"types",
"email",
"firstname",
"lastname"
]
}
Example:
{
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"user_id": "1bfe361d-fcb8-43ff-8f43-9ecc29a08ea5",
"types": ["primary", "billing", "technical", "management"],
"email": "owner@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"city": "Rivertown",
"zipcode": "12345",
"phone": "123456789",
"firstname": "Company",
"lastname": "Owner",
"title": "Mr.",
"website": "www.mysite.com",
"industry": "IT",
"organization_size": "50-100",
"email_confirmed": false,
"aan": "111111",
"language": "en",
"fax": "123 Example Street"
}
HTTP status code 201
Contact was successfully created.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"email": {
"$ref": "../_common/types/email.json",
"description": "This field can have a null value."
},
"uuid": {"$ref": "../_common/types/uuid.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"}
},
"type": "object",
"properties": {
"id": { "$ref": "#/definitions/uuid", "description": "Unique identifier." },
"created_at": {
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/dateTime" }
],
"description": "Date and time when contact was created."
},
"updated_at": {
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/dateTime" }
],
"description": "Last update timestamp, if contact has just been created - then is equal to `created_at`."
},
"tenant_id": {
"description": "ID of tenant this contact belongs to.",
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/uuid" }
]
},
"user_id": {
"description": "ID of user this contact belongs to.",
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/uuid" }
]
},
"types": {
"type": "array",
"items": {
"type": "string",
"enum": ["legal", "primary", "billing", "technical", "management"]
},
"minItems": 0,
"uniqueItems": true
},
"email": { "$ref": "#/definitions/email" },
"address1": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"address2": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"country": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"state": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"city": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"zipcode": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"phone": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"firstname": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"lastname": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"title": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"website": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"industry": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"organization_size": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"email_confirmed": {
"type": ["boolean", "null"],
"description": "This field can have a null value."
},
"aan": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"fax": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"language": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"deleted_at": {
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/dateTime" }
],
"description": "Delete timestamp, if contact deleted, null otherwise"
}
},
"required": [
"id",
"created_at",
"updated_at",
"types",
"email",
"firstname",
"lastname"
]
}
Example:
{
"id": "1f45fe4e-83f0-46f3-b36c-8827806ba6ef",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"tenant_id": "5fea5f90-9833-417c-af63-c7ccf1609af1",
"user_id": null,
"types": ["primary"],
"email": "owner@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"city": "Rivertown",
"zipcode": "12345",
"phone": "123456789",
"firstname": "Company",
"lastname": "Owner",
"title": "Mr.",
"website": "www.mysite.com",
"industry": "IT",
"organization_size": "50-100",
"email_confirmed": true,
"aan": "111111",
"language": "en",
"fax": "123 Example Street",
"deleted_at": "2020-05-19T11:50:00"
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "bad request",
"details": {
"info": "Request body contains badly-formed JSON."
}
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1010,
"context": {},
"message": "conflict",
"details": {
"info": "user with specified login already exists in same tenant"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "ApplicationAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Manages a specific contact.
get
Fetches a contact by ID.
put
Updates a contact by ID.
delete
Deletes a contact by ID.
get /contacts/{contact_id}
Fetches a contact by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
- urn:acronis.com::account-server::readonly_admin
URI Parameters
- contact_id: required(json)
Contact ID (UUID)
Annotations
- roles_lib.x-tags
["private"]
Query Parameters
- allow_deleted: (boolean - default: false)
If true, deleted contacts may be returned.
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"email": {
"$ref": "../_common/types/email.json",
"description": "This field can have a null value."
},
"uuid": {"$ref": "../_common/types/uuid.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"}
},
"type": "object",
"properties": {
"id": { "$ref": "#/definitions/uuid", "description": "Unique identifier." },
"created_at": {
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/dateTime" }
],
"description": "Date and time when contact was created."
},
"updated_at": {
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/dateTime" }
],
"description": "Last update timestamp, if contact has just been created - then is equal to `created_at`."
},
"tenant_id": {
"description": "ID of tenant this contact belongs to.",
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/uuid" }
]
},
"user_id": {
"description": "ID of user this contact belongs to.",
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/uuid" }
]
},
"types": {
"type": "array",
"items": {
"type": "string",
"enum": ["legal", "primary", "billing", "technical", "management"]
},
"minItems": 0,
"uniqueItems": true
},
"email": { "$ref": "#/definitions/email" },
"address1": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"address2": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"country": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"state": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"city": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"zipcode": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"phone": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"firstname": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"lastname": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"title": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"website": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"industry": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"organization_size": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"email_confirmed": {
"type": ["boolean", "null"],
"description": "This field can have a null value."
},
"aan": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"fax": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"language": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"deleted_at": {
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/dateTime" }
],
"description": "Delete timestamp, if contact deleted, null otherwise"
}
},
"required": [
"id",
"created_at",
"updated_at",
"types",
"email",
"firstname",
"lastname"
]
}
Example:
{
"id": "1f45fe4e-83f0-46f3-b36c-8827806ba6ef",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"tenant_id": "5fea5f90-9833-417c-af63-c7ccf1609af1",
"user_id": null,
"types": ["primary"],
"email": "owner@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"city": "Rivertown",
"zipcode": "12345",
"phone": "123456789",
"firstname": "Company",
"lastname": "Owner",
"title": "Mr.",
"website": "www.mysite.com",
"industry": "IT",
"organization_size": "50-100",
"email_confirmed": true,
"aan": "111111",
"language": "en",
"fax": "123 Example Street",
"deleted_at": "2020-05-19T11:50:00"
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
put /contacts/{contact_id}
Updates a contact by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- contact_id: required(json)
Contact ID (UUID)
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"email": {"$ref": "../_common/types/email.json"},
"uuid": {"$ref": "../_common/types/uuid.json"}
},
"type": "object",
"additionalProperties": false,
"properties": {
"tenant_id": { "$ref": "#/definitions/uuid" },
"user_id": { "$ref": "#/definitions/uuid" },
"types": {
"type": "array",
"items": {
"type": "string",
"enum": ["legal", "primary", "billing", "technical", "management"]
},
"minItems": 1,
"uniqueItems": true
},
"email": { "$ref": "#/definitions/email" },
"address1": { "type": ["string", "null"] },
"address2": { "type": ["string", "null"] },
"country": { "type": ["string", "null"] },
"state": { "type": ["string", "null"] },
"city": { "type": ["string", "null"] },
"zipcode": { "type": ["string", "null"] },
"phone": { "type": ["string", "null"] },
"firstname": { "type": ["string", "null"] },
"lastname": { "type": ["string", "null"] },
"title": { "type": ["string", "null"] },
"website": { "type": ["string", "null"] },
"industry": { "type": ["string", "null"] },
"organization_size": { "type": ["string", "null"] },
"email_confirmed": { "type": ["boolean", "null"] },
"aan": { "type": ["string", "null"] },
"language": { "type": ["string", "null"] },
"fax": { "type": ["string", "null"] }
}
}
Example:
{
"tenant_id": "f313ecf6-9256-4afd-9d47-72e032ee81d0",
"user_id": "1bfe361d-fcb8-43ff-8f43-9ecc29a08ea5",
"types": ["legal", "primary", "billing", "technical", "management"],
"email": "owner@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"city": "Rivertown",
"zipcode": "12345",
"phone": "123456789",
"firstname": "Company",
"lastname": "Owner",
"title": "Mr.",
"website": "www.mysite.com",
"industry": "IT",
"organization_size": "50-100",
"email_confirmed": true,
"aan": "111111",
"language": "en",
"fax": "123 Example Street"
}
HTTP status code 200
Contact was successfully updated.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"email": {
"$ref": "../_common/types/email.json",
"description": "This field can have a null value."
},
"uuid": {"$ref": "../_common/types/uuid.json"},
"dateTime": {"$ref": "../_common/types/dateTime.json"}
},
"type": "object",
"properties": {
"id": { "$ref": "#/definitions/uuid", "description": "Unique identifier." },
"created_at": {
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/dateTime" }
],
"description": "Date and time when contact was created."
},
"updated_at": {
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/dateTime" }
],
"description": "Last update timestamp, if contact has just been created - then is equal to `created_at`."
},
"tenant_id": {
"description": "ID of tenant this contact belongs to.",
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/uuid" }
]
},
"user_id": {
"description": "ID of user this contact belongs to.",
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/uuid" }
]
},
"types": {
"type": "array",
"items": {
"type": "string",
"enum": ["legal", "primary", "billing", "technical", "management"]
},
"minItems": 0,
"uniqueItems": true
},
"email": { "$ref": "#/definitions/email" },
"address1": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"address2": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"country": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"state": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"city": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"zipcode": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"phone": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"firstname": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"lastname": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"title": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"website": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"industry": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"organization_size": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"email_confirmed": {
"type": ["boolean", "null"],
"description": "This field can have a null value."
},
"aan": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"fax": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"language": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"deleted_at": {
"oneOf": [
{ "type": "null" },
{ "$ref": "#/definitions/dateTime" }
],
"description": "Delete timestamp, if contact deleted, null otherwise"
}
},
"required": [
"id",
"created_at",
"updated_at",
"types",
"email",
"firstname",
"lastname"
]
}
Example:
{
"id": "1f45fe4e-83f0-46f3-b36c-8827806ba6ef",
"created_at": "2020-05-19T11:50:00",
"updated_at": "2020-05-19T11:50:00",
"tenant_id": "5fea5f90-9833-417c-af63-c7ccf1609af1",
"user_id": null,
"types": ["primary"],
"email": "owner@mysite.com",
"address1": "1440 River Drive #100",
"address2": "",
"country": "USA",
"state": "CA",
"city": "Rivertown",
"zipcode": "12345",
"phone": "123456789",
"firstname": "Company",
"lastname": "Owner",
"title": "Mr.",
"website": "www.mysite.com",
"industry": "IT",
"organization_size": "50-100",
"email_confirmed": true,
"aan": "111111",
"language": "en",
"fax": "123 Example Street",
"deleted_at": "2020-05-19T11:50:00"
}
HTTP status code 400
Bad request.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "bad request",
"details": {
"info": "Request body contains badly-formed JSON."
}
}
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1010,
"context": {},
"message": "conflict",
"details": {
"info": "user with specified login already exists in same tenant"
}
}
}
HTTP status code 415
Requested type in the Accept request header is not supported.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "invalid_content_type",
"context": {},
"domain": "ApplicationAccountServer",
"message": "Content must be JSON",
"details": {
"info": "Content must be JSON"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
delete /contacts/{contact_id}
Deletes a contact by ID.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
URI Parameters
- contact_id: required(json)
Contact ID (UUID)
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 204
Contact was successfully deleted.
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1000,
"context": {},
"message": "unauthorized",
"details": {
"info": "cannot switch session to user with different identity"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1002,
"context": {},
"message": "access denied",
"details": {
"info": "can not change access policies for self"
}
}
}
HTTP status code 404
Not Found.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1104,
"context": {},
"message": "could not resolve target tenant",
"details": {
"info": "could not resolve target tenant: not found"
}
}
}
HTTP status code 409
Another object of the same type already exists.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"domain": "ApplicationAccountServer",
"code": 1010,
"context": {},
"message": "conflict",
"details": {
"info": "user with specified login already exists in same tenant"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/totp
The Time-based One-Time Password algorithm (TOTP) setup and verification.
post
Initializes TOTP for the logged in user and provides a QR code.
post /totp/setup
Initializes TOTP for the logged in user and provides a QR code.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: any
HTTP status code 200
TOTP code was successfully created.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"barcode": {
"type": "string",
"description": "QR code formatted as base64-encoded string of PNG bytes."
},
"url": {
"type": "string",
"description": "TOTP key url string that can be used to configure a key."
}
},
"required": [
"barcode",
"url"
]
}
Example:
{
"barcode": "iVBORw0KGgoAAAANSUhEUgAAAMgAAADIEAAAAADYoy0BAAAGXklEQVR4nOyd4Y4iOQyEmRPv/8p7upX6BJm4XbbDbK30fT9GAtJJhpLjdhw3z1+/HmDEP396AvDO878/X1+9i1frWvu5Po/6Xz+P2kft1nFVa1f7z+YdjT/5PrEQMxDEDAQx4/n6orsGr6z9ZP1mviMbP/MBav/R6/U61Ud0vk8sxAwEMQNBzHju3lTvv6P2ajwS9Ve9zz+9pkfjRp+r/SjzwULMQBAzEMSMrQ/pUo0bouun7dW9LXVvrBq/TMBCzEAQMxDEjKM+JFqT17W4mu9Y+49eq/OL3r/GVX3CJ7KtWIgZCGIGgpix9SHTtXGa4476qfoa1adVc+HV/6/yfWIhZiCIGQhixpsP6Z4nulD3lqavV7q+Yvo6G7/zfWIhZiCIGQhixteJ/Rh1Da3e71d9RjRul2ocdeK7xELMQBAzEMSM3z6ku6dTrdOo1l9M6y5O7clVx5n4SCzEDAQxA0HMuN3L+qlavqj9itpePY+VtVdrHqfzeQULMQNBzEAQM97ikAv1vr/brltTeCp/svarcjLe2F1PnbohCGIGgphRqjG8mJ6PmtYMVnP363Vqv6d8qZrzf2AhfiCIGQhixm0c8n+jQ8+7+jZ4cY3PrlfHO/1Ml+45st18sRAzEMQMBDHjdxyixgPqs0lWsvvwqH00zrSO41R80p3XXXssxAwEMQNBzJCeuaieo6pedzGtb1/76fqgLH6ofg+dZ65gIWYgiBkIYsbbs9/V+/EVde1V+62eh1I/r/qIrs+Ixo2uYy/LGAQxA0HMeNvLilDX1OraXc2jVNtPzxJXr6v+HzuwEDMQxAwEMWNbp95d21WmzzBR6066e07dPMq0XoW9LEMQxAwEMUOqUz+1p9ONd07Xz586u6yifp/4EEMQxAwEMUPay7rIcthqTrx6v1/NTX+qZrIbF63v34GFmIEgZiCIGdvfU++e1a3GM2oOPjtvpfbfjS+qeZFJXgcLMQNBzEAQM6Tn9p7OLVdrFqP5TFF9ZXTdqfqTV7AQMxDEDAQx482HdPMPGdN8SjeHr6710zzJidrCB/kQTxDEDAQxY7uXdTGNC9S9pK6vqs6nWzdyej53PhELMQNBzEAQM0o59YtTz/xQfVO3jmOdl0rmE6f5ort5YSFmIIgZCGLGbU69eka3ep+v5sCzcbp5jZXMR0zr+aPPqVM3BkHMQBAzRs/tjejmwj9d05ihzq96nQr5EEMQxAwEMWPrQy6q9/fdevFTcVA0v+n5K7U/tf4lGhcfYgiCmIEgZtw+6+RCXUurvkKlepZ2vS5i+oyTaby0GxcLMQNBzEAQM0r5kKnv6K6xK9X4R13zu+eyJnXpazssxAwEMQNBzNj+fkg3nqjGK9laPz1vleXwq2v+p+vciUMMQRAzEMSM298xrOYDVqrtpmtzt59uHqc6v2zcBxbiB4KYgSBmbOvUV7q577VdOIliXqLr87p7Tere2YnrsRAzEMQMBDFj+zuGar3Gp+rNp3kUtR5lmj/Jxo/GvZsvFmIGgpiBIGbcPi/rW+MPPaeqOs407xL1E1E9lzWpg8FCzEAQMxDEDOk3qC66a7f6fsSn1uz18+o8P+GzsBAzEMQMBDFjm1Ov7L3s3p+2/6lcfoa6ZxaNm50DWyEOMQRBzEAQM7Zne6PX3XilW5M3zbd0c/3ZHpvqY6P+7j7HQsxAEDMQxIxRPqRaT6Kuzemkh7WJ3RrJbJxq7eOuPyzEDAQxA0HMKJ3t/XbxobW/Gmdka/PpPMxPgoWYgSBmIIgZ0m9QrXTP1mb9Ru2y+/hsD2xaM9jN5UfjEIf8RSCIGQhiRus3qLp7ONU6jK4vynxMdn10XdY+m4/SHxZiBoKYgSBm3MYhGdl9/qkzvN18ilpDqF6nxiPVGs3Xz7EQMxDEDAQx4/ZcVoR6fqobZ6h7Vtm81TVejZdWuvHNXXssxAwEMQNBzHju3pyujdO68Ky9Wm+h9qPGJVG/6nyU+WIhZiCIGQhixtaHdFF9hlqLeOrcVPcMQDeOmtTNYyFmIIgZCGLGUR/SPQs73QuL5tGtiVznlc1X/T8iXtthIWYgiBkIYsbWh3T3nNS1dXqe6tReW8S0Hr1b5/LAQvxAEDMQxIw3H9I9nzU9R6XGHdn41dx4d4+rGp9En7OX9ReAIGYgiBlff6IWG2KwEDP+DQAA//+TDHXGhqE4+AAAAABJRU5ErkJggg==",
"url" : "otpauth://totp/Google:test@gmail.com?algorithm=SHA1&digits=6&issuer=Google&period=30&secret=HTXT7KJFVNAJUPYWQRWMNVQE5AF5YZI2"
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
post
Verifies TOTP code.
post /totp/verify
Verifies TOTP code.
Secured by oauth2 with scopes:
- urn:acronis.com::account-server::root_admin
- urn:acronis.com::account-server::partner_admin
- urn:acronis.com::account-server::company_admin
- urn:acronis.com::account-server::unit_admin
Annotations
- roles_lib.x-tags
["private"]
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"additionalProperties": false,
"properties": {
"code": {
"type": "string",
"description": "TOTP code."
},
"challenge": {
"type": "string",
"description": "The reason for TOTP verification.",
"enum": [
"login",
"action"
]
}
},
"required": [
"code"
]
}
Example:
{
"code": "123456",
"challenge": "login"
}
HTTP status code 200
TOTP code was successfully verified.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"valid": {
"type": "boolean",
"description": "True if the TOTP code provided is correct; false otherwise."
}
},
"required": [
"valid"
]
}
Example:
{
"valid": true
}
HTTP status code 401
Method required an authenticated user.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
Current user is not authorized to access this endpoint or its method.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
HTTP status code 423
Too many failed attempts to verify TOTP code.
Body
Media type: application/json
Type: any
Secured by oauth2
Headers
- Authorization: required(string - pattern: Bearer [0-9a-zA-Z\-\._~+/]*=*)
Used to send a valid OAuth 2 access token. Do not use with the "access_token" query string parameter.
Example:
Bearer QUJDMTIz=
Query Parameters
- access_token: required(string)
Used to send a valid OAuth 2 access token. Do not use together with the "Authorization" header.
Example:
y4tweh45wu7aeNgG77dgn6dsgk
HTTP status code 401
The request was denied due to an invalid or missing bearer access token.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "unauthorized",
"context": {},
"domain": "PlatformAccountServer",
"message": "Authentication is required",
"details": {
"info": "Authentication is required"
}
}
}
HTTP status code 403
The request was denied due to the bearer access token having insufficient privileges.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": ["string", "integer"]
},
"context": {
"type": "object"
},
"domain": {
"type": ["string", "null"],
"description": "This field can have a null value."
},
"message": {
"type": "string"
},
"details": {
"type": "object",
"description": "Additional info.",
"properties": {
"info": {
"type": ["string", "null"],
"description": "This field can have a null value."
}
}
},
"data": {
"type": "array",
"items": {"type": "string"}
}
},
"required": [
"code",
"details",
"domain",
"message"
]
}
},
"required": [
"error"
]
}
Example:
{
"error": {
"code": "access_denied",
"context": {},
"domain": "PlatformAccountServer",
"message": "Access is denied",
"details": {
"info": "Access is denied"
}
}
}
/versions
get
Fetches platform and its components versions.
get /versions
Fetches platform and its components versions.
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"component": {
"type": "object",
"properties": {
"name": {"type": "string"},
"version": {"type": "string"}
},
"required": ["name", "version"]
}
},
"type": "object",
"properties": {
"application": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"edition": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": ["name", "edition", "version"]
},
"components": {
"type": "array",
"items": {"$ref": "#/definitions/component"}
}
},
"required": ["application", "components"]
}Example:
{
"application": {
"name": "Acronis Platform",
"edition": "Cloud",
"version": "8.0"
},
"components": [
{
"name": "account_server",
"version": "1.3.494"
},
{
"name": "account_database",
"version": "21.0.715"
}
]
}/.well-known
This endpoints collection is available on /, without the /api/2 prefix.
get
Fetches the information about the OpenID provider's configuration. For more details, see https://openid.net/specs/openid-connect-discovery-1_0.html.
get /.well-known/openid-configuration
Fetches the information about the OpenID provider's configuration. For more details, see https://openid.net/specs/openid-connect-discovery-1_0.html.
Annotations
- roles_lib.x-tags
["public"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"issuer": {
"type": "string"
},
"authorization_endpoint": {
"type": "string"
},
"token_endpoint": {
"type": "string"
},
"jwks_uri": {
"type": "string"
},
"response_types_supported": {
"type": "array",
"items": {
"type": "string"
}
},
"subject_types_supported": {
"type": "array",
"items": {
"type": "string"
}
},
"id_token_signing_alg_values_supported": {
"type": "array",
"items": {
"type": "string"
}
},
"revocation_endpoint": {
"type": "string"
},
"revocation_endpoint_auth_methods_supported": {
"type": "array",
"items": {
"type": "string"
}
},
"device_authorization_endpoint": {
"type": "string"
}
},
"required": ["issuer", "authorization_endpoint", "token_endpoint", "jwks_uri", "response_types_supported", "subject_types_supported", "id_token_signing_alg_values_supported"]
}
Example:
{
"issuer": "http://0.0.0.0:30675",
"authorization_endpoint": "http://0.0.0.0:30675/idp/auth",
"token_endpoint": "http://0.0.0.0:30675/idp/token",
"jwks_uri": "http://0.0.0.0:30675/idp/keys",
"response_types_supported": [
"code"
],
"subject_types_supported": [
"public"
],
"id_token_signing_alg_values_supported": [
"RS256"
],
"scopes_supported": [],
"token_endpoint_auth_methods_supported": [
"client_secret_basic"
],
"revocation_endpoint": "http://0.0.0.0:30675/idp/revoke_token",
"revocation_endpoint_auth_methods_supported": [
"client_secret_basic",
"client_secret_post",
"none"
],
"device_authorization_endpoint": "http://0.0.0.0:30675/idp/device_authorization"
}Applications configuration information.
get
Fetches the configurations of applications (a list of applications with their URLs).
get /.well-known/app-configuration
Fetches the configurations of applications (a list of applications with their URLs).
Annotations
- roles_lib.x-tags
["private"]
HTTP status code 200
The request was successful.
Body
Media type: application/json
Type: json
Content:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"definitions": {
"uuid": {"$ref": "../_common/types/uuid.json"},
"applicationType": {"$ref": "../_common/types/applicationType.json"}
},
"type": "object",
"properties": {
"applications": {
"type": "array",
"items": {
"type": "object",
"properties": {
"uuid": {
"$ref": "#/definitions/uuid",
"description": "UUID of application instance."
},
"type": {
"$ref": "#/definitions/applicationType",
"description": "Type of application."
},
"url": {
"type": "string",
"description": "Application URL."
}
}
},
"required": ["uuid", "type", "url"]
}
},
"required": ["applications"]
}
Example:
{
"applications": [
{ "type": "platform", "url": "http://myfilescloud.com/mc/", "uuid": "f545ae78-a310-4733-b562-4da2dc00e0a3" },
{ "type": "backup", "url": "http://myfilescloud.com/bc/", "uuid": "0f3ec8f0-985d-4984-b981-d1cb36166fa3" },
{ "type": "files_cloud", "url": "http://myfilescloud.com/files", "uuid": "78e1a6ec-4b16-4819-b1e3-14fb3ed9a6bd" }
]
}