Multi-service Portal API documentation version 1

https://{host}:{port}/api/{version}

host: required(string - default: localhost)
Example:
```
localhost
```
port: required(string - default: 443)
Example:
```
443
```
version: required(1)

/accounts

Accounts routing

/accounts get post

get

Find host by account name

post

DEPRECATED. Register a new account on router

Find host by account name

Secured by session

Secured by basicAuth

Annotations

roles_lib.x-tags
```
["public"]
```

Query Parameters

login: (string)
Account`s login
Example:
```
example_login
```
user_id: (string)
Not mandatory, you have to specify user_id if multiple accounts are associated with one identity
Example:
```
1
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "server_url": {
            "type": "string",
            "title": "server_url",
            "description": "Server address where this account hosted"
        },
        "id": {"$ref": "#/definitions/id"},
        "login": {
            "type": "string",
            "title": "login",
            "description": "User login"
        }
    },
    "title": "accounts_get_response",
    "type": "object",
    "description": "/accounts/GET response",
    "definitions": {
        "id": {"$ref": "../_common/types/id.json"}
    },
    "required": ["server_url", "id", "login"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "server_url": "https://manage.backups.com",
    "id": 1,
    "login": "user"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

DEPRECATED. Register a new account on router

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

login: (string)
Account`s login
Example:
```
example_login
```
server: (string)
sign: (string)
url: required(string)
Example:
```
http%3A%2F%2Flocalhost%3A52055
```

token: required(string)

Example:

gAAAAABYxqV9145fLfLMRvzQPcpLYlTkYD9xmal9uUK02EtERYLMJV9fYhOTcCDbBW65UcAPKR9aNOHPmMj-20-1hytGMUSn1hU77FHeQipZJPv0byc4c63WcU6qqjnZIhxwIIiLK1NLODcaBDTr7xtuPeJ-Tyc3kAhq1nqj40-WEOdTbCGBkKZxIViU3RWW-FGN3bnG499SYwQ0GoubEL3hv96kOJtiig%3D%3D

scheme: (one of http, https)

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "server_url": {
            "type": "string",
            "title": "server_url",
            "description": "Server address of the host account"
        },
        "local_id": {"$ref": "#/definitions/id"},
        "login": {
            "type": "string",
            "title": "login",
            "description": "Login"
        },
        "password": {
            "type": "string",
            "title": "password",
            "description": "Password"
        }
    },
    "title": "accountsPOSTrequest",
    "type": "object",
    "description": "/accounts/POST request",
    "$schema": "http://json-schema.org/draft-04/schema",
    "definitions": {
        "id": {"$ref": "../_common/types/id.json"}
    },
    "required": ["login", "password"],
    "additionalProperties": false
}

Example:

{
    "server_url": "https://us-baas.com",
    "local_id": 1,
    "login": "user@mail.com",
    "password": "example"
}

HTTP status code 201

Created

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Created"

HTTP status code 406

Not acceptable

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Not acceptable"

HTTP status code 409

Conflict

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Conflict"
    },
    "message": "Conflict",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 409
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/accounts/check get

get

Checks account existence on router

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

login: required(string)
server: required(string)
sign: required(string)

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 409

Conflict

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Conflict"
    },
    "message": "Conflict",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 409
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/actions

/actions/activate get post

Activate account

get

Decode access token

post

Grant access via token

Decode access token

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

token: (string)

Access token

Example:

gAAAAABYit-lyoPUNCfJpzGzz9Qqobyeib79DQoMktiJeiJQzGpyHKa3RX9xGpL7QMLk-p58Vs5ej-_T52Md8F-PSZhmif_uG3njwu6hwGnv72p2LNG4M_6FZdrKgJtiBz366F82SKQ9AgYB4F0iNayGrMBIBE99zKC6DL7Zjqq3rHK-eO5eCVicTRb6BPBDVTvJgmwQ3VZPmKErAXOTbZDLMe9OknICXVqJjIpuMK53pHKlM3VO1Jid_MAiLaMJVNUcE9djA5i6aq8huym1qS9rhPJbp1X-nqCgMUAMB4zmYWr_dLr61Rc=

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "definitions": {
    "actionsGetResponse": { "$ref": "get_response.json" }
  },
  "title": "actions_get_activate_response",
  "type": "object",
  "allOf": [
    {
      "properties": {
        "activated": {
          "description": "Flag that defines already activated.",
          "type": "boolean"
        },
        "platform_available": {
          "type": "boolean",
          "description": "Flag that defines availability for platform"
        },
        "terms_accepted": {
          "description": "Flag that defines if this user has accepted EULA.",
          "type": "boolean"
        },
        "terms_url": {
          "description": "Company terms and conditions page url.",
          "type": "string"
        },
        "platform_terms_url": {
          "description": "Terms and conditions page for platform.",
          "type": "string"
        },
        "privacy_policy_url": {
          "description": "Privacy policy terms and conditions page url.",
          "type": "string"
        }
      },
      "required": ["terms_url", "platform_terms_url", "privacy_policy_url"]
    },
    { "$ref": "#/definitions/actionsGetResponse" }
  ]
}

Example:

{
    "login": "login",
    "email": "email@email.com",
    "user_id": 11223344,
    "group_kind": 40,
    "tenant_name": "Example Company Inc",
    "first_name": "First name Example",
    "last_name": "Last name Example",
    "activated": true,
    "platform_available": true,
    "terms_accepted": true,
    "terms_url": "https://www.acronis.com/company/terms.html",
    "platform_terms_url": "https://www.acronis.com/company/platform_terms.html",
    "privacy_policy_url": "https://www.acronis.com/company/privacy.html"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Grant access via token

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

token: (string)

Access token

Example:

gAAAAABYit-lyoPUNCfJpzGzz9Qqobyeib79DQoMktiJeiJQzGpyHKa3RX9xGpL7QMLk-p58Vs5ej-_T52Md8F-PSZhmif_uG3njwu6hwGnv72p2LNG4M_6FZdrKgJtiBz366F82SKQ9AgYB4F0iNayGrMBIBE99zKC6DL7Zjqq3rHK-eO5eCVicTRb6BPBDVTvJgmwQ3VZPmKErAXOTbZDLMe9OknICXVqJjIpuMK53pHKlM3VO1Jid_MAiLaMJVNUcE9djA5i6aq8huym1qS9rhPJbp1X-nqCgMUAMB4zmYWr_dLr61Rc=

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "password": {
            "type": "string",
            "title": "password",
            "description": "Account`s password"
        },
        "md5": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if password was provided in md5 hashed state or not"
        }
    },
    "title": "activate_post_request",
    "type": "object",
    "additionalProperties": false,
    "description": "/actions/activate/POST request",
    "required": ["password"],
    "definitions": {
        "flag": {"$ref": "../_common/types/flag.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "password": "password",
    "md5": 0
}

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/actions/change_login post

post

Update login for your current account

Secured by session

Secured by basicAuth

Annotations

AllowedTo
```
["root_admin"]
```
roles_lib.x-tags
```
["private"]
```

Query Parameters

local: (integer)
If this flag is set to 0, Account Server will try to create new account
Example:
```
0
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "login": {
            "type": "string",
            "title": "login",
            "description": "Current login"
        },
        "newlogin": {
            "type": "string",
            "title": "newlogin",
            "description": "New login"
        }
    },
    "title": "change_login_request",
    "type": "object",
    "additionalProperties": false,
    "description": "/actions/change_login/POST request",
    "$schema": "http://json-schema.org/draft-04/schema",
    "required": ["login", "newlogin"]
}

Example:

{
    "login": "Old_login",
    "newlogin": "New_login"
}

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 409

Conflict

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Conflict"
    },
    "message": "Conflict",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 409
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/actions/change_password post

Actions with account`s password

post

Allows user to change the password

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "current_password": {
            "type": "string",
            "title": "current_password",
            "description": "Current password"
        },
        "new_password": {
            "type": "string",
            "title": "new_password",
            "description": "New password"
        }
    },
    "title": "change_password_request",
    "type": "object",
    "additionalProperties": false,
    "description": "/actions/change_password/POST request",
    "required": ["current_password", "new_password"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "current_password": "current_password",
    "new_password": "new_password"
}

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/actions/emailupdate post

Update user`s email address

post

Set new email address

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

token: (string)

Access token

Example:

gAAAAABYit-lyoPUNCfJpzGzz9Qqobyeib79DQoMktiJeiJQzGpyHKa3RX9xGpL7QMLk-p58Vs5ej-_T52Md8F-PSZhmif_uG3njwu6hwGnv72p2LNG4M_6FZdrKgJtiBz366F82SKQ9AgYB4F0iNayGrMBIBE99zKC6DL7Zjqq3rHK-eO5eCVicTRb6BPBDVTvJgmwQ3VZPmKErAXOTbZDLMe9OknICXVqJjIpuMK53pHKlM3VO1Jid_MAiLaMJVNUcE9djA5i6aq8huym1qS9rhPJbp1X-nqCgMUAMB4zmYWr_dLr61Rc=

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "login": {
            "type": "string",
            "title": "login",
            "description": "Account`s login"
        },
        "email": { "$ref": "#/definitions/email" },
        "old_email": { "$ref": "#/definitions/email" }
    },
    "title": "email_update_response",
    "type": "object",
    "description": "/actions/emailupdate/POST response",
    "definitions": {
      "email": {"$ref": "../_common/types/email.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "login": "login",
    "email": "email@email.com",
    "old_email": "old_email@email.com"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/actions/forgot_link get

Get forgot password link by login

get

Get forgot password link by login

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

username: required(string - pattern: ^[^ ]+$)
Login
Example:
```
example
```

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
  "properties": {
    "link": {
      "title": "link",
      "type": "string",
      "description": "URL to forgot password page"
    }
  },
  "type": "object",
  "title": "forgot_link_response",
  "description": "API /forgot_link response for Acronis Account Server",
  "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "link": "http://example.com/forgot_password"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/actions/mail/activate get post

Activate account via email

get

Get email parameters

post

Send email with access token and link

Get email parameters

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

email: (string)
Account`s email address
Example:
```
john.doe@acronis.com
```
login: (string)
Account`s login
Example:
```
example_login
```
user_id: (string)
Not mandatory, you have to specify user_id if multiple accounts are associated with one identity
Example:
```
1
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
  "properties": {
    "action": {
      "title": "action",
      "type": "string",
      "description": "Action type"
    },
    "base_url": {
      "title": "base_url",
      "type": "string",
      "description": "Basic URL"
    },
    "company": {
      "title": "company",
      "type": "string",
      "description": "Company name"
    },
    "downloads": {
      "properties": {
        "user_guide": {
          "title": "user_guide",
          "type": "string",
          "description": "User guide download link"
        }
      },
      "type": "object"
    },
    "email": { "$ref": "#/definitions/email" },
    "group_kind": { "$ref": "#/definitions/group_kind" },
    "host": {
      "title": "host",
      "type": "string",
      "description": "User host"
    },
    "language": {
      "title": "language",
      "type": "string",
      "description": "User language"
    },
    "login": {
      "title": "login",
      "type": "string",
      "description": "User login"
    },
    "recipient_firstname": {
      "title": "recipient_firstname",
      "type": "string",
      "description": "User first name"
    },
    "recipient_lastname": {
      "title": "recipient_lastname",
      "type": "string",
      "description": "User last name"
    },
    "support_phone": {
      "title": "support_phone",
      "type": ["string", "null"],
      "description": "Support phone"
    },
    "support_url": {
      "title": "support_url",
      "type": "string",
      "description": "Acronis Support URL"
    },
    "token": {
      "title": "token",
      "type": "string",
      "description": "JWT access token"
    },
    "activated": {
       "$ref": "#/definitions/flag",
       "description": "Flag that defines if account is activated"
    }
  },
  "type": "object",
  "title": "mail_actions_get_response",
  "description": "API /actions response for Acronis Account Server",
  "$schema": "http://json-schema.org/draft-04/schema",
  "definitions": {
    "group_kind": {"$ref": "../_common/types/group_kind.json"},
    "email": {"$ref": "../_common/types/email.json"},
    "flag": {"$ref": "../_common/types/flag.json"}
  }
}

Example:

{
    "action": "activate",
    "base_url": "https://example.com",
    "company": "Example Company Inc",
    "downloads": {
      "user_guide": "https://example.com"
    },
    "email": "example@mail.com",
    "group_kind": 40,
    "host": "https://example.com",
    "language": "en",
    "login": "Example",
    "recipient_firstname": "First name Example",
    "recipient_lastname": "Last name Example",
    "support_phone": "+0-000-0000000",
    "support_url": "https://example.com",
    "token": "jwt token example"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Send email with access token and link

Secured by session

Secured by basicAuth

Annotations

roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "login": {
            "type": "string",
            "title": "login",
            "description": "Accounts login"
        },
        "email": {"$ref": "#/definitions/email"},
        "user_id": {
            "description": "ID or UUID",
            "title": "user_id"
        }
    },
    "title": "activate_request",
    "type": "object",
    "additionalProperties": false,
    "description": "/actions/mail/activate/POST request",
    "$schema": "http://json-schema.org/draft-04/schema",
    "definitions": {
        "email": {"$ref": "../_common/types/email.json"},
        "id": {"$ref": "../_common/types/id.json"}
    },
    "required": ["email", "login"]
}

Example:

{
    "login": "example",
    "email": "example@mail.com",
    "user_id": 11223344
}

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/actions/mail/emailupdate get post

Change user email address

get

Get email parameters

post

Send email with access token and link

Get email parameters

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

email: (string)
Account`s email address
Example:
```
john.doe@acronis.com
```
login: (string)
Account`s login
Example:
```
example_login
```
user_id: (string)
Not mandatory, you have to specify user_id if multiple accounts are associated with one identity
Example:
```
1
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
  "properties": {
    "action": {
      "title": "action",
      "type": "string",
      "description": "Action type"
    },
    "base_url": {
      "title": "base_url",
      "type": "string",
      "description": "Basic URL"
    },
    "company": {
      "title": "company",
      "type": "string",
      "description": "Company name"
    },
    "downloads": {
      "properties": {
        "user_guide": {
          "title": "user_guide",
          "type": "string",
          "description": "User guide download link"
        }
      },
      "type": "object"
    },
    "email": { "$ref": "#/definitions/email" },
    "group_kind": { "$ref": "#/definitions/group_kind" },
    "host": {
      "title": "host",
      "type": "string",
      "description": "User host"
    },
    "language": {
      "title": "language",
      "type": "string",
      "description": "User language"
    },
    "login": {
      "title": "login",
      "type": "string",
      "description": "User login"
    },
    "recipient_firstname": {
      "title": "recipient_firstname",
      "type": "string",
      "description": "User first name"
    },
    "recipient_lastname": {
      "title": "recipient_lastname",
      "type": "string",
      "description": "User last name"
    },
    "support_phone": {
      "title": "support_phone",
      "type": ["string", "null"],
      "description": "Support phone"
    },
    "support_url": {
      "title": "support_url",
      "type": "string",
      "description": "Acronis Support URL"
    },
    "token": {
      "title": "token",
      "type": "string",
      "description": "JWT access token"
    },
    "activated": {
       "$ref": "#/definitions/flag",
       "description": "Flag that defines if account is activated"
    }
  },
  "type": "object",
  "title": "mail_actions_get_response",
  "description": "API /actions response for Acronis Account Server",
  "$schema": "http://json-schema.org/draft-04/schema",
  "definitions": {
    "group_kind": {"$ref": "../_common/types/group_kind.json"},
    "email": {"$ref": "../_common/types/email.json"},
    "flag": {"$ref": "../_common/types/flag.json"}
  }
}

Example:

{
    "action": "activate",
    "base_url": "https://example.com",
    "company": "Example Company Inc",
    "downloads": {
      "user_guide": "https://example.com"
    },
    "email": "example@mail.com",
    "group_kind": 40,
    "host": "https://example.com",
    "language": "en",
    "login": "Example",
    "recipient_firstname": "First name Example",
    "recipient_lastname": "Last name Example",
    "support_phone": "+0-000-0000000",
    "support_url": "https://example.com",
    "token": "jwt token example"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Send email with access token and link

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

email: (string)
Account`s email address
Example:
```
john.doe@acronis.com
```
login: (string)
Account`s login
Example:
```
example_login
```
user_id: (string)
Not mandatory, you have to specify user_id if multiple accounts are associated with one identity
Example:
```
1
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "login": {
            "type": "string",
            "title": "login",
            "description": "Accounts login"
        },
        "email": {"$ref": "#/definitions/email"},
        "user_id": {
            "description": "ID or UUID",
            "title": "user_id"
        }
    },
    "title": "activate_request",
    "type": "object",
    "additionalProperties": false,
    "description": "/actions/mail/activate/POST request",
    "$schema": "http://json-schema.org/draft-04/schema",
    "definitions": {
        "email": {"$ref": "../_common/types/email.json"},
        "id": {"$ref": "../_common/types/id.json"}
    },
    "required": ["email", "login"]
}

Example:

{
    "login": "example",
    "email": "example@mail.com",
    "user_id": 11223344
}

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/actions/mail/reset get post

Reset account via email

get

Get email parameters

post

Send email with access token and link

Get email parameters

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

email: (string)
Account`s email address
Example:
```
john.doe@acronis.com
```
login: (string)
Account`s login
Example:
```
example_login
```
user_id: (string)
Not mandatory, you have to specify user_id if multiple accounts are associated with one identity
Example:
```
1
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
  "properties": {
    "action": {
      "title": "action",
      "type": "string",
      "description": "Action type"
    },
    "base_url": {
      "title": "base_url",
      "type": "string",
      "description": "Basic URL"
    },
    "company": {
      "title": "company",
      "type": "string",
      "description": "Company name"
    },
    "downloads": {
      "properties": {
        "user_guide": {
          "title": "user_guide",
          "type": "string",
          "description": "User guide download link"
        }
      },
      "type": "object"
    },
    "email": { "$ref": "#/definitions/email" },
    "group_kind": { "$ref": "#/definitions/group_kind" },
    "host": {
      "title": "host",
      "type": "string",
      "description": "User host"
    },
    "language": {
      "title": "language",
      "type": "string",
      "description": "User language"
    },
    "login": {
      "title": "login",
      "type": "string",
      "description": "User login"
    },
    "recipient_firstname": {
      "title": "recipient_firstname",
      "type": "string",
      "description": "User first name"
    },
    "recipient_lastname": {
      "title": "recipient_lastname",
      "type": "string",
      "description": "User last name"
    },
    "support_phone": {
      "title": "support_phone",
      "type": ["string", "null"],
      "description": "Support phone"
    },
    "support_url": {
      "title": "support_url",
      "type": "string",
      "description": "Acronis Support URL"
    },
    "token": {
      "title": "token",
      "type": "string",
      "description": "JWT access token"
    },
    "activated": {
       "$ref": "#/definitions/flag",
       "description": "Flag that defines if account is activated"
    }
  },
  "type": "object",
  "title": "mail_actions_get_response",
  "description": "API /actions response for Acronis Account Server",
  "$schema": "http://json-schema.org/draft-04/schema",
  "definitions": {
    "group_kind": {"$ref": "../_common/types/group_kind.json"},
    "email": {"$ref": "../_common/types/email.json"},
    "flag": {"$ref": "../_common/types/flag.json"}
  }
}

Example:

{
    "action": "activate",
    "base_url": "https://example.com",
    "company": "Example Company Inc",
    "downloads": {
      "user_guide": "https://example.com"
    },
    "email": "example@mail.com",
    "group_kind": 40,
    "host": "https://example.com",
    "language": "en",
    "login": "Example",
    "recipient_firstname": "First name Example",
    "recipient_lastname": "Last name Example",
    "support_phone": "+0-000-0000000",
    "support_url": "https://example.com",
    "token": "jwt token example"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Send email with access token and link

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "login": {
            "type": "string",
            "title": "login",
            "description": "Accounts login"
        },
        "email": {"$ref": "#/definitions/email"},
        "user_id": {
            "description": "ID or UUID",
            "title": "user_id"
        }
    },
    "title": "activate_request",
    "type": "object",
    "additionalProperties": false,
    "description": "/actions/mail/activate/POST request",
    "$schema": "http://json-schema.org/draft-04/schema",
    "definitions": {
        "email": {"$ref": "../_common/types/email.json"},
        "id": {"$ref": "../_common/types/id.json"}
    },
    "required": ["email", "login"]
}

Example:

{
    "login": "example",
    "email": "example@mail.com",
    "user_id": 11223344
}

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/actions/mail/test post

Test via email

post

Send test email with group branded SMTP options

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "group_id": {"$ref": "#/definitions/id"}
    },
    "title": "test_mail",
    "type": "object",
    "description": "/actions/mail/reset request",
    "$schema": "http://json-schema.org/draft-04/schema",
    "definitions": {
        "id": {"$ref": "../../_common/types/id.json"}
    },
    "required": ["group_id"]
}

Example:

{
    "group_id": 11223344
}

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/actions/reset get post

Reset account password

get

Decode access token

post

Grant access via jwt token

Decode access token

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

token: (string)

Access token

Example:

gAAAAABYit-lyoPUNCfJpzGzz9Qqobyeib79DQoMktiJeiJQzGpyHKa3RX9xGpL7QMLk-p58Vs5ej-_T52Md8F-PSZhmif_uG3njwu6hwGnv72p2LNG4M_6FZdrKgJtiBz366F82SKQ9AgYB4F0iNayGrMBIBE99zKC6DL7Zjqq3rHK-eO5eCVicTRb6BPBDVTvJgmwQ3VZPmKErAXOTbZDLMe9OknICXVqJjIpuMK53pHKlM3VO1Jid_MAiLaMJVNUcE9djA5i6aq8huym1qS9rhPJbp1X-nqCgMUAMB4zmYWr_dLr61Rc=

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "login": {
            "type": "string",
            "title": "login",
            "description": "Account`s login"
        },
        "email": { "$ref": "#/definitions/email" },
        "user_id": { "$ref": "#/definitions/id" },
        "group_kind": { "$ref": "#/definitions/group_kind" },
        "company_name": {
            "title": "company_name",
            "type": "string",
            "description": "Tenant(group) name"
        },
        "first_name": {
             "title": "first_name",
             "type": "string",
             "description": "User first name"
        },
        "last_name": {
             "title": "first_name",
             "type": "string",
             "description": "User last name"
        }
    },
    "title": "actions_get_response",
    "type": "object",
    "description": "/actions/activate/GET response",
    "definitions": {
      "email": {"$ref": "../_common/types/email.json"},
      "id": {"$ref": "../_common/types/id.json"},
      "group_kind": {"$ref": "../_common/types/group_kind.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "login": "login",
    "email": "email@email.com",
    "user_id": 11223344,
    "group_kind": 40,
    "tenant_name": "Example Company Inc",
    "first_name": "First name Example",
    "last_name": "Last name Example"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Grant access via jwt token

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

token: (string)

Access token

Example:

gAAAAABYit-lyoPUNCfJpzGzz9Qqobyeib79DQoMktiJeiJQzGpyHKa3RX9xGpL7QMLk-p58Vs5ej-_T52Md8F-PSZhmif_uG3njwu6hwGnv72p2LNG4M_6FZdrKgJtiBz366F82SKQ9AgYB4F0iNayGrMBIBE99zKC6DL7Zjqq3rHK-eO5eCVicTRb6BPBDVTvJgmwQ3VZPmKErAXOTbZDLMe9OknICXVqJjIpuMK53pHKlM3VO1Jid_MAiLaMJVNUcE9djA5i6aq8huym1qS9rhPJbp1X-nqCgMUAMB4zmYWr_dLr61Rc=

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "password": {
            "type": "string",
            "title": "password",
            "description": "Account`s password"
        },
        "md5": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if password was provided in md5 hashed state or not"
        }
    },
    "title": "activate_post_request",
    "type": "object",
    "additionalProperties": false,
    "description": "/actions/activate/POST request",
    "required": ["password"],
    "definitions": {
        "flag": {"$ref": "../_common/types/flag.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "password": "password",
    "md5": 0
}

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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 has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/admins

/admins/{admin} delete get put

Actions with administrator

delete

Delete administrator

get

Get detailed information about group administrator

put

Update group administrator properties

Delete administrator

Secured by session

Secured by basicAuth

URI Parameters

admin: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

version: (number)
Client`s version of an object
Example:
```
1
```

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 426

Version mismatch

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Version mismatch"
    },
    "message": "Version mismatch",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 426
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Get detailed information about group administrator

Secured by session

Secured by basicAuth

URI Parameters

admin: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "allOf": [
        {"$ref": "#/definitions/contact"},
        {
            "properties": {
                "id": {"$ref": "#/definitions/id"},
                "uuid": {"$ref": "#/definitions/uuid"},
                "user_id": {"$ref": "#/definitions/id"},
                "login": {
                    "type": "string",
                    "description": "Administrator`s login"
                },
                "access_type": {"$ref": "#/definitions/access_type"},
                "roles": {"$ref": "#/definitions/admin_role"},
                "terms_accepted":{
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if this user has accepted EULA"
                },
                "platform_terms_accepted":{
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if this user has accepted Platform Terms"
                },
                "privacy_policy_accepted":{
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if this user has accepted Privacy Policy"
                },
                "version":{"$ref": "#/definitions/version"},
                "group": {"$ref": "#/definitions/id"},
                "notifications_backup": {"$ref": "#/definitions/notifications_backup"},
                "notifications_management": {
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if notification management was turned on"
                },
                "notifications_device_control": {
                    "$ref": "#/definitions/notifications_device_control"
                },
                "notifications_certificate_management": {
                    "$ref": "#/definitions/notifications_certificate_management"
                },
                "status": {
                    "$ref": "#/definitions/account_status"
                },
                "integration_active": {
                    "type": "boolean",
                    "description": "Flag that defines if current user is managed by an external system"
                }
            }
        }
    ],
    "definitions": {
        "account_status": {"$ref": "../_common/types/account_status.json"},
        "contact": {"$ref": "../_common/contact.json"},
        "id": {"$ref": "../_common/types/id.json"},
        "uuid": {"$ref": "../_common/types/uuid.json"},
        "access_type": {"$ref": "../_common/types/access_type.json"},
        "admin_role": {"$ref": "../_common/types/admin_role.json"},
        "flag": {"$ref": "../_common/types/flag.json"},
        "notifications_backup": {"$ref": "../_common/types/notifications_backup.json"},
        "notifications_device_control": {"$ref": "../_common/types/notifications_device_control.json"},
        "notifications_certificate_management": {"$ref": "../_common/types/notifications_certificate_management.json"},
        "version": {"$ref": "../_common/types/version.json"}
    },
    "required": [
      "id",
      "uuid",
      "user_id",
      "login",
      "access_type",
      "roles",
      "terms_accepted",
      "platform_terms_accepted",
      "privacy_policy_accepted",
      "version",
      "notifications_backup",
      "address1",
      "address2",
      "city",
      "country",
      "email",
      "firstname",
      "lastname",
      "phone",
      "state",
      "zipcode"
    ],
    "title": "admin_get_response",
    "type": "object",
    "description": "/admins/{admin}/GET response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "access_type": 15,
    "firstname": "Example",
    "id": 11223344,
    "uuid": "153366b6-dd04-4d9a-ba9f-a0f553794ee6",
    "language": "en",
    "roles": 0,
    "lastname": "Example",
    "address1": "Example",
    "notifications_management": 1,
    "country": "Example",
    "user_id": 11223344,
    "group": 11223344,
    "integration_active": false,
    "city": "Example",
    "login": "example",
    "terms_accepted": 0,
    "platform_terms_accepted": 0,
    "privacy_policy_accepted": 0,
    "status": 1,
    "notifications_backup": 1,
    "notifications_device_control": 1,
    "notifications_certificate_management": 7,
    "version": 1,
    "zipcode": "112233",
    "address2": "Example",
    "email": "eb874732491740aa9eb323991de74f22@3a7ee845836b4af99240b86a539e0005.com",
    "state": "Example",
    "phone": "1-122-3344556"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Update group administrator properties

Secured by session

Secured by basicAuth

URI Parameters

admin: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

version: (number)
Client`s version of an object
Example:
```
1
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "firstname": {
            "type": "string",
            "title": "firstname",
            "description": "administrator`s first-name"
        },
        "language": {
            "type": "string",
            "title": "language",
            "description": "preferred admin language"
        },
        "lastname": {
            "type": "string",
            "title": "lastname",
            "description": "administrator`s last-name"
        },
        "email": {"$ref": "#/definitions/email"},
        "access_type": {"$ref": "#/definitions/access_type"},
        "roles": {"$ref": "#/definitions/admin_role"},
        "status": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if admin is enabled"
        },
        "notifications_management": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if notification management was turned on"
        },
        "notifications_backup": {"$ref": "#/definitions/notifications_backup"},
        "notifications_device_control": {"$ref": "#/definitions/notifications_device_control"},
        "notifications_certificate_management": {"$ref": "#/definitions/notifications_certificate_management"}
    },
    "title": "admin_put_request",
    "type": "object",
    "description": "Admins put request schema",
    "definitions": {
        "email": {"$ref": "../_common/types/email.json"},
        "access_type": {"$ref": "../_common/types/access_type.json"},
        "admin_role": {"$ref": "../_common/types/admin_role.json"},
        "flag": {"$ref": "../_common/types/flag.json"},
        "notifications_backup": {"$ref": "../_common/types/notifications_backup.json"},
        "notifications_device_control": {"$ref": "../_common/types/notifications_device_control.json"},
        "notifications_certificate_management": {"$ref": "../_common/types/notifications_certificate_management.json"}
    },
    "additionalProperties": false,
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "firstname": "Example",
    "language": "en",
    "lastname": "Example",
    "email": "example@mail.com",
    "access_type": 1,
    "roles": 0,
    "status": 1,
    "notifications_management": 0,
    "notifications_backup": 1,
    "notifications_device_control": 1,
    "notifications_certificate_management": 7
}

HTTP status code 200

Object has been updated

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "version": {"$ref": "#/definitions/version"}
    },
    "title": "version",
    "type": "object",
    "description": "Common version response",
    "definitions": {
        "version": {"$ref": "types/version.json"}
    },
    "required": ["version"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "version": 11223344
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 409

Conflict

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Conflict"
    },
    "message": "Conflict",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 409
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

HTTP status code 426

Version mismatch

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Version mismatch"
    },
    "message": "Version mismatch",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 426
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/admins/{admin}/impersonate get

Admin or service user impersonation

get

Get impersonated JWT token for specified admin. You can add jwt='your jwt token' query parameter to most of requests to perform this action as selected user

Secured by session

Secured by basicAuth

URI Parameters

admin: required(string)

Annotations

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "jwt": {
            "type": "string",
            "description": "Issued jwt"
        }
    },
    "title": "jwt_response",
    "type": "object",
    "description": "Common jwt response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9Cg.eyJhdWQiOlsibWMtdnotc25hdW1lbmtvLTEyLTA4LTE4LTMyLTExNjU0Lm1zcC5ydS5jb3JwLmFjcm9uaXMuY29tIl0sImVtYWlsIjoic3VAdGVzdC5jb20iLCJleHAiOjE0NDk2NzE0MDAsImlhdCI6MTQ0OTY2NzgwMCwiaXNzIjoibWMtdnotc25hdW1lbmtvLTEyLTA4LTE4LTMyLTExNjU0Lm1zcC5ydS5jb3JwLmFjcm9uaXMuY29tIiwibmFtZSI6Ikl2YW4gSXZhbm92IiwibmJmIjoxNDQ5NjY3ODAwLCJzY29wZSI6WyJBZ2VudFJlZ2lzdHJhdGlvbiJdLCJ0ZW5hbnRJZCI6IjQiLCJ1aWQiOiJzdUB0ZXN0LmNvbSJ9Cg.fcbY_QmuDH7FMAhM6JySPpHpFUdnPxuXJxnoetyG6p8"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/admins/{admin}/jwt get

Issuing JWT token

get

Issue JWT token

Secured by session

Secured by basicAuth

URI Parameters

admin: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

scope: (string)
Comma-separated list of user scopes
Example:
```
SomeScope1, SomeScope2, SomeScope3
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "jwt": {
            "type": "string",
            "description": "Issued jwt"
        }
    },
    "title": "jwt_response",
    "type": "object",
    "description": "Common jwt response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9Cg.eyJhdWQiOlsibWMtdnotc25hdW1lbmtvLTEyLTA4LTE4LTMyLTExNjU0Lm1zcC5ydS5jb3JwLmFjcm9uaXMuY29tIl0sImVtYWlsIjoic3VAdGVzdC5jb20iLCJleHAiOjE0NDk2NzE0MDAsImlhdCI6MTQ0OTY2NzgwMCwiaXNzIjoibWMtdnotc25hdW1lbmtvLTEyLTA4LTE4LTMyLTExNjU0Lm1zcC5ydS5jb3JwLmFjcm9uaXMuY29tIiwibmFtZSI6Ikl2YW4gSXZhbm92IiwibmJmIjoxNDQ5NjY3ODAwLCJzY29wZSI6WyJBZ2VudFJlZ2lzdHJhdGlvbiJdLCJ0ZW5hbnRJZCI6IjQiLCJ1aWQiOiJzdUB0ZXN0LmNvbSJ9Cg.fcbY_QmuDH7FMAhM6JySPpHpFUdnPxuXJxnoetyG6p8"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/branding

/branding/scheme/available get

Actions with color schemes

get

Get all available color schemes

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "title": "branding_avaliable_response",
    "type": "array",
    "description": "/branding/scheme/available/GET response",
    "items": [
        {
            "type": "string",
            "title": "item",
            "description": "Scheme identifier"
        }
    ],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

[
    "avaliable",
    "branding",
    "example"
]

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/brands

/brands/{brand} get

Actions with brands

get

Get brand details by id

Request
Response

URI Parameters

brand: required(string)

Annotations

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "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", "owns_custom_legal_docs", "white_labeled_agent"],
     "properties": {
        "support_phone": {
            "type": ["string", "null"],
            "title": "support_phone",
            "description": "Company support phone number"
        },
        "id": {"$ref": "#/definitions/id"},
        "account_server_url": {
            "type": ["string", "null"],
            "title": "account_server_url",
            "description": "Link to account server"
        },
        "support_url": {
            "type": ["string", "null"],
            "title": "support_url",
            "description": "Support page address"
        },
        "mobile_app_android_download_url": {
            "type": ["string", "null"],
            "title": "mobile_app_android_download_url",
            "description": "Link for Android mobile app download"
        },
        "upsell_url": {
            "type": ["string", "null"],
            "title": "upsell_url",
            "description": "Link for partner`s Buy page"
        },
        "backup_console_url": {
            "type": "string",
            "title": "backup_console_url",
            "description": "Link to Backup Console"
        },
        "terms_url": {
            "type": ["string", "null"],
            "title": "terms_url",
            "description": "Company terms and conditions page url"
        },
        "home_url": {
            "type": ["string", "null"],
            "title": "home_url",
            "description": "Company web-site url"
        },
        "knowledgebase_url": {
            "type": ["string", "null"],
            "title": "knowledgebase_url",
            "description": "Knowledge base url"
        },
        "platform_terms_url": {
            "type": ["string", "null"],
            "title": "platform_terms_url",
            "description": "Terms and conditions page for platform"
        },
        "user_guide_url": {
            "type": ["string", "null"],
            "title": "user_guide_url",
            "description": "User guide url"
        },
        "mobile_app_ios_download_url": {
            "type": ["string", "null"],
            "title": "mobile_app_ios_download_url",
            "description": "Link for iOS mobile app download"
        },
        "color": {
            "type": ["string", "null"],
            "title": "color",
            "description": "Brand color in RGB"
        },
        "company_name": {
            "type": ["string", "null"],
            "title": "company_name",
            "description": "Company name"
        },
        "color_scheme": {
            "type": "string",
            "title": "color_scheme",
            "description": "Color scheme identifier"
        },
        "logotype": {"$ref": "#/definitions/id"},
        "service_name": {
            "type": ["string", "null"],
            "title": "service_name",
            "description": "Name of the service"
        },
        "reg_server_url": {
            "type": ["string", "null"],
            "title": "reg_server_url",
            "description": "Registration server URL"
        },
        "router_url": {
            "type": ["string", "null"],
            "title": "router_url",
            "description": "Link to Management Console"
        },
        "agent_gateway_url": {
            "type": ["string", "null"],
            "title": "agent_gateway_url",
            "description": "Agent gateway URL"
        },
        "help_url": {
            "type": ["string", "null"],
            "title": "help_url",
            "description": "Online help url"
        },
        "privacy_policy_url": {
            "type": ["string", "null"],
            "title": "platform_terms_url",
            "description": "Platform privacy policy"
        },
        "owns_custom_legal_docs": {
            "type": "boolean",
            "title": "owns_custom_legal_docs",
            "description": "Flag that decides if brand owns custom terms urls"
        },
        "white_labeled_agent": {
            "type": "boolean",
            "title": "white_labeled_agent",
            "description": "Acronis branded or white labeled agent"
        }
    },
    "definitions": {
        "id": {"$ref": "../_common/types/id.json"}
    },
   "title": "get_brand_response",
    "type": "object",
    "description": "/brands/{brand}/GET response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "support_phone": "+1 1111 1111111",
    "id": 1,
    "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": 1,
    "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

/ca

/ca/certificate get

Retrieve certificate authority

get

Get ca certificate

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

ca: (number)
The certificate authority id, by default root authority is used
Example:
```
1
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/ca/crl get

Retrieve CRL

get

Get ca crl

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

ca: (number)
The certificate authority id, by default root authority is used
Example:
```
1
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/checkauth

Check authentication for all methods. Internal use only

/checkauth delete get post put head options

delete

Check authentication for delete. Internal use only

get

Check authentication for get. Internal use only

post

Check authentication for post. Internal use only

put

Check authentication for put. Internal use only

head

Check authentication for head. Internal use only

options

Check authentication for options. Internal use only

Check authentication for delete. Internal use only

Secured by session

Secured by basicAuth

Annotations

roles_lib.x-tags
```
["private"]
```

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Check authentication for get. Internal use only

Secured by session

Secured by basicAuth

Annotations

roles_lib.x-tags
```
["private"]
```

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Check authentication for post. Internal use only

Secured by session

Secured by basicAuth

Annotations

roles_lib.x-tags
```
["private"]
```

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Check authentication for put. Internal use only

Secured by session

Secured by basicAuth

Annotations

roles_lib.x-tags
```
["private"]
```

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Check authentication for head. Internal use only

Secured by session

Secured by basicAuth

Annotations

roles_lib.x-tags
```
["private"]
```

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Check authentication for options. Internal use only

Secured by session

Secured by basicAuth

Annotations

roles_lib.x-tags
```
["private"]
```

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/content

/content/images/{image} get

Actions with images

get

Get a png image by id

Secured by session

Secured by basicAuth

URI Parameters

image: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Headers

Content-Type: required(string)
Example:
```
image/png
```
Cache-Control: (string)
Example:
```
max-age=86400, must-revalidate
```

Body

Media type: image/png

Type: any

HTTP status code 304

Mot modified

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Not Modified"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/datacenter

Platform datacenter management

/datacenter/backupservers get post

Manage backup servers

get

Get backup servers list

post

WARNING! Might lead to tragic consequences. Use with caution! Register a new backup server in datacenter

Get backup servers list

Secured by session

Secured by basicAuth

Annotations

AllowedTo
```
["root_admin"]
```
roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "items": {
            "type": "array",
            "title": "items",
            "items": {
                "properties": {
                    "id": {"$ref": "#/definitions/id"},
                    "utilization": {
                        "type": "integer",
                        "title": "utilization",
                        "description": "Backup server utilization counter"
                    },
                    "address": {
                        "type": "string",
                        "title": "address",
                        "description": "External backup server address"
                    },
                    "internal_address": {
                        "type": "string",
                        "title": "internal_address",
                        "description": "Internal backup server address"
                    },
                    "public_key": {
                        "type": "string",
                        "title": "public_key",
                        "description": "ZMQ public key of backup server"
                    }
                },
                "type": "object",
                "required": ["id", "address", "utilization", "internal_address"]
            },
            "description": "Backup servers list"
        }
    },
    "title": "backupservers_get_response",
    "type": "object",
    "description": "/datacenter/backupservers/GET response",
    "definitions": {
        "id": {"$ref": "../../_common/types/id.json"}
    },
    "required": ["items"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "items": [
        {
            "id": 1,
            "utilization": 111,
            "address": "1.1.1.1:7777",
            "internal_address": "11.11.11.11:7777",
            "public_key": "RzZn52xoZzF4V6trvKHQTM"
        },
        {
            "id": 2,
            "utilization": 0,
            "address": "2.2.2.2:7777",
            "internal_address": "22.22.22.22:7777",
            "public_key": "RzZn52xoZzF4V6trvKHQTM"
        }
    ]
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

WARNING! Might lead to tragic consequences. Use with caution! Register a new backup server in datacenter

Secured by session

Secured by basicAuth

Annotations

AllowedTo
```
["root_admin"]
```
roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "address": {
            "type": "string",
            "title": "address",
            "description": "Server public dns-name or ip-address"
        },
        "agent_id": {
            "type": "string",
            "title": "agent_id",
            "description": "Instance id"
        },
        "public_key": {
            "type": "string",
            "title": "public_key",
            "description": "ZMQ public key of backup server"
        },
        "secret": {
            "type": "string",
            "title": "secret",
            "description": "Internal password of backup server"
        },
        "internal_address": {
            "type": "string",
            "title": "internal_address",
            "description": "Internal ip-address or dns name of backup server"
        }
    },
    "title": "backupservers_post_request",
    "type": "object",
    "description": "/datacenter/backupservers/POST request",
    "required": ["address", "agent_id"],
    "additionalProperties": false,
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "address": "baas.acronis.com; This is an example, use with caution!",
    "agent_id": "48AABA82-F122-49EA-A30C-606EF30F774A; This is an example, use with caution!",
    "public_key": "0Lom5P]cxOKp2K()W4LY<BT7wM^+kp5mtYh0nsd; This is an example, use with caution!",
    "secret": "T[x/dB(Un0NSZ(Y-LcqK)H)Htpg&H%y7mjU:=d; This is an example, use with caution!",
    "internal_address": "192.168.10.10; This is an example, use with caution!"
}

HTTP status code 201

Created

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "server_pubkey": {
            "type": "string",
            "title": "server_pubkey",
            "description": "ZMQ public key"
        },
        "server_address": {
            "type": "string",
            "title": "server_address",
            "description": "Server dns-name or ip-address to connect agents"
        }
    },
    "title": "backupservers_post_response",
    "type": "object",
    "request": ["server_pubkey", "server_address"],
    "description": "/datacenter/backupservers/POST response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "server_pubkey": "0Lom5P]cxOKp2K()W4LY<BT7wM^+kp5mtYh0nsd",
    "server_address": "baas.acronis.com:7786"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 409

Conflict

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Conflict"
    },
    "message": "Conflict",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 409
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/datacenter/backupservers/online_agents post

Manage backup servers agents

post

Update count of online agents

Secured by session

Secured by basicAuth

Annotations

AllowedTo
```
["root_admin"]
```
roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "online_agents_count": {
            "type": "integer",
            "title": "online_agents_count",
            "description": "Online agents count (minimal: 0)",
            "minimum": 0
        },
        "backup_server_ip_address": {
            "type": "string",
            "title": "internal_address",
            "description": "Internal ip-address or dns name of backup server"
        }
    },
    "title": "online_agents_post_request",
    "type": "object",
    "additionalProperties": false,
    "description": "/datacenter/backupservers/online_agents/POST request",
    "required": ["online_agents_count", "backup_server_ip_address"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "online_agents_count": 10,
    "backup_server_ip_address": "192.168.10.10; This is an example, use with caution!"
}

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 409

Conflict

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Conflict"
    },
    "message": "Conflict",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 409
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/datacenter/gateways post

Manage registration servers

post

Secured by session

Secured by basicAuth

Annotations

AllowedTo
```
["root_admin"]
```
roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "address": {
            "type": "string",
            "title": "address",
            "description": "Server public dns-name or ip-address"
        },
        "cipher_key": {
            "type": "string",
            "title": "cipher_key",
            "description": "Secret key that is used to get access to web-console of service"
        }
    },
    "title": "gateway_post_request",
    "type": "object",
    "description": "/datacenter/gateways/POST request",
    "required": ["address", "cipher_key"],
    "additionalProperties": false,
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "address": "00.00.00.00",
    "cipher_key": "7DA9wudxuiBsPMx1qx9eUZw67dmOndpXkwrpfTihJLte3lJbMJKR1u8BTm67yVXgl9pDDgf3QVGdayHriZkyDWD8NWKIfF"
}

HTTP status code 201

Created

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Created"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 409

Conflict

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Conflict"
    },
    "message": "Conflict",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 409
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups

Groups management

/groups get

get

Search group by name, backup account by login or administrators by login

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin","tenant_viewer"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

limit: (number)
Limit the result, limited number of accounts + limited number of tenants. Default = 10
Example:
```
10
```
prefix: (string)
Prefix to search
Example:
```
group
```
strict: (number)
If true, then only exact matches are returned. Default = 0
Example:
```
0
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "items": {
            "type": "array",
            "title": "items",
            "items": {
                "properties": {
                    "id": {"$ref": "#/definitions/id"},
                    "uuid": {"$ref": "#/definitions/uuid"},
                    "name": {
                        "type": "string",
                        "title": "name",
                        "description": "Instance name"
                    },
                    "parent_id": {
                        "anyOf": [
                            {"$ref": "#/definitions/id"},
                            {"type": "null"}
                        ]
                    },
                    "kind": {
                        "anyOf": [
                            {
                                "type": "null",
                                "description": "Kind for Admin"
                            },
                            {"$ref": "#/definitions/group_kind"}
                        ]
                    }
                },
                "type": "object"
            },
            "description": "items"
        }
    },
    "title": "groups_search_response",
    "type": "object",
    "description": "/groups/GET response",
    "required": ["items"],
    "definitions": {
        "id": {"$ref": "../_common/types/id.json"},
        "uuid": {"$ref": "../_common/types/uuid.json"},
        "group_kind": {"$ref": "../_common/types/group_kind.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "items": [
        {
            "id": 11223344,
            "uuid": "bfe40b45-7d3f-4183-a655-afa62b59b383",
            "name": "Example group",
            "parent_id": 1,
            "kind": 40
        },
        {
            "id": 11223344,
            "uuid": "1c234e69-5469-424a-a6d1-ff5658b387a6",
            "name": "Example admin",
            "parent_id": 11223344,
            "kind": 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group} delete get put

Certain group management

delete

Remove given group

get

Get detailed information about selected group

put

Update group`s properties

Remove given group

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

version: (number)
Client`s version of an object
Example:
```
1
```

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 426

Version mismatch

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Version mismatch"
    },
    "message": "Version mismatch",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 426
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Get detailed information about selected group

Secured by session

Secured by basicAuth

Secured by oauth2

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["public"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "brand": {
            "anyOf": [
                {
                    "type": "null",
                    "description": "Brand is not enabled"
                },
                {"$ref": "#/definitions/id"}
            ]
        },
        "capabilities": {
            "type": "integer",
            "title": "capabilities",
            "description": "Group capabilities"
        },
        "customer_id": {
            "type": ["string", "null"],
            "title": "customer_id",
            "description": "Client customer id"
        },
        "creation_date": {
            "title": "creation_date",
            "description": "Unix timestamp with group creation date",
            "type": ["integer", "null"]
        },
        "customer_type": {"$ref": "#/definitions/customer_type"},
        "default_identity_provider_id": {"$ref": "#/definitions/id"},
        "external": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if group is managed by an external system"
        },
        "id": {"$ref": "#/definitions/id"},
        "uuid": {"ref": "#/definitions/uuid"},
        "internal_tag": {
            "type": ["string", "null"],
            "title": "internal_tag",
            "description": "Internal group tag"
        },
        "grade": {
            "type": "integer",
            "title": "grade",
            "description": "Grade of group eq nesting level"
        },
        "kind": {"$ref": "#/definitions/group_kind"},
        "language": {
            "type": "string",
            "title": "language",
            "description": "Language to use for group reports"
        },
        "migration_enabled": {
            "anyOf": [
                {
                    "type": "null",
                    "description": "Migration is not enabled"
                },
                {
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if migration is enabled"
                }
            ]
        },
        "migration_service": {
            "type": "string",
            "title": "migration_service",
            "description": "Url to Backup Agent portal"
        },
        "name": {
            "type": "string",
            "title": "name",
            "description": "Name of group, should be unique within the same hierachy"
        },
        "parent_has_access": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if parent has access to given group"
        },
        "parent_id": {
            "anyOf": [
                {
                    "type": "null",
                    "description": "Sometimes root group can have no parent"
                },
                {"$ref": "#/definitions/id"}
            ]
        },
        "status": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if group is enabled"
        },
        "version": {"$ref": "#/definitions/version"},
        "billing": {
            "$ref": "#/definitions/contact",
            "description": "Billing contact",
            "required": ["address1", "address2", "city", "country", "email", "firstname", "lastname", "phone", "state", "zipcode"]
        },
        "contact": {
            "$ref": "#/definitions/contact",
            "description": "Group contact",
            "required": ["address1", "address2", "city", "country", "email", "firstname", "lastname", "phone", "state", "zipcode"]
        },
        "storage": {
            "oneOf": [
                {
                    "properties": {
                        "id": {"type": "null"},
                        "uuid": {"type": "null"},
                        "name": {"enum": [""]}
                    },
                    "type": "object",
                    "title": "storage",
                    "description": "Group`s storage placeholder",
                    "required": ["id", "uuid", "name"]
                },
                {
                    "properties": {
                        "id": {"$ref": "#/definitions/id"},
                        "uuid": {"$ref": "#/definitions/uuid"},
                        "name": {
                            "type": "string",
                            "title": "name",
                            "description": "Storage name"
                        }
                    },
                    "type": "object",
                    "title": "storage",
                    "description": "Group`s storage",
                    "required": ["id", "uuid", "name"]
                }

            ]
        },
        "privileges": {
            "$ref": "#/definitions/privileges",
            "required": [
                "local_backup",
                "quota_mailbox_instance_storage",
                "quota_mailboxes_hard",
                "quota_websites_hard",
                "quota_universal_devices_hard",
                "quota_mobiles_hard",
                "quota_servers_hard",
                "quota_storage_hard",
                "quota_local_storage_hard",
                "quota_virtualhosts_hard",
                "quota_vms_hard",
                "quota_win_server_essentials_hard",
                "quota_workstations_hard",
                "storage_size",
                "local_storage_size",
                "workstation_count",
                "server_count",
                "vm_count",
                "mobile_count",
                "virtualhost_count",
                "win_server_essential_count",
                "mailbox_count",
                "website_count",
                "subscription_expiration",
                "visible",
                "permitted",
                "cloud_to_cloud_backup"
            ]
        },
        "usage": {
            "$ref": "#/definitions/usage",
            "required": [
                "storage_size",
                "local_storage_size",
                "workstation_count",
                "server_count",
                "vm_count",
                "mobile_count",
                "virtualhost_count",
                "win_server_essential_count",
                "mailbox_count",
                "website_count",
                "service_users",
                "slices_count",
                "size_for_workstations",
                "size_for_servers",
                "size_for_vms",
                "size_for_mobiles",
                "size_for_virtualhosts",
                "size_for_win_server_essentials",
                "size_for_mailboxes",
                "size_for_websites",
                "size_for_universal_devices"
            ]
        },
        "agents": {
            "properties": {
                "autoupdate": {
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if autoupdate is enable"
                }
            },
            "type": "object",
            "title": "agents",
            "description": "agents"
        },
        "pricing": {
            "properties": {
                "price": {
                    "type": ["number", "null"],
                    "title": "price",
                    "description": "Base cost"
                },
                "enabled": {
                    "anyOf": [
                        {
                            "type": "null",
                            "description": "Pricing is not available"
                        },
                        {
                            "$ref": "#/definitions/flag",
                            "description": "Flag that defines if pricing is enabled"
                        }
                    ]
                },
                "storage_discount": {
                    "type": ["number", "null"],
                    "title": "storage_discount",
                    "description": "Discount %. DEPRECATED."
                },
                "rating": {
                    "type": ["integer", "null"],
                    "title": "rating",
                    "description": "Rating. DEPRECATED."
                },
                "mode_update_date": {
                    "type": ["integer", "null"],
                    "title": "mode_update_date",
                    "description": "Pricing mode update date"
                },
                "mode": {
                    "$ref": "#/definitions/pricing_mode",
                    "description": "Pricing mode"
                },
                "currency": {
                    "type": "string",
                    "title": "currency",
                    "description": "Currency identifier"
                },
                "discounts": {
                    "type": "array",
                    "title": "discounts",
                    "items": {
                        "properties": {
                            "enabled": {
                                "$ref": "#/definitions/flag",
                                "description": "Flag that defines if pricing is enabled"
                            },
                            "name": {
                                "type": "string",
                                "title": "name",
                                "description": "Option name"
                            }
                        },
                        "type": "object"
                    },
                    "description": "DEPRECATED"
                }
            },
            "type": "object",
            "title": "pricing",
            "description": "pricing"
        }
    },
    "required": [
        "brand",
        "customer_id",
        "customer_type",
        "id",
        "uuid",
        "internal_tag",
        "grade",
        "kind",
        "language",
        "migration_enabled",
        "migration_service",
        "name",
        "parent_has_access",
        "parent_id",
        "status",
        "version",
        "capabilities",
        "default_identity_provider_id",
        "external",
        "billing",
        "contact",
        "storage",
        "agents",
        "pricing",
        "privileges",
        "usage"
    ],
    "title": "groups_get_response",
    "type": "object",
    "description": "/groups/{group}/GET response",
    "$schema": "http://json-schema.org/draft-04/schema",
    "definitions": {
        "uuid": {"$ref": "../../_common/types/uuid.json"},
        "id": {"$ref": "../../_common/types/id.json"},
        "access_type": {"$ref": "../../_common/types/access_type.json"},
        "flag": {"$ref": "../../_common/types/flag.json"},
        "version": {"$ref": "../../_common/types/version.json"},
        "group_kind": {"$ref": "../../_common/types/group_kind.json"},
        "customer_type": {"$ref": "../../_common/types/customer_type.json"},
        "privileges": {"$ref": "../../_common/quotas_and_privileges.json"},
        "usage": {"$ref": "../../_common/usage.json"},
        "contact": {"$ref": "../../_common/contact.json"},
        "pricing_mode": {"$ref": "../../_common/types/pricing_mode.json"}
    }
}

Example:

{
    "kind": 40,
    "brand": 1,
    "status": 1,
    "billing": {
        "firstname": "Example",
        "state": "Example",
        "lastname": "Example",
        "phone": "+1(0000)-0000-0000",
        "address1": "Example",
        "city": "Example",
        "country": "Example",
        "address2": "Example",
        "email": "example@mail.com",
        "zipcode": "00000-0000"
    },
    "external": 1,
    "customer_type": 0,
    "creation_date": 1213213,
    "default_identity_provider_id": 1,
    "contact": {
        "firstname": "Example",
        "state": "Example",
        "lastname": "Example",
        "phone": "+1(0000)-0000-0000",
        "address1": "Example",
        "city": "Example",
        "country": "Example",
        "address2": "Example",
        "email": "example@mail.com",
        "zipcode": "00000-0000"
    },
    "capabilities": 1,
    "customer_id": "Example",
    "migration_service": "http://example.com",
    "language": "en",
    "name": "Example",
    "internal_tag": "Example",
    "storage": {
        "id": 1,
        "uuid": "fb261178-06bc-4268-9337-9639e049e1c8",
        "name": "Example"
    },
    "privileges": {
        "server_count": 1,
        "quota_vms_hard": 1,
        "vm_count": 1,
        "quota_mailbox_instance_storage": 1,
        "quota_win_server_essentials_hard": 1,
        "virtualhost_count": 1,
        "workstation_count": 1,
        "local_backup": {
            "visible": 0,
            "permitted": 0
        },
        "quota_workstations_hard": 1,
        "win_server_essential_count": 1,
        "subscription_expiration": 1461801600,
        "quota_mobiles_hard": 1,
        "quota_virtualhosts_hard": 1,
        "quota_storage_hard": 1000,
        "quota_local_storage_hard": 1000,
        "mailbox_count": 1,
        "website_count": 1,
        "universal_devices_count": 1,
        "storage_size": 1000,
        "local_storage_size": 1000,
        "quota_servers_hard": 1,
        "mobile_count": 1,
        "quota_mailboxes_hard": 1,
        "quota_websites_hard": 1,
        "quota_universal_devices_hard": 1,
        "cloud_to_cloud_backup": 0
    },
    "migration_enabled": 1,
    "parent_id": 1,
    "version": 1,
    "grade": 1,
    "usage": {
        "server_count": 1,
        "win_server_essential_count": 1,
        "vm_count": 1,
        "storage_size": 1,
        "local_storage_size": 1,
        "virtualhost_count": 1,
        "mailbox_count": 1,
        "website_count": 1,
        "universal_devices_count": 1,
        "service_users": 1,
        "workstation_count": 1,
        "mobile_count": 1
    },
    "agents": {
        "autoupdate": 1
    },
    "pricing": {
        "price": 0.1,
        "enabled": 1,
        "storage_discount": 20.5,
        "rating": 2,
        "mode_update_date": 1,
        "mode": 1,
        "currency": "USD",
        "discounts": [
            {
                "enabled": 1,
                "name": "DEPRECATED"
            }
        ]
    },
    "parent_has_access": 1,
    "id": 1,
    "uuid": "2d279ee8-524b-4400-bc2d-b5d88616879d"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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:

{
    "title": "post_response_403",
    "type": "object",
    "description": "/login/POST 403 response",
    "$schema": "http://json-schema.org/draft-04/schema",
    "properties":{
        "message":{
            "type": "string",
            "description": "Response message"
        },
        "client_ip":{
            "type": "string",
            "description": "Client ip",
            "format": "ipv4"
        }
    }
}

Example:

{
    "client_ip": "7.7.7.7",
    "message": "Access from your IP is not allowed"
}

Update group`s properties

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

version: (number)
Client`s version of an object
Example:
```
1
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "brand": {
            "anyOf": [
                {
                    "type": "null",
                    "description": "Brand is not enabled"
                },
                {"$ref": "#/definitions/id"}
            ]
        },
        "capabilities": {
            "type": "integer",
            "title": "capabilities",
            "description": "Group capabilities"
        },
        "customer_id": {
            "type": ["string", "null"],
            "title": "customer_id",
            "description": "Client customer id"
        },
        "customer_type": {"$ref": "#/definitions/customer_type"},
        "default_identity_provider_id": {"$ref": "#/definitions/id"},
        "external": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if group is managed by an external system"
        },
        "internal_tag": {
            "type": ["string", "null"],
            "title": "internal_tag",
            "description": "Internal group tag"
        },
        "grade": {
            "type": "integer",
            "title": "grade",
            "description": "Grade of group eq nesting level"
        },
        "kind": {"$ref": "#/definitions/group_kind"},
        "language": {
            "type": "string",
            "title": "language",
            "description": "Language to use for group reports"
        },
        "migration_enabled": {
            "anyOf": [
                {
                    "type": "null",
                    "description": "Migration is not enabled"
                },
                {
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if migration is enabled"
                }
            ]
        },
        "migration_service": {
            "type": "string",
            "title": "migration_service",
            "description": "Url to Backup Agent portal"
        },
        "name": {
            "type": "string",
            "title": "name",
            "description": "Name of group, should be unique within the same hierachy"
        },
        "parent_has_access": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if parent has access to given group"
        },
        "parent_id": {
            "anyOf": [
                {
                    "type": "null",
                    "description": "Sometimes root group can have no parent"
                },
                {"$ref": "#/definitions/id"}
            ]
        },
        "status": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if group is enabled"
        },
        "billing": {
            "$ref": "#/definitions/contact",
            "description": "Billing contact"
        },
        "contact": {
            "$ref": "#/definitions/contact",
            "description": "Group contact"
        },
        "storage": {
            "properties": {
                "id": {"$ref": "#/definitions/id"},
                "name": {
                    "type": "string",
                    "title": "name",
                    "description": "Storage name"
                }
            },
            "type": "object",
            "title": "storage",
            "description": "Group`s storage"
        },
        "privileges": {
            "$ref": "#/definitions/privileges"
        },
        "usage": {
            "$ref": "#/definitions/usage"
        },
        "agents": {
            "properties": {
                "autoupdate": {
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if autoupdate is enable"
                }
            },
            "type": "object",
            "title": "agents",
            "description": "agents"
        },
        "pricing": {
            "properties": {
                "price": {
                    "type": ["number", "null"],
                    "title": "price",
                    "description": "Base cost"
                },
                "enabled": {
                    "anyOf": [
                        {
                            "type": "null",
                            "description": "Pricing is not avaliable"
                        },
                        {
                            "$ref": "#/definitions/flag",
                            "description": "Flag that defines if pricing is enabled"
                        }
                    ]
                },
                "storage_discount": {
                    "type": ["number", "null"],
                    "title": "storage_discount",
                    "description": "Discount %. DEPRECATED."
                },
                "rating": {
                    "type": ["integer", "null"],
                    "title": "rating",
                    "description": "Rating. DEPRECATED."
                },
                "mode_update_date": {
                    "type": ["integer", "null"],
                    "title": "mode_update_date",
                    "description": "Pricing mode update date"
                },
                "mode": {
                    "$ref": "#/definitions/pricing_mode",
                    "title": "mode",
                    "description": "Pricing mode"
                },
                "currency": {
                    "type": "string",
                    "title": "currency",
                    "description": "Currency identifier"
                },
                "discounts": {
                    "type": "array",
                    "title": "discounts",
                    "items": {
                        "properties": {
                            "enabled": {
                                "$ref": "#/definitions/flag",
                                "description": "Flag that defines if pricing is enabled"
                            },
                            "name": {
                                "type": "string",
                                "title": "name",
                                "description": "Option name"
                            }
                        },
                        "type": "object"
                    },
                    "description": "DEPRECATED"
                }
            },
            "type": "object",
            "title": "pricing",
            "description": "pricing"
        }
    },
    "title": "groups_put_request",
    "type": "object",
    "additionalProperties": false,
    "description": "/groups/{group}/PUT request",
    "$schema": "http://json-schema.org/draft-04/schema",
    "definitions": {
        "id": {"$ref": "../../_common/types/id.json"},
        "access_type": {"$ref": "../../_common/types/access_type.json"},
        "flag": {"$ref": "../../_common/types/flag.json"},
        "version": {"$ref": "../../_common/types/version.json"},
        "group_kind": {"$ref": "../../_common/types/group_kind.json"},
        "customer_type": {"$ref": "../../_common/types/customer_type.json"},
        "privileges": {"$ref": "../../_common/quotas_and_privileges.json"},
        "usage": {"$ref": "../../_common/usage.json"},
        "contact": {"$ref": "../../_common/contact.json"},
        "pricing_mode": {"$ref": "../../_common/types/pricing_mode.json"}
    }
}

Example:

{
    "kind": 40,
    "name": "Example",
    "status": 1,
    "billing": {
        "firstname": "Example",
        "state": "Example",
        "lastname": "Example",
        "phone": "+1(0000)-0000-0000",
        "address1": "Example",
        "city": "Example",
        "country": "Example",
        "address2": "Example",
        "email": "example@mail.com",
        "zipcode": "00000-0000"
    },
    "internal_tag": "Example",
    "language": "en",
    "privileges": {
        "server_count": 1,
        "quota_vms_hard": 1,
        "vm_count": 1,
        "quota_mailbox_instance_storage": 1,
        "quota_win_server_essentials_hard": 1,
        "virtualhost_count": 1,
        "workstation_count": 1,
        "local_backup": {
            "permitted": 0,
            "visible": 0
        },
        "quota_workstations_hard": 1,
        "win_server_essential_count": 1,
        "subscription_expiration": 1461801600,
        "quota_mobiles_hard": 1,
        "quota_virtualhosts_hard": 1,
        "quota_storage_hard": 1000,
        "quota_local_storage_hard": 1000,
        "mailbox_count": 1,
        "website_count": 1,
        "universal_devices_count": 1,
        "storage_size": 1000,
        "local_storage_size": 1000,        
        "quota_servers_hard": 1,
        "mobile_count": 1,
        "quota_mailboxes_hard": 1,
        "quota_websites_hard": 1,
        "quota_universal_devices_hard": 1
    },
    "customer_type": 0,
    "parent_id": 1,
    "default_identity_provider_id": 1,
    "pricing": {
        "price": 0.1,
        "mode": 1,
        "currency": "USD",
        "discounts": [
            {
                "enabled": 1,
                "name": "DEPRECATED"
            }
        ],
        "enabled": 1
    },
    "customer_id": "Example",
    "parent_has_access": 1,
    "contact": {
        "firstname": "Example",
        "state": "Example",
        "lastname": "Example",
        "phone": "+1(0000)-0000-0000",
        "address1": "Example",
        "city": "Example",
        "country": "Example",
        "address2": "Example",
        "email": "example@mail.com",
        "zipcode": "00000-0000"
    },
    "agents": {
        "autoupdate": 1
    }
}

HTTP status code 200

Object has been updated

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "version": {"$ref": "#/definitions/version"}
    },
    "title": "version",
    "type": "object",
    "description": "Common version response",
    "definitions": {
        "version": {"$ref": "types/version.json"}
    },
    "required": ["version"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "version": 11223344
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 409

Conflict

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Conflict"
    },
    "message": "Conflict",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 409
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

HTTP status code 426

Version mismatch

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Version mismatch"
    },
    "message": "Version mismatch",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 426
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/admins get post

Admins management

get

Get list of administrators for selected group

post

Create a new administrator in specified group. DO NOT USE FOR CREATING SERVICE USERS, THIS SCENARIO WILL BE REMOVED IN FUTURE VERSIONS

Get list of administrators for selected group

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "items": {
            "type": "array",
            "title": "items",
            "items": {
                "properties": {
                    "id": {"$ref": "#/definitions/id"},
                    "user_id": {"$ref": "#/definitions/id"},
                    "uuid": {"$ref": "#/definitions/uuid"},
                    "firstname": {
                        "type": "string",
                        "title": "firstname",
                        "description": "Administrator`s firstname"
                    },
                    "lastname": {
                        "type": "string",
                        "title": "lastname",
                        "description": "Administrator`s lastname"
                    },
                    "login": {
                        "type": "string",
                        "title": "login",
                        "description": "Administrator`s login"
                    },
                    "language": {
                        "type": "string",
                        "title": "language",
                        "description": "Preferred admin language"
                    },
                    "roles": {"$ref": "#/definitions/admin_role"},
                    "status": {
                        "$ref": "#/definitions/account_status"
                    },
                    "access_type": {"$ref": "#/definitions/access_type"},
                    "email": {"$ref": "#/definitions/email"},
                    "version": {"$ref": "#/definitions/version"}
                },
                "type": "object"
            },
            "description": "Admins list",
            "required": [
              "id",
              "uuid",
              "user_id",
              "firstname",
              "lastname",
              "login",
              "language",
              "roles",
              "status",
              "access_type",
              "email",
              "version"
            ]
        }
    },
    "definitions": {
        "account_status": {"$ref": "../../../_common/types/account_status.json"},
        "id": {"$ref": "../../../_common/types/id.json"},
        "access_type": {"$ref": "../../../_common/types/access_type.json"},
        "admin_role": {"$ref": "../../../_common/types/admin_role.json"},
        "flag": {"$ref": "../../../_common/types/flag.json"},
        "email": {"$ref": "../../../_common/types/email.json"},
        "version": {"$ref": "../../../_common/types/version.json"},
        "uuid": {"$ref": "../../../_common/types/uuid.json"}
    },
    "title": "admins_get_response",
    "type": "object",
    "required": ["items"],
    "description": "/groups/{group}/admins/GET response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "items": [
        {
            "firstname": "Example",
            "id": 1,
            "uuid": "21f79bb4-61e1-4099-b699-aa6512b3e2d0",
            "lastname": "Example",
            "login": "Example",
            "user_id": 1,
            "language": "en",
            "roles": 0,
            "status": 1,
            "access_type": 1,
            "email": "example@mail.com",
            "version": 1
        },
        {
            "firstname": "Example",
            "id": 2,
            "uuid": "f9c781df-074c-4c1c-95b0-9a03a750c61a",
            "lastname": "Example",
            "login": "Example",
            "user_id": 2,
            "language": "en",
            "roles": 0,
            "status": 1,
            "access_type": 1,
            "email": "example@mail.com",
            "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Create a new administrator in specified group. DO NOT USE FOR CREATING SERVICE USERS, THIS SCENARIO WILL BE REMOVED IN FUTURE VERSIONS

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo
```
["root_admin","partner_admin"]
```
roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "login": {
            "type": "string",
            "title": "login",
            "description": "Administrator`s login"
        },
        "language": {
            "type": "string",
            "title": "language",
            "description": "Preferred admin language"
        },
        "use_existing_identity": {
            "$ref": "#/definitions/flag",
            "description": "Flag that indicates if existing identity would be used to create new admin"
        },
        "access_type": {"$ref": "#/definitions/access_type"},
        "notifications_management": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if notification management was turned on"
        },
        "roles": {"$ref": "#/definitions/admin_role"},
        "notifications_backup": {"$ref": "#/definitions/notifications_backup"},
        "notifications_device_control": {"$ref": "#/definitions/notifications_device_control"},
        "notifications_certificate_management": {"$ref": "#/definitions/notifications_certificate_management"}
    },
    "definitions": {
        "access_type": {"$ref": "../../../_common/types/access_type.json"},
        "admin_role": {"$ref": "../../../_common/types/admin_role.json"},
        "flag": {"$ref": "../../../_common/types/flag.json"},
        "notifications_backup": {"$ref": "../../../_common/types/notifications_backup.json"},
        "notifications_device_control": {"$ref": "../../../_common/types/notifications_device_control.json"},
        "notifications_certificate_management": {"$ref": "../../../_common/types/notifications_certificate_management.json"}
    },
    "title": "admins_post_request",
    "type": "object",
    "description": "/groups/{group}/admins/POST request",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "firstname": "Example",
    "language": "en",
    "use_existing_identity": 0,
    "lastname": "Example",
    "email": "example@mail.com",
    "access_type": 1,
    "notifications_management": 0,
    "roles": 0,
    "login": "Example",
    "notifications_backup": 4,
    "notifications_device_control": 1,
    "notifications_certificate_management": 7
}

HTTP status code 201

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "id": {"$ref": "#/definitions/id"},
        "user_id": {"$ref": "#/definitions/id"},
        "version": {"$ref": "#/definitions/version"},
        "uuid": {"$ref": "#/definitions/uuid"}
    },
    "title": "admins_post_response",
    "type": "object",
    "required": ["id", "version", "user_id"],
    "description": "/groups/{group}/admins/POST response",
    "definitions": {
        "version": {"$ref": "../../../_common/types/version.json"},
        "id": {"$ref": "../../../_common/types/id.json"},
        "uuid": {"$ref": "../../../_common/types/uuid.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "id": 1,
    "user_id": 1,
    "version": 1,
    "uuid": "531e4cda-0a60-11e7-976d-dbb36750b7e2"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 409

Conflict

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Conflict"
    },
    "message": "Conflict",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 409
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/agents/autoupdate get post

Agent AutoUpdate feature management

get

Get AutoUpdate settings

post

Control AutoUpdate settings

Get AutoUpdate settings

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "status": {
            "$ref": "#/definitions/flag",
            "description": "Status"
        }
    },
    "title": "autoupdate_get_response",
    "type": "object",
    "description": "/groups/{group}/agents/autoupdate/GET response",
    "definitions": {
        "flag": {"$ref": "../../../_common/types/flag.json"}
    },
    "required": ["status"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "status": 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Control AutoUpdate settings

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo
```
["root_admin","partner_admin"]
```
roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "apply_for_children": {
            "$ref": "#/definitions/flag",
            "description": "The flag that defines if status is applied to only this group or it`s children too"
        },
        "status": {
            "$ref": "#/definitions/flag",
            "description": "Status"
        }
    },
    "title": "autoupdate_post_request",
    "type": "object",
    "description": "/groups/{group}/agents/autoupdate/POST request",
    "definitions": {
        "flag": {"$ref": "../../../_common/types/flag.json"}
    },
    "additionalProperties": false,
    "required": ["apply_for_children", "status"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "apply_for_children": 0,
    "status": 1
}

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/backup_server_migration put

Migrate groups between backup servers

put

Migrate group from one backup server to another

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo
```
["root_admin"]
```
roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "backup_server_id": {"$ref": "#/definitions/id"}
    },
    "title": "put_request",
    "type": "object",
    "description": "/groups/{group}/backup_server_migration/PUT request",
    "definitions": {
        "id": {"$ref": "../../../_common/types/id.json"}
    },
    "additionalProperties": false,
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "backup_server_id": 1
}

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "tenants": {
            "type": "array",
            "title": "tenants",
            "items": {
                "properties": {
                    "id": {"$ref": "#/definitions/id"}
                },
                "type": "object",
                "required": ["id"]
            },
            "description": "Tenants"
        },
        "backup_server": {
            "properties": {
                "port": {
                    "type": "integer",
                    "title": "port",
                    "description": "Backup server`s port number"
                },
                "internal_address": {
                    "type": "string",
                    "title": "internal_address",
                    "description": "Backup server`s internal address"
                },
                "public_key": {
                    "type": "string",
                    "title": "public_key",
                    "description": "Public key of the backup server"
                }
            },
            "type": "object",
            "title": "backup_server",
            "description": "Backup server put response",
            "required": ["port", "public_key", "internal_address"]
        }
    },
    "title": "groupsgroupbackup_server_migrationPUTresponse",
    "type": "object",
    "description": "/groups/{group}/backup_server_migration/PUT response",
    "required": ["backup_server", "tenants"],
    "definitions": {
        "id": {"$ref": "../../../_common/types/id.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "tenants": [
        {
            "id": 11
        }
    ],
    "backup_server": {
        "port": 1234,
        "internal_address": "10.20.30.40",
        "public_key": "fwerg555vb36y53cr"
    }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/backupconsole get

Manage access to backup console

get

Retrieve redirect url for backup console with access token

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

app: (string)
Specify that method called from third-party application
Example:
```
aps
```
language: (string)
Force using specified language in backup-console
Example:
```
en
```
username: (string)
The display name to show in logout button
Example:
```
aps
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "jwt": {
            "type": "string",
            "title": "jwt",
            "description": "Token to authorize on backup console"
        },
        "server_address": {
            "type": "string",
            "title": "server_address",
            "description": "Link to Backup Console for selected group"
        },
        "api_prefix": {
            "type": "string",
            "title": "api_prefix",
            "description": "Api prefix"
        },
        "token": {
            "type": "string",
            "title": "token",
            "description": "DEPRECATED"
        },
        "shard": {
            "type": "string",
            "title": "shard",
            "description": "Specified Backup Server address"
        },
        "host": {
            "type": "string",
            "title": "host",
            "description": "DEPRECATED"
        },
        "url": {
            "type": "string",
            "title": "url",
            "description": "Link to Backup Console for selected group"
        },
        "redirect_url": {
            "type": "string",
            "title": "redirect_url",
            "description": "Redirect URL"
        },
        "bc_path_prefix": {
            "type": "string",
            "title": "bc_path_prefix",
            "description": "Backup Console path prefix"
        }
    },
    "title": "get_response",
    "type": "object",
    "required": ["redirect_url", "url", "server_address", "api_prefix", "shard", "jwt", "host", "token", "bc_path_prefix"],
    "description": "/groups/{group}/backupconsole/GET response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "jwt": "Example",
    "server_address": "bc-baas.acronis.com",
    "api_prefix": "/api/ams/",
    "token": "Example",
    "shard": "10.250.1.1",
    "host": "http://bc-baas.acronis.com",
    "url": "http://bc-baas.acronis.com/#access_token=example",
    "bc_path_prefix": "/bc/",
    "redirect_url": "Example"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 406

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not Acceptable"
    },
    "message": "Not Acceptable",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 406
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/brand delete get post put

Manage brands

delete

Disable custom branding

get

Get branding options for specific group

post

Enable custom branding options

put

Modify custom branding options

Disable custom branding

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo
```
["root_admin","partner_admin"]
```
roles_lib.x-tags
```
["private"]
```

Query Parameters

version: (number)
Client`s version of an object
Example:
```
1
```

HTTP status code 200

Object has been updated

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "version": {"$ref": "#/definitions/version"}
    },
    "title": "version",
    "type": "object",
    "description": "Common version response",
    "definitions": {
        "version": {"$ref": "types/version.json"}
    },
    "required": ["version"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "version": 11223344
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 426

Version mismatch

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Version mismatch"
    },
    "message": "Version mismatch",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 426
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Get branding options for specific group

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin","tenant_viewer"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

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": "../../../_common/brand_public.json"},
        "smtp_settings":  {"$ref": "smtp_settings.json"}
    },
    "title": "get_response",
    "type": "object",
    "description": "/groups/{group}/brand/GET response",
    "$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": 1,
    "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",
    "router_url": "cloud.acronis.com",
    "agent_gateway_url": "https://agents.custom-cloud.acronis.com",
    "service_name": "myservice",
    "reg_server_url": "https://rs.custom-cloud.acronis.com",
    "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 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Enable custom branding options

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo
```
["root_admin","partner_admin"]
```
roles_lib.x-tags
```
["private"]
```

Query Parameters

version: (number)
Client`s version of an object
Example:
```
1
```

Body

Media type: application/json

Type: any

HTTP status code 200

Object has been updated

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "version": {"$ref": "#/definitions/version"}
    },
    "title": "version",
    "type": "object",
    "description": "Common version response",
    "definitions": {
        "version": {"$ref": "types/version.json"}
    },
    "required": ["version"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "version": 11223344
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 426

Version mismatch

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Version mismatch"
    },
    "message": "Version mismatch",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 426
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Modify custom branding options

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo
```
["root_admin","partner_admin"]
```
roles_lib.x-tags
```
["private"]
```

Query Parameters

version: (number)
Client`s version of an object
Example:
```
1
```

Body

Media type: application/json

Type: json

Content:

{
    "allOf": [
        {
            "$ref": "#/definitions/brand"
        },
        {
            "$ref": "#/definitions/smtp_settings"
        }
    ],
    "definitions": {
        "brand": {"$ref": "../../../_common/brand_public.json"},
        "smtp_settings":  {"$ref": "smtp_settings.json"}
    },
    "title": "get_response",
    "type": "object",
    "description": "/groups/{group}/brand/GET response",
    "$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": 1,
    "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

Object has been updated

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "version": {"$ref": "#/definitions/version"}
    },
    "title": "version",
    "type": "object",
    "description": "Common version response",
    "definitions": {
        "version": {"$ref": "types/version.json"}
    },
    "required": ["version"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "version": 11223344
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

HTTP status code 426

Version mismatch

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Version mismatch"
    },
    "message": "Version mismatch",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 426
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/children get post

Groups management

get

Get list of sub-groups for given group

post

Create a new group as child of a specified group

Get list of sub-groups for given group

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

request_type: (one of tenants_batch, uuids_list)
Request type, one of "tenants_batch" or "uuids_list". "uuids_list" will return list of uuids of child tenants "tenants_batch" will return list of tenants with given uuids
Example:
```
tenants_batch
```
uuids: (string)
When request_type is "tenants_batch", list of direct child tenant with given uuids is returned
Example:
```
1e4d7438-0ebe-11e7-b131-c7b5bde6feed,248c535a-0ebe-11e7-a80e-bbdaa1d60c7c
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "items": {
            "oneOf": [
                {
                    "type": "array",
                    "title": "items",
                    "items": {
                        "properties": {
                            "kind": {"$ref": "#/definitions/kind"},
                            "name": {
                                "type": "string",
                                "title": "name",
                                "description": "Name of the group"
                            },
                            "status": {
                                "$ref": "#/definitions/flag",
                                "description": "Group status"
                            },
                            "internal_tag": {
                                "type": ["string", "null"],
                                "title": "internal_tag",
                                "description": "Internal group tag"
                            },
                            "parent_has_access": {
                                "$ref": "#/definitions/flag",
                                "description": "Flag that defines if parent has access to given group"
                            },
                            "creation_date": {
                                "title": "creation_date",
                                "description": "Unix timestamp with group creation date",
                                "type": ["integer", "null"]
                            },
                            "storage": {
                                "oneOf": [
                                    {
                                        "properties": {
                                            "id": {"type": "null"},
                                            "uuid": {"type": "null"},
                                            "name": {"enum": [""]}
                                        },
                                        "type": "object",
                                        "title": "storage",
                                        "description": "Group`s storage placeholder",
                                        "required": ["id", "uuid", "name"]
                                    },
                                    {
                                        "properties": {
                                            "id": {"$ref": "#/definitions/id"},
                                            "uuid": {"$ref": "#/definitions/uuid"},
                                            "name": {
                                                "type": "string",
                                                "title": "name",
                                                "description": "Storage name"
                                            }
                                        },
                                        "type": "object",
                                        "title": "storage",
                                        "description": "Group`s storage",
                                        "required": ["id", "uuid", "name"]
                                    }

                                ]
                            },
                            "privileges": {
                                "OneOf": [
                                    {
                                        "$ref": "#/definitions/privileges",
                                        "required": [
                                            "local_backup",
                                            "quota_mailbox_instance_storage",
                                            "quota_mailboxes_hard",
                                            "quota_websites_hard",
                                            "quota_universal_devices_hard",
                                            "quota_mobiles_hard",
                                            "quota_servers_hard",
                                            "quota_storage_hard",
                                            "quota_local_storage_hard",
                                            "quota_virtualhosts_hard",
                                            "quota_vms_hard",
                                            "quota_win_server_essentials_hard",
                                            "quota_workstations_hard",
                                            "storage_size",
                                            "local_storage_size",
                                            "workstation_count",
                                            "server_count",
                                            "vm_count",
                                            "mobile_count",
                                            "virtualhost_count",
                                            "win_server_essential_count",
                                            "mailbox_count",
                                            "website_count",
                                            "subscription_expiration",
                                            "visible",
                                            "permitted"
                                        ]
                                    },
                                    {"type": "null"}
                                ]
                            },
                            "usage": {
                                "OneOf": [
                                    {
                                        "$ref": "#/definitions/usage",
                                        "required": [
                                            "storage_size",
                                            "local_storage_size",
                                            "workstation_count",
                                            "server_count",
                                            "vm_count",
                                            "mobile_count",
                                            "virtualhost_count",
                                            "win_server_essential_count",
                                            "mailbox_count",
                                            "website_count",
                                            "service_users",
                                            "slices_count",
                                            "size_for_workstations",
                                            "size_for_servers",
                                            "size_for_vms",
                                            "size_for_mobiles",
                                            "size_for_virtualhosts",
                                            "size_for_win_server_essentials",
                                            "size_for_mailboxes",
                                            "size_for_websites",
                                            "size_for_universal_devices"
                                        ]
                                    },
                                    {"type": "null"}
                                ]
                            },
                            "version": {"$ref": "#/definitions/version"},
                            "grade": {
                                "type": "integer",
                                "title": "grade",
                                "description": "Grade of group, used to calculate rules"
                            },
                            "capabilities": {
                                "type": "integer",
                                "title": "capabilities",
                                "description": "Capabilities of group"
                            },
                            "has_children": {
                                "$ref": "#/definitions/flag",
                                "description": "Flag that defines if group has children or not"
                            },
                            "pricing": {
                                "properties": {
                                    "enabled": {
                                        "anyOf": [
                                            {
                                                "type": "null",
                                                "description": "Pricing is not avaliable"
                                            },
                                            {"$ref": "#/definitions/flag"}
                                        ]
                                    },
                                    "mode": {
                                        "$ref": "#/definitions/pricing_mode"
                                    }
                                },
                                "required": ["enabled"],
                                "type": "object",
                                "title": "pricing",
                                "description": "pricing"
                            },
                            "id": {"$ref": "#/definitions/id"},
                            "uuid": {"$ref": "#/definitions/uuid"},
                            "external": {
                                "$ref": "#/definitions/flag",
                                "description": "Flag that defines if group is managed externally"
                            },
                            "mfa_status": {
                              "type": "string",
                              "description": "Multi-factor authentication status for tenant: 'disabled', 'forcibly_disabled', 'setup_required', 'enabled'"
                            }
                        },
                        "type": "object"
                    },
                    "description": "Tenant's child tenants list",
                    "required": [
                      "kind",
                      "parent_has_access",
                      "name",
                      "status",
                      "internal_tag",
                      "storage",
                      "privileges",
                      "usage",
                      "version",
                      "grade",
                      "capabilities",
                      "has_children",
                      "pricing",
                      "id",
                      "uuid",
                      "mfa_status"
                    ]
                },
                {
                  "type": "array",
                  "items": {
                    "$ref": "#/definitions/uuid"
                  }
                }
            ]
        }
    },
    "title": "get_children_response",
    "type": "object",
    "required": ["items"],
    "description": "/groups/{group}/children/GET response",
    "definitions": {
        "kind": {"$ref": "../../../_common/types/group_kind.json"},
        "id": {"$ref": "../../../_common/types/id.json"},
        "uuid": {"$ref": "../../../_common/types/uuid.json"},
        "privileges": {"$ref": "../../../_common/quotas_and_privileges.json"},
        "usage": {"$ref": "../../../_common/usage.json"},
        "version": {"$ref": "../../../_common/types/version.json"},
        "flag": {"$ref": "../../../_common/types/flag.json"},
        "pricing_mode": {"$ref": "../../../_common/types/pricing_mode.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "items": [
        {
            "kind": 40,
            "name": "Example",
            "status": 1,
            "parent_has_access": 1,
            "internal_tag": "Example",
            "creation_date": 1213213,
            "storage": {
                "id": 1,
                "uuid": "fb261178-06bc-4268-9337-9639e049e1c8",
                "name": "Acronis Storage"
            },
            "privileges": {
                "server_count": 1,
                "quota_vms_hard": 1,
                "vm_count": 1,
                "quota_mailbox_instance_storage": 1,
                "quota_win_server_essentials_hard": 1,
                "virtualhost_count": 1,
                "workstation_count": 1,
                "quota_workstations_hard": 1,
                "win_server_essential_count": 1,
                "subscription_expiration": 1461801600,
                "quota_mobiles_hard": 1,
                "quota_virtualhosts_hard": 1,
                "quota_storage_hard": 1000,
                "quota_local_storage_hard": 1000,
                "mailbox_count": 1,
                "website_count": 1,
                "universal_devices_count": 1,
                "storage_size": 1000,
                "local_storage_size": 1000,
                "quota_servers_hard": 1,
                "mobile_count": 1,
                "quota_mailboxes_hard": 1,
                "quota_websites_hard": 1,
                "quota_universal_devices_hard": 1
            },
            "usage": {
                "server_count": 1,
                "win_server_essential_count": 1,
                "vm_count": 1,
                "storage_size": 1,
                "local_storage_size": 1,
                "virtualhost_count": 1,
                "mailbox_count": 1,
                "website_count": 1,
                "universal_devices_count": 1,
                "service_users": 1,
                "workstation_count": 1,
                "mobile_count": 1
            },
            "version": 1,
            "grade": 1,
            "capabilities": 1,
            "has_children": 1,
            "pricing": {
                "enabled": 1,
                "mode": 2
            },
            "id": 1,
            "uuid": "dd69c0b9-0799-4398-8701-aee7a15a8dac",
            "mfa_status" : "disabled"
        }
    ]
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Create a new group as child of a specified group

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "internal_tag": {
            "type": [
                "string",
                "null"
            ],
            "title": "internal_tag",
            "description": "Internal tag"
        },
        "kind": {"$ref": "#/definitions/kind"},
        "name": {
            "type": "string",
            "title": "name",
            "description": "Name of group, should be unique on within same hierarchy"
        },
        "language": {
            "type": [
                "string",
                "null"
            ],
            "title": "language",
            "description": "Language"
        },
        "storage": {
            "anyOf": [
                {
                    "type": "null"
                },
                {"$ref": "#/definitions/id"}
            ]
        },
        "customer_id": {
            "type": [
                "string",
                "integer",
                "null"
            ],
            "title": "customer_id",
            "description": "Customer id"
        },
        "privileges": {
            "$ref": "#/definitions/privileges"
        },
        "agents": {
            "properties": {
                "autoupdate": {
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if autoupdate is enabled"
                }
            },
            "type": "object",
            "title": "agents",
            "description": "agents"
        },
        "contact": {"$ref": "#/definitions/contact"},
        "preferred_backup_server": {
            "anyOf": [
                {
                    "type": "null",
                    "description": "No preferred server"
                },
                {"$ref": "#/definitions/id"}
            ]
        },
        "pricing": {
            "properties": {
                "price": {
                    "type": ["number", "null"],
                    "title": "price",
                    "description": "Base price"
                },
                "mode": {
                    "type": "integer",
                    "title": "mode",
                    "description": "Pricing mode"
                },
                "currency": {
                    "type": "string",
                    "title": "currency",
                    "description": "Currency identifier"
                },
                "discounts": {
                    "type": "array",
                    "title": "discounts",
                    "items": {
                        "properties": {
                            "enabled": {
                                "type": "integer",
                                "title": "enabled",
                                "description": "DEPRECATED"
                            },
                            "name": {
                                "type": "string",
                                "title": "name",
                                "description": "DEPRECATED"
                            }
                        },
                        "type": "object"
                    },
                    "description": "items"
                },
                "enabled": {
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if pricing is enabled"
                }
            },
            "required": ["mode"],
            "type": "object",
            "title": "pricing",
            "description": "Pricing"
        }
    },
    "title": "post_children_request",
    "type": "object",
    "additionalProperties": false,
    "required": ["name", "kind"],
    "description": "/groups/{group}/children/POST request",
    "definitions":{
        "flag": {"$ref": "../../../_common/types/flag.json"},
        "id": {"$ref": "../../../_common/types/id.json"},
        "contact": {"$ref": "../../../_common/contact.json"},
        "kind": {"$ref": "../../../_common/types/group_kind.json"},
        "privileges": {"$ref": "../../../_common/quotas_and_privileges.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "kind": 40,
    "name": "Example",
    "language": "en",
    "storage": 1,
    "customer_id": "123asd",
    "privileges": {
        "server_count": 1,
        "quota_vms_hard": 1,
        "vm_count": 1,
        "quota_mailbox_instance_storage": 1,
        "quota_win_server_essentials_hard": 1,
        "virtualhost_count": 1,
        "workstation_count": 1,
        "local_backup": {
            "permitted": 0
        },
        "quota_workstations_hard": 1,
        "win_server_essential_count": 1,
        "subscription_expiration": 1461801600,
        "quota_mobiles_hard": 1,
        "quota_virtualhosts_hard": 1,
        "quota_storage_hard": 1000,
        "quota_local_storage_hard": 1000,
        "mailbox_count": 1,
        "website_count": 1,
        "universal_devices_count": 1,
        "storage_size": 1000,
        "local_storage_size": 1000,
        "quota_servers_hard": 1,
        "mobile_count": 1,
        "quota_mailboxes_hard": 1,
        "quota_websites_hard": 1,
        "quota_universal_devices_hard": 1
    },
    "agents": {
        "autoupdate": 1
    },
    "contact": {
        "firstname": "John",
        "state": "US",
        "lastname": "Doe",
        "phone": "+1(0000)-0000-0000",
        "address1": "555 Main Street",
        "city": "Nowhere",
        "country": "USA",
        "address2": "Apt. 5A",
        "email": "john.doe@mail.com",
        "zipcode": "00000-0000"
    },
    "preferred_backup_server": null,
    "pricing": {
        "price": 0.1,
        "mode": 1,
        "currency": "USD",
        "discounts": [
            {
                "enabled": 1,
                "name": "educations"
            }
        ],
        "enabled": 1
    }
}

HTTP status code 201

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "version": {"$ref": "#/definitions/version"},
        "id": {"$ref": "#/definitions/id"},
        "uuid": {"$ref": "#/definitions/uuid"}
    },
    "title": "version_id_uuid",
    "type": "object",
    "description": "Common version, id and uuid response",
    "definitions": {
        "version": {"$ref": "types/version.json"},
        "id": {"$ref": "types/id.json"},
        "uuid": {"$ref": "types/uuid.json"}
    },
    "required": ["version", "id", "uuid"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "version": 1,
    "id": 1,
    "uuid": "ec8ca020-0a5f-11e7-9bd1-e31e3bef811e"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 409

Conflict

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Conflict"
    },
    "message": "Conflict",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 409
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/limits/logon_ips delete get post

Logon ips limitation management

delete

Disable ip limits

get

Get ip limits settings

post

set ip limits settings. Supported formats for item:

single IP, ex. 203.0.113.2
IP range, ex. 203.0.113.23 - 203.0.113.200
IP subnetwork, ex. 203.0.113.32/27

Disable ip limits

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Get ip limits settings

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "status": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if ip limitation is enabled"
        },
        "items": {
            "type": "array",
            "items": {
                "type": "string",
                "format": "ipv4",
                "title": "item",
                "description": "White listed ip address"
            }
        }
    },
    "title": "logon_ips_get_response",
    "type": "object",
    "required": ["status", "items"],
    "description": "/groups/{group}/limits/logon_ips/GET response",
    "definitions": {
            "flag": {
                "$ref": "../../../_common/types/flag.json"
            }
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "status": 1,
    "items": [
        "127.0.0.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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

set ip limits settings. Supported formats for item:

single IP, ex. 203.0.113.2
IP range, ex. 203.0.113.23 - 203.0.113.200
IP subnetwork, ex. 203.0.113.32/27

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "items": {
            "type": "array",
            "items": {
                "type": "string",
                "title": "item",
                "description": "IP to be added to white list"
            }
        }
    },
    "title": "logon_ips_post_request",
    "type": "object",
    "additionalProperties": false,
    "required": ["items"],
    "description": "/groups/{group}/limits/logon_ips/POST request",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "items": [
        "203.0.113.2",
        "203.0.113.23 - 203.0.113.200"
    ]
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/lock delete post

Manage group`s hierarchy tree

delete

Unlock group`s hierarchy tree

post

Lock group`s hierarchy tree

Unlock group`s hierarchy tree

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo
```
["root_admin","partner_admin"]
```
roles_lib.x-tags
```
["private"]
```

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Lock group`s hierarchy tree

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo
```
["root_admin","partner_admin"]
```
roles_lib.x-tags
```
["private"]
```

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/logo get post

Manage group`s logo

get

Get group`s logo

post

Upload a new logotype

Get group`s logo

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Headers

Content-Type: required(string)
Example:
```
image/png
```
Cache-Control: (string)
Example:
```
max-age=86400, must-revalidate
```
Content-Length: required(string)
Example:
```
1
```

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Upload a new logotype

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo
```
["root_admin","partner_admin"]
```
roles_lib.x-tags
```
["private"]
```

Headers

Content-Type: required(string)
Example:
```
image/png
```
Content-Length: required(string)
Example:
```
1
```

Query Parameters

version: (number)
Client`s version of an object
Example:
```
1
```

Body

Media type: image/png

Type: any

HTTP status code 200

Object has been updated

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "version": {"$ref": "#/definitions/version"}
    },
    "title": "version",
    "type": "object",
    "description": "Common version response",
    "definitions": {
        "version": {"$ref": "types/version.json"}
    },
    "required": ["version"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "version": 11223344
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/migration get put

Migration management

get

Redirect to migration portal server with auth token

put

Set migration settings

Redirect to migration portal server with auth token

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Set migration settings

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo
```
["root_admin","partner_admin"]
```
roles_lib.x-tags
```
["private"]
```

Query Parameters

version: (number)
Client`s version of an object
Example:
```
1
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "migration_service": {
            "type": "string",
            "title": "migration_service",
            "description": "Url to Backup Agent portal"
        },
        "migration_enabled": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if Backup Agent migration is enabled"
        }
    },
    "title": "migration_put_request",
    "type": "object",
    "additionalProperties": false,
    "definitions": {
        "flag": {"$ref": "../../../_common/types/flag.json"}
    },
    "description": "/groups/{group}/migration/PUT request",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "migration_service": "http://portal.com",
    "migration_enabled": 1
}

HTTP status code 200

Object has been updated

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "version": {"$ref": "#/definitions/version"}
    },
    "title": "version",
    "type": "object",
    "description": "Common version response",
    "definitions": {
        "version": {"$ref": "types/version.json"}
    },
    "required": ["version"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "version": 11223344
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

HTTP status code 426

Version mismatch

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Version mismatch"
    },
    "message": "Version mismatch",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 426
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/quota_exceedance get

Quota exceedance management

get

Get information about exceedance for all quotas

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "virtualhosts": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if virtual hosts quota was exceeded"
        },
        "workstations": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if workstation quota was exceeded"
        },
        "servers": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if servers quota was exceeded"
        },
        "winserveressentials": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if windows server essentials quota was exceeded"
        },
        "vms": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if vms quota was exceeded"
        },
        "mailboxes": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if mailboxes quota was exceeded"
        },
        "websites": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if websites quota was exceeded"
        },
        "universal_devices": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if universal devices quota was exceeded"
        },        
        "mobiles": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if mobiles quota was exceeded"
        }
    },
    "title": "quota_exceedance_get",
    "type": "object",
    "definitions": {
        "flag": {"$ref": "../../../_common/types/flag.json"}
    },
    "required": ["virtualhosts", "workstations", "servers", "winserveressentials", "vms", "mailboxes", "mobiles", "websites", "universal_devices"],
    "description": "/groups/{group}/quota_exceedance/GET response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "virtualhosts": 0,
    "workstations": 1,
    "servers": 0,
    "winserveressentials": 0,
    "vms": 0,
    "mailboxes": 0,
    "mobiles": 0,
    "websites": 0,
    "universal_devices": 0
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/reports/ordered post get

Manage ordered reports for the specified group

post

Order a summary report for the specified group

get

Get saved report

Order a summary report for the specified group

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "description": "/groups/{group}/reports/ordered/POST request",
    "title": "Ordered POST request",
    "type": "object",
    "properties": {
        "kind": {
            "title": "kind",
            "type": "integer",
            "enum": [4, 5],
            "description": "Type of report (4 for daily, 5 for summary)"
        },
        "begin_date": {
            "title": "begin_date",
            "type": "integer",
            "description": "First date of the reported period"
        },
        "level": {
            "title": "level",
            "type": "integer",
            "enum": [0, 1, 2, 3],
            "description": "Report detail level (1|2|3)"
        },
        "when": {
            "title": "when",
            "type": "integer",
            "description": "When report processing will started, specify None for start processing ASAP"
        },
        "result_action": {
            "title": "result_action",
            "type": "string",
            "enum": ["send", "save"],
            "description": "send - report data by email; save - internally"
        },
        "end_date": {
            "title": "end_date",
            "type": "integer",
            "description": "Last date of the reported period"
        },
        "hide_zero_usage": {"$ref": "#/definitions/flag"},
        "show_skus": {"$ref": "#/definitions/flag"}
    },
    "definitions": {
        "flag": {"$ref": "../../../_common/types/flag.json"}
    },
    "additionalProperties": false,
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "kind": 5,
    "begin_date": 1456790400,
    "level": 3,
    "when": 1459468799,
    "result_action": "send",
    "end_date": 1459468799,
    "hide_zero_usage": 0,
    "show_skus": 1
}

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
    "description": "/groups/{group}/reports/ordered/POST response",
    "title": "Ordered POST response",
    "type": "object",
    "properties": {
        "version":  {"$ref": "#/definitions/version"},
        "report_id": {"$ref": "#/definitions/id"},
        "report_uuid": {"$ref": "#/definitions/uuid"}
    },
    "definitions": {
        "version": {
            "$ref": "../../../_common/types/version.json"
        },
        "id": {
            "$ref": "../../../_common/types/id.json"
        },
        "uuid": {
            "$ref": "../../../_common/types/uuid.json"
        }
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "version": 1,
    "report_id": 1,
    "report_uuid": "11936123-4393-4064-2654-201216424569"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 409

Conflict

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Conflict"
    },
    "message": "Conflict",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 409
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Get saved report

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

begin_date: (integer)
First date of the reported period
Example:
```
1469434743
```
end_date: (integer)
Last date of the reported period
Example:
```
1469434743
```
level: (integer)
Report detail level (1|2|3)
Example:
```
3
```
id: (integer)
Id of previously ordered report
Example:
```
3
```
uuid: (string)
UUID of previously ordered report
Example:
```
1F936FFA-AF93-4064-A65E-201216F24EC9
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "description": "/groups/{group}/reports/ordered/GET response",
    "title": "Ordered GET response. Now this response is packed in gzip format",
    "type": "object",
    "properties": {
        "tenants": {
            "title": "tenants",
            "items": {
                "required": [
                    "trial_storage_workstations",
                    "quota_mobiles",
                    "mode",
                    "customer_id",
                    "production_storage_mobiles",
                    "trial_virtualhosts",
                    "trial_vms",
                    "usage_service_users_local_backup_enabled",
                    "production_vms",
                    "group_path",
                    "group_id",
                    "production_storage_virtualhosts",
                    "group_kind",
                    "trial_storage_vms",
                    "trial_win_server_essentials",
                    "group_human_path",
                    "trial_storage_servers",
                    "currency",
                    "trial_servers",
                    "quota_win_server_essentials",
                    "trial_workstations",
                    "production_storage_workstations",
                    "production_servers",
                    "production_win_server_essentials",
                    "storage_name",
                    "trial_mailboxes",
                    "trial_websites",
                    "trial_universal_devices",
                    "cost",
                    "production_storage_mailboxes",
                    "production_storage_websites",
                    "production_storage_universal_devices",
                    "group_parent_id",
                    "group_name",
                    "trial_storage_mobiles",
                    "quota_vms",
                    "trial_storage_virtualhosts",
                    "trial_mobiles",
                    "total_service_users",
                    "quota_mailboxes",
                    "quota_websites",
                    "quota_universal_devices",
                    "total_storage",
                    "quota_workstations",
                    "trial_storage",
                    "production_mailboxes",
                    "production_websites",
                    "production_universal_devices",
                    "production_storage_vms",
                    "price",
                    "quota_storage",
                    "trial_storage_mailboxes",
                    "trial_storage_websites",
                    "trial_storage_universal_devices",
                    "quota_servers",
                    "production_storage",
                    "quota_virtualhosts",
                    "trial_storage_orphaned",
                    "production_mobiles",
                    "production_storage_servers",
                    "production_storage_win_server_essentials",
                    "date",
                    "production_virtualhosts",
                    "usage_service_users_local_backup_disabled",
                    "trial_storage_win_server_essentials",
                    "production_storage_orphaned",
                    "production_workstations",
                    "storage_id"
                ],
                "properties": {
                    "trial_storage_workstations": {
                        "title": "trial_storage_workstations",
                        "type": "integer",
                        "description": "Trial storage workstations amount"
                    },
                    "quota_mobiles": {
                        "title": "quota_mobiles",
                        "type": ["integer", "null"],
                        "description": "Quota for mobile stations"
                    },
                    "mode": {
                        "title": "mode",
                        "type": "integer",
                        "description": "Mode"
                    },
                    "customer_id": {
                        "oneOf": [
                            {"$ref": "#/definitions/id"},
                            {"type": "null"}
                        ]
                    },
                    "production_storage_mobiles": {
                        "title": "production_storage_mobiles",
                        "type": "integer",
                        "description": "Production storage mobiles amount"
                    },
                    "trial_virtualhosts": {
                        "title": "trial_virtualhosts",
                        "type": "integer",
                        "description": "Trial virtualhosts amount"
                    },
                    "trial_vms": {
                        "title": "trial_vms",
                        "type": "integer",
                        "description": "Trial vms amount"
                    },
                    "usage_service_users_local_backup_enabled": {
                        "title": "usage_service_users_local_backup_enabled",
                        "type": "integer",
                        "description": "usage_service_users_local_backup_enabled"
                    },
                    "production_vms": {
                        "title": "production_vms",
                        "type": "integer",
                        "description": "Production vms amount"
                    },
                    "group_path": {
                        "title": "group_path",
                        "type": "string",
                        "description": "Group path"
                    },
                    "group_id": {"$ref": "#/definitions/id"},
                    "production_storage_virtualhosts": {
                        "title": "production_storage_virtualhosts",
                        "type": "integer",
                        "description": "Production storage virtualhosts amount"
                    },
                    "group_kind": {"$ref": "#/definitions/group_kind"},
                    "trial_storage_vms": {
                        "title": "trial_storage_vms",
                        "type": "integer",
                        "description": "Trial storage vms amount"
                    },
                    "trial_win_server_essentials": {
                        "title": "trial_win_server_essentials",
                        "type": "integer",
                        "description": "Trial win server essentials amount"
                    },
                    "group_human_path": {
                        "title": "group_human_path",
                        "type": "string",
                        "description": "Group human readable path"
                    },
                    "trial_storage_servers": {
                        "title": "trial_storage_servers",
                        "type": "integer",
                        "description": "Trial storage servers amount"
                    },
                    "currency": {
                        "title": "currency",
                        "type": ["integer", "null"],
                        "description": "Currency"
                    },
                    "trial_servers": {
                        "title": "trial_servers",
                        "type": "integer",
                        "description": "Trial servers amount"
                    },
                    "quota_win_server_essentials": {
                        "title": "quota_win_server_essentials",
                        "type": ["integer", "null"],
                        "description": "Quota windows server essentials amount"
                    },
                    "trial_workstations": {
                        "title": "trial_workstations",
                        "type": "integer",
                        "description": "Trial workstations amount"
                    },
                    "production_storage_workstations": {
                        "title": "production_storage_workstations",
                        "type": "integer",
                        "description": "Production storage workstations amount"
                    },
                    "production_servers": {
                        "title": "production_servers",
                        "type": "integer",
                        "description": "Production servers amount"
                    },
                    "production_win_server_essentials": {
                        "title": "production_win_server_essentials",
                        "type": "integer",
                        "description": "Production windows server essentials amount"
                    },
                    "storage_name": {
                        "title": "storage_name",
                        "type": ["string", "null"],
                        "description": "Storage name"
                    },
                    "trial_mailboxes": {
                        "title": "trial_mailboxes",
                        "type": "integer",
                        "description": "Trial mailboxes amount"
                    },
                    "trial_websites": {
                        "title": "trial_websites",
                        "type": "integer",
                        "description": "Trial websites amount"
                    },
                    "trial_universal_devices": {
                        "title": "trial_universal_devices",
                        "type": "integer",
                        "description": "Trial universal devices amount"
                    },                    
                    "cost": {
                        "title": "cost",
                        "type": ["integer", "null"],
                        "description": "Cost"
                    },
                    "production_storage_mailboxes": {
                        "title": "production_storage_mailboxes",
                        "type": "integer",
                        "description": "Production storage mailboxes amount"
                    },
                    "production_storage_websites": {
                        "title": "production_storage_websites",
                        "type": "integer",
                        "description": "Production storage websites amount"
                    },
                    "production_storage_universal_devices": {
                        "title": "production_storage_universal_devices",
                        "type": "integer",
                        "description": "Production storage univesal devices amount"
                    },                    
                    "group_parent_id": {"$ref": "#/definitions/id"},
                    "group_name": {
                        "title": "group_name",
                        "type": "string",
                        "description": "Group name"
                    },
                    "trial_storage_mobiles": {
                        "title": "trial_storage_mobiles",
                        "type": "integer",
                        "description": "Trial storage mobiles amount"
                    },
                    "quota_vms": {
                        "title": "quota_vms",
                        "type": ["integer", "null"],
                        "description": "Quota for vms"
                    },
                    "trial_storage_virtualhosts": {
                        "title": "trial_storage_virtualhosts",
                        "type": "integer",
                        "description": "Trial storage virtualhosts amount"
                    },
                    "trial_mobiles": {
                        "title": "trial_mobiles",
                        "type": "integer",
                        "description": "Trial mobile stations amount"
                    },
                    "total_service_users": {
                        "title": "total_service_users",
                        "type": "integer",
                        "description": "Total service users amount"
                    },
                    "quota_mailboxes": {
                        "title": "quota_mailboxes",
                        "type": ["integer", "null"],
                        "description": "Quota for mailboxes"
                    },
                    "quota_websites": {
                        "title": "quota_websites",
                        "type": ["integer", "null"],
                        "description": "Quota for websites"
                    },
                    "quota_universal_devices": {
                        "title": "quota_universal_devices",
                        "type": ["integer", "null"],
                        "description": "Quota for universal devices"
                    },                    
                    "total_storage": {
                        "title": "total_storage",
                        "type": "integer",
                        "description": "Total storage amount"
                    },
                    "quota_workstations": {
                        "title": "quota_workstations",
                        "type": ["integer", "null"],
                        "description": "Quota for workstations"
                    },
                    "trial_storage": {
                        "title": "trial_storage",
                        "type": "integer",
                        "description": "Trial storages amount"
                    },
                    "production_mailboxes": {
                        "title": "production_mailboxes",
                        "type": "integer",
                        "description": "Production mailboxes amount"
                    },
                    "production_websites": {
                        "title": "production_websites",
                        "type": "integer",
                        "description": "Production websites amount"
                    },
                    "production_universal_devices": {
                        "title": "production_universal_devices",
                        "type": "integer",
                        "description": "Production universal devices amount"
                    },                    
                    "production_storage_vms": {
                        "title": "production_storage_vms",
                        "type": "integer",
                        "description": "Production storage vms amount"
                    },
                    "price": {
                        "title": "price",
                        "type": ["integer", "null"],
                        "description": "price"
                    },
                    "quota_storage": {
                        "title": "quota_storage",
                        "type": ["integer", "null"],
                        "description": "Quota for storages"
                    },
                    "trial_storage_mailboxes": {
                        "title": "trial_storage_mailboxes",
                        "type": "integer",
                        "description": "Trial storage mailboxes amount"
                    },
                    "trial_storage_websites": {
                        "title": "trial_storage_websites",
                        "type": "integer",
                        "description": "Trial storage websites amount"
                    },
                    "trial_storage_universal_devices": {
                        "title": "trial_storage_universal_devices",
                        "type": "integer",
                        "description": "Trial storage universal devices amount"
                    },                    
                    "quota_servers": {
                        "title": "quota_servers",
                        "type": ["integer", "null"],
                        "description": "Quota for servers"
                    },
                    "production_storage": {
                        "title": "production_storage",
                        "type": "integer",
                        "description": "Production storages amount"
                    },
                    "quota_virtualhosts": {
                        "title": "quota_virtualhosts",
                        "type": ["integer", "null"],
                        "description": "Quota for virtualhosts"
                    },
                    "trial_storage_orphaned": {
                        "title": "trial_storage_orphaned",
                        "type": "integer",
                        "description": "Trial storage orphaned amount"
                    },
                    "production_mobiles": {
                        "title": "production_mobiles",
                        "type": "integer",
                        "description": "Production mobiles amount"
                    },
                    "production_storage_servers": {
                        "title": "production_storage_servers",
                        "type": "integer",
                        "description": "Production storage servers amount"
                    },
                    "production_storage_win_server_essentials": {
                        "title": "production_storage_win_server_essentials",
                        "type": "integer",
                        "description": "Production storage windows server essentials amount"
                    },
                    "date": {
                        "title": "date",
                        "type": "integer",
                        "description": "Report date"
                    },
                    "production_virtualhosts": {
                        "title": "production_virtualhosts",
                        "type": "integer",
                        "description": "Production virtualhosts amount"
                    },
                    "usage_service_users_local_backup_disabled": {
                        "title": "usage_service_users_local_backup_disabled",
                        "type": "integer",
                        "description": "Usage service users local backup disabled"
                    },
                    "trial_storage_win_server_essentials": {
                        "title": "trial_storage_win_server_essentials",
                        "type": "integer",
                        "description": "Trial storage win server essentials amount"
                    },
                    "production_storage_orphaned": {
                        "title": "production_storage_orphaned",
                        "type": "integer",
                        "description": "Production storage orphaned amount"
                    },
                    "production_workstations": {
                        "title": "production_workstations",
                        "type": "integer",
                        "description": "Production workstations amount"
                    },
                    "storage_id": {
                        "title": "storage_id",
                        "type": "integer",
                        "description": "Storage id"
                    }
                },
                "type": "object"
            },
            "type": "array",
            "description": "Tenants"
        },
        "params": {
            "title": "params",
            "type": "object",
            "properties": {
                "gen_date": {
                    "title": "gen_date",
                    "type": "integer",
                    "description": "Generation date (in seconds)"
                },
                "begin_date": {
                    "title": "begin_date",
                    "type": "integer",
                    "description": "First date of the reported period (in seconds)"
                },
                "group_id": {"$ref": "#/definitions/id"},
                "report_level": {
                    "title": "report_level",
                    "type": "integer",
                    "enum": [1, 2, 3],
                    "description": "report detail level (1|2|3)"
                },
                "name": {
                    "title": "name",
                    "type": "string",
                    "description": "Name of root group in report"
                },
                "end_date": {
                    "title": "end_date",
                    "type": "integer",
                    "description": "First date of the reported period (in seconds)"
                }
            },
            "required": ["gen_date", "begin_date", "group_id", "report_level", "name", "end_date"],
            "description": "Report parameters"
        }
    },
    "required": ["tenants", "params"],
    "definitions": {
        "id": {"$ref": "../../../_common/types/id.json"},
        "group_kind": {"$ref": "../../../_common/types/group_kind.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "tenants": [
        {
            "trial_storage_workstations": 0,
            "quota_mobiles": null,
            "mode": 1,
            "customer_id": null,
            "production_storage_mobiles": 0,
            "trial_virtualhosts": 2732,
            "trial_vms": 2682,
            "usage_service_users_local_backup_enabled": 5247,
            "production_vms": 2457,
            "group_path": "/2/5/",
            "group_id": 5,
            "production_storage_virtualhosts": 0,
            "group_kind": 31,
            "trial_storage_vms": 0,
            "trial_win_server_essentials": 2747,
            "group_human_path": "\\Test1",
            "trial_storage_servers": 0,
            "currency": null,
            "trial_servers": 2791,
            "quota_win_server_essentials": null,
            "trial_workstations": 2806,
            "production_storage_workstations": 0,
            "production_servers": 2464,
            "production_win_server_essentials": 2526,
            "storage_name": null,
            "trial_mailboxes": 2713,
            "trial_websites": 1233,
            "trial_universal_devices": 1212,
            "cost": null,
            "production_storage_mailboxes": 0,
            "production_storage_websites": 0,
            "production_storage_universal_devices": 0,
            "group_parent_id": 2,
            "group_name": "Test1",
            "trial_storage_mobiles": 0,
            "quota_vms": null,
            "trial_storage_virtualhosts": 0,
            "trial_mobiles": 2810,
            "total_service_users": 5247,
            "quota_mailboxes": null,
            "quota_websites": null,
            "quota_universal_devices": null,
            "total_storage": 0,
            "quota_workstations": null,
            "trial_storage": 0,
            "production_mailboxes": 2503,
            "production_websites": 1234,
            "production_universal_devices": 1234,
            "production_storage_vms": 0,
            "price": null,
            "quota_storage": null,
            "trial_storage_mailboxes": 0,
            "trial_storage_websites": 0,
            "trial_storage_universal_devices": 0,
            "quota_servers": null,
            "production_storage": 0,
            "quota_virtualhosts": null,
            "trial_storage_orphaned": 0,
            "production_mobiles": 2482,
            "production_storage_servers": 0,
            "production_storage_win_server_essentials": 0,
            "date": 1469404800,
            "production_virtualhosts": 2460,
            "usage_service_users_local_backup_disabled": 0,
            "trial_storage_win_server_essentials": 0,
            "production_storage_orphaned": 0,
            "production_workstations": 2564,
            "storage_id": -1
        }
    ],
    "params": {
        "gen_date": 1469491200,
        "begin_date": 1469404800,
        "group_id": 5,
        "report_level": 3,
        "name": "Test1",
        "end_date": 1469404800
    }
}

HTTP status code 202

Report was order but processing isn't finished yet. Please retry request later

Body

Media type: application/json

Type: json

Content:

{
    "description": "/groups/{group}/reports/ordered/GET response",
    "title": "Ordered GET response. Now this response is packed in gzip format",
    "type": "object",
    "properties": {
        "tenants": {
            "title": "tenants",
            "items": {
                "required": [
                    "trial_storage_workstations",
                    "quota_mobiles",
                    "mode",
                    "customer_id",
                    "production_storage_mobiles",
                    "trial_virtualhosts",
                    "trial_vms",
                    "usage_service_users_local_backup_enabled",
                    "production_vms",
                    "group_path",
                    "group_id",
                    "production_storage_virtualhosts",
                    "group_kind",
                    "trial_storage_vms",
                    "trial_win_server_essentials",
                    "group_human_path",
                    "trial_storage_servers",
                    "currency",
                    "trial_servers",
                    "quota_win_server_essentials",
                    "trial_workstations",
                    "production_storage_workstations",
                    "production_servers",
                    "production_win_server_essentials",
                    "storage_name",
                    "trial_mailboxes",
                    "trial_websites",
                    "trial_universal_devices",
                    "cost",
                    "production_storage_mailboxes",
                    "production_storage_websites",
                    "production_storage_universal_devices",
                    "group_parent_id",
                    "group_name",
                    "trial_storage_mobiles",
                    "quota_vms",
                    "trial_storage_virtualhosts",
                    "trial_mobiles",
                    "total_service_users",
                    "quota_mailboxes",
                    "quota_websites",
                    "quota_universal_devices",
                    "total_storage",
                    "quota_workstations",
                    "trial_storage",
                    "production_mailboxes",
                    "production_websites",
                    "production_universal_devices",
                    "production_storage_vms",
                    "price",
                    "quota_storage",
                    "trial_storage_mailboxes",
                    "trial_storage_websites",
                    "trial_storage_universal_devices",
                    "quota_servers",
                    "production_storage",
                    "quota_virtualhosts",
                    "trial_storage_orphaned",
                    "production_mobiles",
                    "production_storage_servers",
                    "production_storage_win_server_essentials",
                    "date",
                    "production_virtualhosts",
                    "usage_service_users_local_backup_disabled",
                    "trial_storage_win_server_essentials",
                    "production_storage_orphaned",
                    "production_workstations",
                    "storage_id"
                ],
                "properties": {
                    "trial_storage_workstations": {
                        "title": "trial_storage_workstations",
                        "type": "integer",
                        "description": "Trial storage workstations amount"
                    },
                    "quota_mobiles": {
                        "title": "quota_mobiles",
                        "type": ["integer", "null"],
                        "description": "Quota for mobile stations"
                    },
                    "mode": {
                        "title": "mode",
                        "type": "integer",
                        "description": "Mode"
                    },
                    "customer_id": {
                        "oneOf": [
                            {"$ref": "#/definitions/id"},
                            {"type": "null"}
                        ]
                    },
                    "production_storage_mobiles": {
                        "title": "production_storage_mobiles",
                        "type": "integer",
                        "description": "Production storage mobiles amount"
                    },
                    "trial_virtualhosts": {
                        "title": "trial_virtualhosts",
                        "type": "integer",
                        "description": "Trial virtualhosts amount"
                    },
                    "trial_vms": {
                        "title": "trial_vms",
                        "type": "integer",
                        "description": "Trial vms amount"
                    },
                    "usage_service_users_local_backup_enabled": {
                        "title": "usage_service_users_local_backup_enabled",
                        "type": "integer",
                        "description": "usage_service_users_local_backup_enabled"
                    },
                    "production_vms": {
                        "title": "production_vms",
                        "type": "integer",
                        "description": "Production vms amount"
                    },
                    "group_path": {
                        "title": "group_path",
                        "type": "string",
                        "description": "Group path"
                    },
                    "group_id": {"$ref": "#/definitions/id"},
                    "production_storage_virtualhosts": {
                        "title": "production_storage_virtualhosts",
                        "type": "integer",
                        "description": "Production storage virtualhosts amount"
                    },
                    "group_kind": {"$ref": "#/definitions/group_kind"},
                    "trial_storage_vms": {
                        "title": "trial_storage_vms",
                        "type": "integer",
                        "description": "Trial storage vms amount"
                    },
                    "trial_win_server_essentials": {
                        "title": "trial_win_server_essentials",
                        "type": "integer",
                        "description": "Trial win server essentials amount"
                    },
                    "group_human_path": {
                        "title": "group_human_path",
                        "type": "string",
                        "description": "Group human readable path"
                    },
                    "trial_storage_servers": {
                        "title": "trial_storage_servers",
                        "type": "integer",
                        "description": "Trial storage servers amount"
                    },
                    "currency": {
                        "title": "currency",
                        "type": ["integer", "null"],
                        "description": "Currency"
                    },
                    "trial_servers": {
                        "title": "trial_servers",
                        "type": "integer",
                        "description": "Trial servers amount"
                    },
                    "quota_win_server_essentials": {
                        "title": "quota_win_server_essentials",
                        "type": ["integer", "null"],
                        "description": "Quota windows server essentials amount"
                    },
                    "trial_workstations": {
                        "title": "trial_workstations",
                        "type": "integer",
                        "description": "Trial workstations amount"
                    },
                    "production_storage_workstations": {
                        "title": "production_storage_workstations",
                        "type": "integer",
                        "description": "Production storage workstations amount"
                    },
                    "production_servers": {
                        "title": "production_servers",
                        "type": "integer",
                        "description": "Production servers amount"
                    },
                    "production_win_server_essentials": {
                        "title": "production_win_server_essentials",
                        "type": "integer",
                        "description": "Production windows server essentials amount"
                    },
                    "storage_name": {
                        "title": "storage_name",
                        "type": ["string", "null"],
                        "description": "Storage name"
                    },
                    "trial_mailboxes": {
                        "title": "trial_mailboxes",
                        "type": "integer",
                        "description": "Trial mailboxes amount"
                    },
                    "trial_websites": {
                        "title": "trial_websites",
                        "type": "integer",
                        "description": "Trial websites amount"
                    },
                    "trial_universal_devices": {
                        "title": "trial_universal_devices",
                        "type": "integer",
                        "description": "Trial universal devices amount"
                    },                    
                    "cost": {
                        "title": "cost",
                        "type": ["integer", "null"],
                        "description": "Cost"
                    },
                    "production_storage_mailboxes": {
                        "title": "production_storage_mailboxes",
                        "type": "integer",
                        "description": "Production storage mailboxes amount"
                    },
                    "production_storage_websites": {
                        "title": "production_storage_websites",
                        "type": "integer",
                        "description": "Production storage websites amount"
                    },
                    "production_storage_universal_devices": {
                        "title": "production_storage_universal_devices",
                        "type": "integer",
                        "description": "Production storage univesal devices amount"
                    },                    
                    "group_parent_id": {"$ref": "#/definitions/id"},
                    "group_name": {
                        "title": "group_name",
                        "type": "string",
                        "description": "Group name"
                    },
                    "trial_storage_mobiles": {
                        "title": "trial_storage_mobiles",
                        "type": "integer",
                        "description": "Trial storage mobiles amount"
                    },
                    "quota_vms": {
                        "title": "quota_vms",
                        "type": ["integer", "null"],
                        "description": "Quota for vms"
                    },
                    "trial_storage_virtualhosts": {
                        "title": "trial_storage_virtualhosts",
                        "type": "integer",
                        "description": "Trial storage virtualhosts amount"
                    },
                    "trial_mobiles": {
                        "title": "trial_mobiles",
                        "type": "integer",
                        "description": "Trial mobile stations amount"
                    },
                    "total_service_users": {
                        "title": "total_service_users",
                        "type": "integer",
                        "description": "Total service users amount"
                    },
                    "quota_mailboxes": {
                        "title": "quota_mailboxes",
                        "type": ["integer", "null"],
                        "description": "Quota for mailboxes"
                    },
                    "quota_websites": {
                        "title": "quota_websites",
                        "type": ["integer", "null"],
                        "description": "Quota for websites"
                    },
                    "quota_universal_devices": {
                        "title": "quota_universal_devices",
                        "type": ["integer", "null"],
                        "description": "Quota for universal devices"
                    },                    
                    "total_storage": {
                        "title": "total_storage",
                        "type": "integer",
                        "description": "Total storage amount"
                    },
                    "quota_workstations": {
                        "title": "quota_workstations",
                        "type": ["integer", "null"],
                        "description": "Quota for workstations"
                    },
                    "trial_storage": {
                        "title": "trial_storage",
                        "type": "integer",
                        "description": "Trial storages amount"
                    },
                    "production_mailboxes": {
                        "title": "production_mailboxes",
                        "type": "integer",
                        "description": "Production mailboxes amount"
                    },
                    "production_websites": {
                        "title": "production_websites",
                        "type": "integer",
                        "description": "Production websites amount"
                    },
                    "production_universal_devices": {
                        "title": "production_universal_devices",
                        "type": "integer",
                        "description": "Production universal devices amount"
                    },                    
                    "production_storage_vms": {
                        "title": "production_storage_vms",
                        "type": "integer",
                        "description": "Production storage vms amount"
                    },
                    "price": {
                        "title": "price",
                        "type": ["integer", "null"],
                        "description": "price"
                    },
                    "quota_storage": {
                        "title": "quota_storage",
                        "type": ["integer", "null"],
                        "description": "Quota for storages"
                    },
                    "trial_storage_mailboxes": {
                        "title": "trial_storage_mailboxes",
                        "type": "integer",
                        "description": "Trial storage mailboxes amount"
                    },
                    "trial_storage_websites": {
                        "title": "trial_storage_websites",
                        "type": "integer",
                        "description": "Trial storage websites amount"
                    },
                    "trial_storage_universal_devices": {
                        "title": "trial_storage_universal_devices",
                        "type": "integer",
                        "description": "Trial storage universal devices amount"
                    },                    
                    "quota_servers": {
                        "title": "quota_servers",
                        "type": ["integer", "null"],
                        "description": "Quota for servers"
                    },
                    "production_storage": {
                        "title": "production_storage",
                        "type": "integer",
                        "description": "Production storages amount"
                    },
                    "quota_virtualhosts": {
                        "title": "quota_virtualhosts",
                        "type": ["integer", "null"],
                        "description": "Quota for virtualhosts"
                    },
                    "trial_storage_orphaned": {
                        "title": "trial_storage_orphaned",
                        "type": "integer",
                        "description": "Trial storage orphaned amount"
                    },
                    "production_mobiles": {
                        "title": "production_mobiles",
                        "type": "integer",
                        "description": "Production mobiles amount"
                    },
                    "production_storage_servers": {
                        "title": "production_storage_servers",
                        "type": "integer",
                        "description": "Production storage servers amount"
                    },
                    "production_storage_win_server_essentials": {
                        "title": "production_storage_win_server_essentials",
                        "type": "integer",
                        "description": "Production storage windows server essentials amount"
                    },
                    "date": {
                        "title": "date",
                        "type": "integer",
                        "description": "Report date"
                    },
                    "production_virtualhosts": {
                        "title": "production_virtualhosts",
                        "type": "integer",
                        "description": "Production virtualhosts amount"
                    },
                    "usage_service_users_local_backup_disabled": {
                        "title": "usage_service_users_local_backup_disabled",
                        "type": "integer",
                        "description": "Usage service users local backup disabled"
                    },
                    "trial_storage_win_server_essentials": {
                        "title": "trial_storage_win_server_essentials",
                        "type": "integer",
                        "description": "Trial storage win server essentials amount"
                    },
                    "production_storage_orphaned": {
                        "title": "production_storage_orphaned",
                        "type": "integer",
                        "description": "Production storage orphaned amount"
                    },
                    "production_workstations": {
                        "title": "production_workstations",
                        "type": "integer",
                        "description": "Production workstations amount"
                    },
                    "storage_id": {
                        "title": "storage_id",
                        "type": "integer",
                        "description": "Storage id"
                    }
                },
                "type": "object"
            },
            "type": "array",
            "description": "Tenants"
        },
        "params": {
            "title": "params",
            "type": "object",
            "properties": {
                "gen_date": {
                    "title": "gen_date",
                    "type": "integer",
                    "description": "Generation date (in seconds)"
                },
                "begin_date": {
                    "title": "begin_date",
                    "type": "integer",
                    "description": "First date of the reported period (in seconds)"
                },
                "group_id": {"$ref": "#/definitions/id"},
                "report_level": {
                    "title": "report_level",
                    "type": "integer",
                    "enum": [1, 2, 3],
                    "description": "report detail level (1|2|3)"
                },
                "name": {
                    "title": "name",
                    "type": "string",
                    "description": "Name of root group in report"
                },
                "end_date": {
                    "title": "end_date",
                    "type": "integer",
                    "description": "First date of the reported period (in seconds)"
                }
            },
            "required": ["gen_date", "begin_date", "group_id", "report_level", "name", "end_date"],
            "description": "Report parameters"
        }
    },
    "required": ["tenants", "params"],
    "definitions": {
        "id": {"$ref": "../../../_common/types/id.json"},
        "group_kind": {"$ref": "../../../_common/types/group_kind.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "tenants": [
        {
            "trial_storage_workstations": 0,
            "quota_mobiles": null,
            "mode": 1,
            "customer_id": null,
            "production_storage_mobiles": 0,
            "trial_virtualhosts": 2732,
            "trial_vms": 2682,
            "usage_service_users_local_backup_enabled": 5247,
            "production_vms": 2457,
            "group_path": "/2/5/",
            "group_id": 5,
            "production_storage_virtualhosts": 0,
            "group_kind": 31,
            "trial_storage_vms": 0,
            "trial_win_server_essentials": 2747,
            "group_human_path": "\\Test1",
            "trial_storage_servers": 0,
            "currency": null,
            "trial_servers": 2791,
            "quota_win_server_essentials": null,
            "trial_workstations": 2806,
            "production_storage_workstations": 0,
            "production_servers": 2464,
            "production_win_server_essentials": 2526,
            "storage_name": null,
            "trial_mailboxes": 2713,
            "trial_websites": 1233,
            "trial_universal_devices": 1212,
            "cost": null,
            "production_storage_mailboxes": 0,
            "production_storage_websites": 0,
            "production_storage_universal_devices": 0,
            "group_parent_id": 2,
            "group_name": "Test1",
            "trial_storage_mobiles": 0,
            "quota_vms": null,
            "trial_storage_virtualhosts": 0,
            "trial_mobiles": 2810,
            "total_service_users": 5247,
            "quota_mailboxes": null,
            "quota_websites": null,
            "quota_universal_devices": null,
            "total_storage": 0,
            "quota_workstations": null,
            "trial_storage": 0,
            "production_mailboxes": 2503,
            "production_websites": 1234,
            "production_universal_devices": 1234,
            "production_storage_vms": 0,
            "price": null,
            "quota_storage": null,
            "trial_storage_mailboxes": 0,
            "trial_storage_websites": 0,
            "trial_storage_universal_devices": 0,
            "quota_servers": null,
            "production_storage": 0,
            "quota_virtualhosts": null,
            "trial_storage_orphaned": 0,
            "production_mobiles": 2482,
            "production_storage_servers": 0,
            "production_storage_win_server_essentials": 0,
            "date": 1469404800,
            "production_virtualhosts": 2460,
            "usage_service_users_local_backup_disabled": 0,
            "trial_storage_win_server_essentials": 0,
            "production_storage_orphaned": 0,
            "production_workstations": 2564,
            "storage_id": -1
        }
    ],
    "params": {
        "gen_date": 1469491200,
        "begin_date": 1469404800,
        "group_id": 5,
        "report_level": 3,
        "name": "Test1",
        "end_date": 1469404800
    }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/reports/scheduled put get

Manage scheduled reports for the specified group

put

Update report scheduling settings for the specified group

get

Get report scheduling settings for the specified group

Update report scheduling settings for the specified group

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "description": "/groups/{group}/reports/scheduled/PUT request",
    "title": "scheduled reports PUT request",
    "type": "object",
    "properties": {
        "level": {
            "title": "level",
            "type": "integer",
            "enum": [1, 2, 3],
            "description": "report detail level (1|2|3)"
        },
        "schedule": {
            "title": "schedule",
            "type": "object",
            "properties": {
                "timeshift": {
                    "title": "timeshift",
                    "type": "integer",
                    "description": "Time shift"
                }
            },
            "description": "schedule"
        },
        "enabled": {"$ref": "#/definitions/flag"},
        "hide_zero_usage": {"$ref": "#/definitions/flag"},
        "show_skus": {"$ref": "#/definitions/flag"}
    },
    "definitions": {
        "flag": {"$ref": "../../../_common/types/flag.json"}
    },
    "additionalProperties": false,
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "level": 3,
    "schedule": {
        "timeshift": 0
    },
    "enabled": 1,
    "hide_zero_usage": 1,
    "show_skus": 0
}

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Get report scheduling settings for the specified group

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
    "description": "/groups/{group}/reports/scheduled/GET response",
    "title": "scheduled reports GET response",
    "type": "object",
    "properties": {
        "level": {
            "title": "level",
            "type": "integer",
            "enum": [1, 2, 3],
            "description": "report detail level (1|2|3)"
        },
        "schedule": {
            "title": "schedule",
            "type": "object",
            "properties": {
                "timeshift": {
                    "title": "timeshift",
                    "type": "integer",
                    "description": "Time shift"
                }
            },
            "description": "Schedule"
        },
        "enabled": {"$ref": "#/definitions/flag"},
        "hide_zero_usage": {"$ref": "#/definitions/flag"},
        "show_skus": {"$ref": "#/definitions/flag"}
    },
    "required": ["level", "schedule", "enabled"],
    "definitions": {
        "flag": {"$ref": "../../../_common/types/flag.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "level": 3,
    "schedule": {
        "timeshift": 0
    },
    "enabled": 1,
    "hide_zero_usage": 0,
    "show_skus": 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/settings get

Settings management for group and accounts

get

Fetch settings

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "agents_autoupdate": {
            "properties": {
                "status": {
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if autoupdate is enabled or not"
                }
            },
            "type": "object",
            "title": "agents_autoupdate",
            "description": "agents_autoupdate"
        },
        "logon_ips": {
            "$ref": "#/definitions/logon_ips"
        },
        "local_backup_restriction": {
            "$ref": "#/definitions/local_backup_restriction",
            "required": ["status", "visible"]
        },
        "flags": {
            "$ref": "#/definitions/group_flags",
            "required": ["allow_add_devices", "allow_download_tools", "allow_download_docs", "allow_download_agents"]
        }
    },
    "required": ["flags", "local_backup_restriction", "logon_ips", "agents_autoupdate"],
    "title": "settings_get_response",
    "type": "object",
    "definitions": {
        "group_flags": {"$ref": "group_flags.json"},
        "logon_ips": {"$ref": "../limits/logon_ips_get_response.json"},
        "flag": {"$ref": "../../../_common/types/flag.json"},
        "local_backup_restriction": {"$ref": "local_backup_restriction_get.json"}
    },
    "description": "/groups/{group}/settings/GET response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "agents_autoupdate": {
        "status": 1
    },
    "logon_ips": {
        "status": 1,
        "items": [
            "127.0.0.1"
        ]
    },
    "local_backup_restriction": {
        "status": 1,
        "visible": 1
    },
    "flags": {
        "allow_add_devices": 1,
        "allow_download_tools": 1,
        "allow_download_docs": 1,
        "allow_download_agents": 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/settings/agents_autoupdate get post

Agent AutoUpdate settings management

get

Get AutoUpdate settings

post

Change AutoUpdate settings

Get AutoUpdate settings

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "status": {
            "$ref": "#/definitions/flag",
            "description": "Status"
        }
    },
    "title": "autoupdate_get_response",
    "type": "object",
    "description": "/groups/{group}/agents/autoupdate/GET response",
    "definitions": {
        "flag": {"$ref": "../../../_common/types/flag.json"}
    },
    "required": ["status"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "status": 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Change AutoUpdate settings

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo
```
["root_admin","partner_admin"]
```
roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "apply_for_children": {
            "$ref": "#/definitions/flag",
            "description": "The flag that defines if status is applied to only this group or it`s children too"
        },
        "status": {
            "$ref": "#/definitions/flag",
            "description": "Status"
        }
    },
    "title": "autoupdate_post_request",
    "type": "object",
    "description": "/groups/{group}/agents/autoupdate/POST request",
    "definitions": {
        "flag": {"$ref": "../../../_common/types/flag.json"}
    },
    "additionalProperties": false,
    "required": ["apply_for_children", "status"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "apply_for_children": 0,
    "status": 1
}

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/settings/flags get post

Group`s flags management

get

Get group`s flags

post

Set group`s flags

Get group`s flags

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "allow_add_devices": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if group is allowed to add devices"
        },
        "allow_download_tools": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if group is allowed to download tools"
        },
        "allow_download_docs": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if group is allowed to download docs"
        },
        "allow_download_agents": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if group is allowed to download agent installers"
        }
    },
    "definitions": {
        "flag": {"$ref": "../../../_common/types/flag.json"}
    },
    "required": ["allow_add_devices", "allow_download_tools", "allow_download_docs", "allow_download_agents"],
    "description": "/groups/{group}/settings/flags/GET response",
    "title": "settings_get_flags",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "allow_add_devices": 1,
    "allow_download_tools": 1,
    "allow_download_docs": 1,
    "allow_download_agents": 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Set group`s flags

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{    
    "properties": {
        "allow_add_devices": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if group is allowed to add devices"
        },
        "allow_download_tools": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if group is allowed to download tools"
        },
        "allow_download_docs": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if group is allowed to download docs"
        },
        "allow_download_agents": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if group is allowed to download agent installers"
        }
    },
    "definitions": {
        "flag": {"$ref": "../../../_common/types/flag.json"}
    },
    "description": "/groups/{group}/settings/flags/GET response",
    "title": "settings_post_flags",
    "additionalProperties": false,
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "allow_add_devices": 1,
    "allow_download_tools": 1,
    "allow_download_docs": 1,
    "allow_download_agents": 1
}

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/settings/local_backup_restriction get post

Local Backup Restriction feature management

get

Get local backup restriction settings

post

Change local backup restriction settings

Get local backup restriction settings

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "status": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if local backup is restricted or not"
        },
        "visible": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if the feature is visible or not"
        }
    },
    "title": "settings_local_backup_restriction_get",
    "type": "object",
    "description": "/groups/{group}/settings/local_backup_restriction/GET response",
    "definitions": {
        "flag": {"$ref": "../../../_common/types/flag.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "status": 1,
    "visible": 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Change local backup restriction settings

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "status": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if local backup is restricted or not"
        }
    },
    "title": "local_backup_restriction_post",
    "type": "object",
    "description": "/groups/{group}/settings/local_backup_restriction/POST request",
    "definitions": {
        "flag": {"$ref": "../../../_common/types/flag.json"}
    },
    "required": ["status"],
    "additionalProperties": false,
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "status": 1
}

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/settings/logon_ips delete get post

Logon IPs limitations management

delete

Disable ip limits for group

get

Get ip limits settings

post

set ip limits settings. Supported formats for item:

single IP, ex. 203.0.113.2
IP range, ex. 203.0.113.23 - 203.0.113.200
IP subnetwork, ex. 203.0.113.32/27

Disable ip limits for group

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Get ip limits settings

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "status": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if ip limitation is enabled"
        },
        "items": {
            "type": "array",
            "items": {
                "type": "string",
                "format": "ipv4",
                "title": "item",
                "description": "White listed ip address"
            }
        }
    },
    "title": "logon_ips_get_response",
    "type": "object",
    "required": ["status", "items"],
    "description": "/groups/{group}/limits/logon_ips/GET response",
    "definitions": {
            "flag": {
                "$ref": "../../../_common/types/flag.json"
            }
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "status": 1,
    "items": [
        "127.0.0.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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

set ip limits settings. Supported formats for item:

single IP, ex. 203.0.113.2
IP range, ex. 203.0.113.23 - 203.0.113.200
IP subnetwork, ex. 203.0.113.32/27

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "items": {
            "type": "array",
            "items": {
                "type": "string",
                "title": "item",
                "description": "IP to be added to white list"
            }
        }
    },
    "title": "logon_ips_post_request",
    "type": "object",
    "additionalProperties": false,
    "required": ["items"],
    "description": "/groups/{group}/limits/logon_ips/POST request",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "items": [
        "203.0.113.2",
        "203.0.113.23 - 203.0.113.200"
    ]
}

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/storages get post put

Storages management

get

Get list of all available storages for group

post

put

Update inheritance for storage

Get list of all available storages for group

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "inherited": {
            "type": ["null", "integer"],
            "enum": [null, 0, 1],
            "description": "Flag that defines if inherited storages are represented in this list"
        },
        "items": {
            "type": "array",
            "title": "items",
            "items": {
                "$ref": "#/definitions/storage_info",
                "required": ["id", "datacenter_id", "kind", "active", "name", "inherited", "owner", "content_url", "uid"]
            },
            "description": "Storages list"
        }
    },
    "title": "storages_get_response",
    "type": "object",
    "definitions": {
        "flag": {"$ref": "../../../_common/types/flag.json"},
        "storage_info": {"$ref": "storage_info.json"}
    },
    "required": ["inherited", "items"],
    "description": "/groups/{group}/storages/GET response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "inherited": 1,
    "items": [
        {
            "id": 1,
            "uuid": "fb261178-06bc-4268-9337-9639e049e1c8",
            "name": "Acronis Storage",
            "kind": 1,
            "active": 1,
            "inherited": 1,
            "owner": 1,
            "space_usage": 0,
            "content_mobile_url": "https://storage.files/browse",
            "uid": "4E9ADAA7-55FE-4B34-B6F1-BF451FA8477A",
            "datacenter_id": 1,
            "content_url": "https://storage.files/browse"
        }
    ]
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo
```
["root_admin","partner_admin"]
```
roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "kind": {
            "type": "integer",
            "title": "kind",
            "pattern": "1|2",
            "description": "Storage kind. Might be 1 for Express and 2 for Advanced"
        },
        "name": {
            "type": "string",
            "title": "name",
            "description": "Unique name of a storage"
        },
        "uid": {
            "type": "string",
            "title": "uid",
            "description": "Unique installation id of a storage"
        }
    },
    "title": "storages_post_request",
    "type": "object",
    "additionalProperties": false,
    "required": ["kind", "name", "uid"],
    "description": "/groups/{group}/storages/POST request",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "kind": 1,
    "name": "storage.acronis.com",
    "uid": "4E9ADAA7-55FE-4B34-B6F1-BF451FA8477A"
}

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "url": {
            "type": "string",
            "title": "url",
            "description": "Entry point to sign client certificate and get server certificates"
        }
    },
    "title": "storages_post_response",
    "type": "object",
    "required": ["url"],
    "description": "/groups/{group}/storages/POST response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "url": "https://server.com/storages?access_token=MAcDtEo9KUzhRuHRxfmuUTsqSiAYoaqBZEkWNDsT8FfTNU0hPvTAY2NYHN5qmpZprUSOMcLnXhVT2bGPAGh77JOEgu"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 409

Conflict

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Conflict"
    },
    "message": "Conflict",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 409
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Update inheritance for storage

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo
```
["root_admin","partner_admin"]
```
roles_lib.x-tags
```
["private"]
```

Query Parameters

version: (number)
Client`s version of an object
Example:
```
1
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "inherited": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if storages would be inherited form a parent group"
        }
    },
    "title": "storages_put_request",
    "type": "object",
    "definitions": {
        "flag": {"$ref": "../../../_common/types/flag.json"}
    },
    "description": "/groups/{group}/storages/PUT request",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "inherited": 1
}

HTTP status code 200

Object has been updated

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "version": {"$ref": "#/definitions/version"}
    },
    "title": "version",
    "type": "object",
    "description": "Common version response",
    "definitions": {
        "version": {"$ref": "types/version.json"}
    },
    "required": ["version"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "version": 11223344
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

HTTP status code 426

Version mismatch

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Version mismatch"
    },
    "message": "Version mismatch",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 426
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/storages/{storage} delete get put

Certain storage management

delete

Remove storage

get

Get storage for group

put

Update storage

Remove storage

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)
storage: required(string)

Annotations

AllowedTo
```
["root_admin","partner_admin"]
```
roles_lib.x-tags
```
["private"]
```

Query Parameters

version: (number)
Client`s version of an object
Example:
```
1
```

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 426

Version mismatch

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Version mismatch"
    },
    "message": "Version mismatch",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 426
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Get storage for group

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)
storage: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "id": {"$ref": "#/definitions/id"},
        "uuid": {"ref": "#/definitions/uuid"},
        "name": {
            "type": "string",
            "title": "name",
            "description": "Unique identifier of a storage"
        },
        "kind": {
            "type": "integer",
            "title": "kind",
            "patten": "1|2",
            "description": "Storage kind. Might be 1 for Express and 2 for Advanced"
        },
        "used": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if storage is used or not"
        },
        "content_mobile_url": {
            "type": "string",
            "title": "content_mobile_url",
            "description": "Webrestore Mobile URL"
        },
        "owner": {
            "type": "integer",
            "title": "owner",
            "description": "Owner id"
        },
        "uid": {
            "type": "string",
            "title": "uid",
            "description": "Unique identifier of a storage"
        },
        "content_url": {
            "type": "string",
            "title": "content_url",
            "description": "Web interface to browse files"
        },
        "active": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if storage is active"
        },
        "inherited": {
            "type": ["null", "integer"],
            "enum": [null, 0, 1],
            "description": "Flag that defines if storage is inherited from a parent group"
        },
        "datacenter_id": {"$ref": "#/definitions/id"},
        "space_usage": {
            "type": "integer",
            "title": "content_url",
            "description": "Space utilization on storage"
        }
    },
    "required": ["id", "uuid", "datacenter_id", "kind", "active", "name", "inherited", "owner", "content_url", "uid"],
    "title": "storage_get_response",
    "type": "object",
    "description": "/groups/{group}/storages/{storage}/GET response",
    "definitions": {
        "flag": {"$ref": "../../../../_common/types/flag.json"},
        "id": {"$ref": "../../../../_common/types/id.json"},
        "uuid": {"$ref": "../../../../_common/types/uuid.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "id": 1,
    "uuid": "fb261178-06bc-4268-9337-9639e049e1c8",
    "name": "Acronis Storage",
    "kind": 1,
    "prices": [
        {
            "price": 0.01,
            "version": 1,
            "currency": "USD"
        }
    ],
    "used": 1,
    "content_mobile_url": "https://storage.files/browse",
    "owner": 1,
    "uid": "4E9ADAA7-55FE-4B34-B6F1-BF451FA8477A",
    "content_url": "https://storage.acronis.com/browse",
    "active": 1,
    "inherited": 1,
    "datacenter_id": 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Update storage

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)
storage: required(string)

Annotations

AllowedTo
```
["root_admin","partner_admin"]
```
roles_lib.x-tags
```
["private"]
```

Query Parameters

version: (number)
Client`s version of an object
Example:
```
1
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "name": {
            "type": "string",
            "title": "name",
            "description": "Storage name"
        },
        "content_url": {
            "type": "string",
            "title": "content_url",
            "description": "Web interface to browse files"
        },
        "content_mobile_url": {
            "type": "string",
            "title": "content_mobile_url",
            "description": "Web interface to browse files for mobiles"
        }
    },
    "title": "storage_put_request",
    "type": "object",
    "additionalProperties": false,
    "description": "/groups/{group}/storages/{storage}/PUT request",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "name": "Acronis Storage",
    "content_url": "https://storage.acronis.com/browse"
}

HTTP status code 202

Accepted

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "version": {"$ref": "#/definitions/version"}
    },
    "title": "version",
    "type": "object",
    "description": "Common version response",
    "definitions": {
        "version": {"$ref": "types/version.json"}
    },
    "required": ["version"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "version": 11223344
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 409

Conflict

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Conflict"
    },
    "message": "Conflict",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 409
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

HTTP status code 426

Version mismatch

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Version mismatch"
    },
    "message": "Version mismatch",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 426
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/users get post

Service users management

get

Get list of service users for group

post

Create a new backup account

Get list of service users for group

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

include_hidden: (number)
Include hidden accounts. Default is 0 (hidden accounts are not included in result).
Example:
```
1
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties":{
        "items": {
            "type": "array",
            "description": "List of users",
            "items": [
                {
                    "$ref": "#/definitions/user",
                    "required": ["id", "user_id", "login", "language", "access_type", "roles", "privileged", "status"]
                }
            ]
        }
    },

    "title": "users_get_response",
    "type": "object",
    "description": "/groups/{group}/users/GET response",
    "definitions": {
        "user": {"$ref": "../../../_common/user.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "items": [
        {
            "id": 1,
            "uuid": "fcd6751d-e9fe-4236-872c-7286f6f5cf76",
            "tenant_id": 1,
            "user_id": 1,
            "language": "en",
            "roles": 0,
            "access_type": 1,
            "usage": {
                "server_count": 1,
                "win_server_essential_count": 1,
                "vm_count": 1,
                "storage_size": 1,
                "local_storage_size": 1,
                "virtualhost_count": 1,
                "mailbox_count": 1,
                "website_count": 1,
                "universal_devices_count": 1,
                "workstation_count": 1,
                "mobile_count": 1
            },
            "email": "john.doe@mail.com",
            "firstname": "John",
            "version": 1,
            "lastname": "Doe",
            "login": "john.doe@mail.com",
            "privileges": {
                "server_count": 1,
                "quota_vms_hard": 1,
                "vm_count": 1,
                "quota_mailbox_instance_storage": 1,
                "quota_win_server_essentials_hard": 1,
                "virtualhost_count": 1,
                "workstation_count": 1,
                "quota_workstations_hard": 1,
                "win_server_essential_count": 1,
                "quota_mobiles_hard": 1,
                "quota_virtualhosts_hard": 1,
                "quota_local_storage_hard": 1000,
                "quota_storage_hard": 1000,
                "mailbox_count": 1,
                "website_count": 1,
                "universal_devices_count": 1,
                "storage_size": 1000,
                "local_storage_size": 1000,
                "quota_servers_hard": 1,
                "mobile_count": 1,
                "quota_mailboxes_hard": 1,
                "quota_websites_hard": 1,
                "quota_universal_devices_hard": 1
            },
            "status": 1,
            "backup": {
                "monitor": 1
            },
            "privileged": 0
        }
    ]
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Create a new backup account

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "allOf": [
        {"$ref": "#/definitions/contact"},
        {
            "properties": {
                "language": {
                    "type": "string",
                    "title": "language",
                    "description": "Preferred account language"
                },
                "privileged": {
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if user is privileged"
                },
                "roles": {"$ref": "#/definitions/admin_role"},
                "login": {
                    "type": "string",
                    "title": "login",
                    "description": "Backup account`s login"
                },
                "use_existing_identity": {
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if existing identity would be used to create new account"
                },
                "privileges": {"$ref": "#/definitions/quotas_and_privileges_local_backup_is_integer"},
                "notifications_management": {
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if backup management subscription is enabled"
                },
                "agents": {
                    "properties": {
                        "autoupdate": {
                            "$ref": "#/definitions/flag",
                            "description": "Flag that defines if autoupdate is enabled"
                        }
                    },
                    "type": "object",
                    "title": "agents",
                    "description": "agents"
                },
                "backup": {
                    "properties": {
                        "monitor": {
                            "$ref": "#/definitions/flag",
                            "description": "Flag that defines if backup tray monitor is disabled"
                        }
                    },
                    "type": "object",
                    "title": "backup",
                    "description": "Backup monitoring information"
                },
                "notifications_backup": {"$ref": "#/definitions/notifications_backup"},
                "notifications_device_control": {"$ref": "#/definitions/notifications_device_control"},
                "notifications_certificate_management": {"$ref": "#/definitions/notifications_certificate_management"},
                "idp_id": {
                    "$ref": "#/definitions/id",
                    "description": "External Identity Provider for user"
                },
                "idp_uuid": {
                    "$ref": "#/definitions/uuid",
                    "description": "External Identity Provider for user"
                }
            }
        }
    ],
    "definitions": {
        "contact": {"$ref": "../../../_common/contact.json"},
        "id": {"$ref": "../../../_common/types/id.json"},
        "uuid": {"$ref": "../../../_common/types/uuid.json"},
        "access_type": {"$ref": "../../../_common/types/access_type.json"},
        "admin_role": {"$ref": "../../../_common/types/admin_role.json"},
        "flag": {"$ref": "../../../_common/types/flag.json"},
        "notifications_backup": {"$ref": "../../../_common/types/notifications_backup.json"},
        "notifications_device_control": {"$ref": "../../../_common/types/notifications_device_control.json"},
        "notifications_certificate_management": {"$ref": "../../../_common/types/notifications_certificate_management.json"},
        "version": {"$ref": "../../../_common/types/version.json"},
        "quotas_and_privileges_local_backup_is_integer": {"$ref": "../../../_common/quotas_and_privileges_local_backup_is_integer.json"}
    },
    "title": "users_post_request",
    "type": "object",
    "description": "/groups/{group}/users/POST request",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "language": "en",
    "city": "Nowhere",
    "privileged": 1,
    "country": "USA",
    "roles": 1,
    "login": "john.doe",
    "email": "john.doe@mail.com",
    "zipcode": "11111-1111",
    "firstname": "John",
    "use_existing_identity": 1,
    "state": "US",
    "lastname": "Doe",
    "phone": "+1(1111)-1111-1111",
    "address1": "555 Main Street",
    "privileges": {
        "server_count": 1,
        "quota_vms_hard": 1,
        "vm_count": 1,
        "quota_mailbox_instance_storage": 1,
        "quota_win_server_essentials_hard": 1,
        "virtualhost_count": 1,
        "workstation_count": 1,
        "local_backup": 1,
        "quota_workstations_hard": 1,
        "win_server_essential_count": 1,
        "quota_mobiles_hard": 1,
        "quota_virtualhosts_hard": 1,
        "quota_storage_hard": 1111,
        "quota_local_storage_hard": 1111,
        "mailbox_count": 1,
        "website_count": 1,
        "universal_devices_count": 1,
        "storage_size": 1111,
        "local_storage_size": 1111,
        "quota_servers_hard": 1,
        "mobile_count": 1,
        "quota_mailboxes_hard": 1,
        "quota_websites_hard": 1,
        "quota_universal_devices_hard": 1
    },
    "notifications_management": 1,
    "agents": {
        "autoupdate": 1
    },
    "address2": "Apt. 5A",
    "backup": {
        "monitor": 1
    },
    "notifications_backup": 3,
    "notifications_device_control": 1,
    "notifications_certificate_management": 7
}

HTTP status code 201

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "version": {"$ref": "#/definitions/version"},
        "id": {"$ref": "#/definitions/id"},
        "uuid": {"$ref": "#/definitions/uuid"}
    },
    "title": "version_id_uuid",
    "type": "object",
    "description": "Common version, id and uuid response",
    "definitions": {
        "version": {"$ref": "types/version.json"},
        "id": {"$ref": "types/id.json"},
        "uuid": {"$ref": "types/uuid.json"}
    },
    "required": ["version", "id", "uuid"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "version": 1,
    "id": 1,
    "uuid": "ec8ca020-0a5f-11e7-9bd1-e31e3bef811e"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 409

Conflict

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Conflict"
    },
    "message": "Conflict",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 409
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/groups/{group}/watchers get

Miscellaneous groups api

get

Get group watchers

Secured by session

Secured by basicAuth

URI Parameters

group: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

event_mask: required(integer)
Event level mask value from Constants.Notification.ServiceType.* (Backup Error 1, Backup Warning 2, Backup Info 4, Daily Report 8)
Example:
```
1
```
service_kind: required(integer)
Service kind id value from Constants.AdminNotification.* (Management 1, Backup 2)
Example:
```
1
```
levels_up: (integer)
Limit number of higher levels watchers. Deprecated parameter, could be useful with value 0 for backup accounts for daily recap messages.
Example:
```
0
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "title": "get_watchers",
    "type": "array",
    "description": "/groups/{group}/watchers/GET response",
    "items": [
        {
            "properties": {
                "language": {
                    "type": "string",
                    "title": "language",
                    "description": "Language"
                },
                "subject_firstname": {
                    "type": "string",
                    "title": "subject_firstname",
                    "description": "Subject firstname"
                },
                "subject_email": {"$ref": "#/definitions/email"},
                "subject_lastname": {
                    "type": "string",
                    "title": "subject_lastname",
                    "description": "Subject lastname"
                },
                "brand_id": {"$ref": "#/definitions/id"},
                "subject_login": {
                    "type": ["string", "null"],
                    "title": "subject_login",
                    "description": "Subject login"
                },
                "recipient": {
                    "type": "string",
                    "title": "recipient",
                    "description": "Recipient email"
                },
                "subject_hierarchy_name": {
                    "type": "string",
                    "title": "subject_hierarchy_name",
                    "description": "Subject hierarchy string"
                },
                "sender": {"$ref": "#/definitions/email"}
            },
            "type": "object"
        }
    ],
    "definitions": {
        "email": {"$ref": "../../../_common/types/email.json"},
        "id": {"$ref": "../../../_common/types/id.json"}
    },
    "required": ["sender", "recipient", "brand_id", "language", "subject_login", "subject_firstname", "subject_lastname", "subject_hierarchy_name", "subject_email"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

[
    {
        "language": "en-us",
        "subject_firstname": "Firstname",
        "subject_email": "subject@mail.com",
        "subject_lastname": "Lastname",
        "brand_id": 1,
        "subject_login": "username",
        "recipient": "recipient@mail.com",
        "subject_hierarchy_name": "GroupName/SubgroupName",
        "sender": "sender@mail.com"
    }
]

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/idp

/idp get

get

Get information about identity provider

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

id: (integer)
IdP integer id
Example:
```
1
```
uuid: (string)
IdP uuid
Example:
```
11111111-1111-1111-1111-111111111111
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "changePasswordUrl": {
            "type": ["string", "null"],
            "title": "changePasswordUrl",
            "description": "Change password URL"
        },
        "forgotPasswordUrl": {
            "type": ["string", "null"],
            "title": "forgotPasswordUrl",
            "description": "Forgot Password URL"
        },
        "resetPasswordUrl": {
            "type": ["string", "null"],
            "title": "resetPasswordUrl",
            "description": "Reset Password URL (for administrators)"
        },
        "domain": {
            "type": "string",
            "title": "domain",
            "description": "Domain"
        }
    },
    "title": "idp_get_response",
    "required": ["changePasswordUrl", "forgotPasswordUrl", "domain"],
    "type": "object",
    "description": "/idp/GET response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "changePasswordUrl": "http://test-idp-1/change-password",
    "forgotPasswordUrl": "http://test-idp-1/forgot-password",
    "domain": "test-idp-1"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 426

Version mismatch

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Version mismatch"
    },
    "message": "Version mismatch",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 426
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/logic

Logical values management

/logic/constants get

Manage logic constants

get

Retrieve constants for admins

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "Reports": {
            "properties": {
                "Kind": {
                    "properties": {
                        "UsageDaily": {
                            "type": "integer",
                            "title": "UsageDaily",
                            "description": "UsageDaily"
                        },
                        "UsageSummary": {
                            "type": "integer",
                            "title": "UsageSummary",
                            "description": "UsageSummary"
                        }
                    },
                    "type": "object",
                    "title": "Kind",
                    "description": "Kind"
                },
                "UsageReportLevel": {
                    "properties": {
                        "DirectPartners": {
                            "type": "integer",
                            "title": "DirectPartners",
                            "description": "DirectPartners"
                        },
                        "AllCustomers": {
                            "type": "integer",
                            "title": "AllCustomers",
                            "description": "AllCustomers"
                        },
                        "ItSelf": {
                            "type": "integer",
                            "title": "ItSelf",
                            "description": "ItSelf"
                        },
                        "Accounts": {
                            "type": "integer",
                            "title": "Accounts",
                            "description": "Accounts"
                        }
                    },
                    "type": "object",
                    "title": "UsageReportLevel",
                    "description": "UsageReportLevel"
                }
            },
            "type": "object",
            "title": "Reports",
            "description": "Reports"
        },
        "AccessTypes": {
            "properties": {
                "FullAccess": {
                    "type": "integer",
                    "title": "FullAccess",
                    "description": "FullAccess"
                },
                "ChangeBrandingAccess": {
                    "type": "integer",
                    "title": "ChangeBrandingAccess",
                    "description": "ChangeBrandingAccess"
                },
                "MigrationAccess": {
                    "type": "integer",
                    "title": "MigrationAccess",
                    "description": "MigrationAccess"
                },
                "ReadWriteAccess": {
                    "type": "integer",
                    "title": "ReadWriteAccess",
                    "description": "ReadWriteAccess"
                },
                "ReadAccess": {
                    "type": "integer",
                    "title": "ReadAccess",
                    "description": "ReadAccess"
                },
                "ExternalWriteAccess": {
                    "type": "integer",
                    "title": "ExternalWriteAccess",
                    "description": "ExternalWriteAccess"
                }
            },
            "type": "object",
            "title": "AccessTypes",
            "description": "AccessTypes"
        },
        "Pricing": {
            "properties": {
                "Status": {
                    "properties": {
                        "Demo": {
                            "type": "integer",
                            "title": "Demo",
                            "description": "Demo"
                        },
                        "DemoPersistent": {
                            "type": "integer",
                            "title": "DemoPersistent",
                            "description": "DemoPersistent"
                        },
                        "Production": {
                            "type": "integer",
                            "title": "Production",
                            "description": "Production"
                        }
                    },
                    "type": "object",
                    "title": "Status",
                    "description": "Status"
                }
            },
            "type": "object",
            "title": "Pricing",
            "description": "Pricing"
        },
        "AlarmsKind": {
            "properties": {
                "SoftwareUpdate": {
                    "type": "integer",
                    "title": "SoftwareUpdate",
                    "description": "SoftwareUpdate"
                }
            },
            "type": "object",
            "title": "AlarmsKind",
            "description": "AlarmsKind"
        },
        "Service": {
            "properties": {
                "Type": {
                    "properties": {
                        "Backup": {
                            "type": "integer",
                            "title": "Backup",
                            "description": "Backup"
                        },
                        "Access": {
                            "type": "integer",
                            "title": "Access",
                            "description": "Access"
                        },
                        "DR": {
                            "type": "integer",
                            "title": "DR",
                            "description": "DR"
                        }
                    },
                    "type": "object",
                    "title": "Type",
                    "description": "Type"
                }
            },
            "type": "object",
            "title": "Service",
            "description": "Service"
        },
        "CertificateAuthorities": {
            "properties": {
                "Services": {
                    "type": "integer",
                    "title": "Services",
                    "description": "Services"
                }
            },
            "type": "object",
            "title": "CertificateAuthorities",
            "description": "CertificateAuthorities"
        },
        "GroupsCapability": {
            "properties": {
                "Modification": {
                    "type": "integer",
                    "title": "Modification",
                    "description": "Modification"
                },
                "Children": {
                    "type": "integer",
                    "title": "Children",
                    "description": "Children"
                },
                "Isolation": {
                    "type": "integer",
                    "title": "Isolation",
                    "description": "Isolation"
                },
                "RequireCustomerId": {
                    "type": "integer",
                    "title": "RequireCustomerId",
                    "description": "RequireCustomerId"
                },
                "Backup": {
                    "type": "integer",
                    "title": "Backup",
                    "description": "Backup"
                },
                "CustomPricing": {
                    "type": "integer",
                    "title": "CustomPricing",
                    "description": "CustomPricing"
                },
                "CustomStorage": {
                    "type": "integer",
                    "title": "CustomStorage",
                    "description": "CustomStorage"
                },
                "Branding": {
                    "type": "integer",
                    "title": "Branding",
                    "description": "Branding"
                },
                "CustomPrice": {
                    "type": "integer",
                    "title": "CustomPrice",
                    "description": "CustomPrice"
                }
            },
            "type": "object",
            "title": "GroupsCapability",
            "description": "GroupsCapability"
        },
        "Notification": {
            "properties": {
                "Backup": {
                    "properties": {
                        "Warning": {
                            "type": "integer",
                            "title": "Warning",
                            "description": "Warning"
                        },
                        "Error": {
                            "type": "integer",
                            "title": "Error",
                            "description": "Error"
                        },
                        "Info": {
                            "type": "integer",
                            "title": "Info",
                            "description": "Info"
                        },
                        "DailyReport": {
                            "type": "integer",
                            "title": "Info",
                            "description": "Info"
                        },
                        "Critical": {
                            "type": "integer",
                            "title": "Critical",
                            "description": "Critical"
                        }
                    },
                    "type": "object",
                    "title": "Backup",
                    "description": "Backup"
                }
            },
            "type": "object",
            "title": "Notification",
            "description": "Notification"
        },
        "Status": {
            "properties": {
                "Inactive": {
                    "type": "integer",
                    "title": "Inactive",
                    "description": "Inactive"
                },
                "Disabled": {
                    "type": "integer",
                    "title": "Disabled",
                    "description": "Disabled"
                },
                "Enabled": {
                    "type": "integer",
                    "title": "Enabled",
                    "description": "Enabled"
                }
            },
            "type": "object",
            "title": "Status",
            "description": "Status"
        },
        "StorageKind": {
            "properties": {
                "Express": {
                    "type": "integer",
                    "title": "Express",
                    "description": "Express"
                },
                "Advanced": {
                    "type": "integer",
                    "title": "Advanced",
                    "description": "Advanced"
                }
            },
            "type": "object",
            "title": "StorageKind",
            "description": "StorageKind"
        },
        "Rating": {
            "properties": {
                "Basic": {
                    "type": "integer",
                    "title": "Basic",
                    "description": "Basic"
                },
                "Bronze": {
                    "type": "integer",
                    "title": "Bronze",
                    "description": "Bronze"
                },
                "Silver": {
                    "type": "integer",
                    "title": "Silver",
                    "description": "Silver"
                },
                "Platinum": {
                    "type": "integer",
                    "title": "Platinum",
                    "description": "Platinum"
                },
                "Gold": {
                    "type": "integer",
                    "title": "Gold",
                    "description": "Gold"
                }
            },
            "type": "object",
            "title": "Rating",
            "description": "Rating"
        },
        "GroupsQuota": {
            "properties": {
                "Unlimited": {
                    "type": "integer",
                    "title": "Unlimited",
                    "description": "Unlimited"
                }
            },
            "type": "object",
            "title": "GroupsQuota",
            "description": "GroupsQuota"
        },
        "Roles": {
            "properties": {
                "Buyer": {
                    "type": "integer",
                    "title": "Buyer",
                    "description": "Buyer"
                }
            },
            "type": "object",
            "title": "Roles",
            "description": "Roles"
        },
        "GroupsKind": {
            "properties": {
                "Reseller": {
                    "type": "integer",
                    "title": "Reseller",
                    "description": "Reseller"
                },
                "Distributor": {
                    "type": "integer",
                    "title": "Distributor",
                    "description": "Distributor"
                },
                "EndUserCompany": {
                    "type": "integer",
                    "title": "EndUserCompany",
                    "description": "EndUserCompany"
                },
                "CompanyDepartment": {
                    "type": "integer",
                    "title": "CompanyDepartment",
                    "description": "CompanyDepartment"
                },
                "SubDistributor": {
                    "type": "integer",
                    "title": "SubDistributor",
                    "description": "SubDistributor"
                },
                "Provider": {
                    "type": "integer",
                    "title": "Provider",
                    "description": "Provider"
                },
                "ServiceUser": {
                    "type": "integer",
                    "title": "ServiceUser",
                    "description": "ServiceUser"
                },
                "MSP": {
                    "type": "integer",
                    "title": "MSP",
                    "description": "MSP"
                },
                "Root": {
                    "type": "integer",
                    "title": "Root",
                    "description": "Root"
                }
            },
            "type": "object",
            "title": "GroupsKind",
            "description": "GroupsKind"
        }
    },
    "title": "logicconstantsGETresponse",
    "type": "object",
    "description": "/logic/constants/GET response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "Reports": {
        "Kind": {
            "UsageDaily": 4,
            "UsageSummary": 5
        },
        "UsageReportLevel": {
            "DirectPartners": 1,
            "AllCustomers": 2,
            "ItSelf": 0,
            "Accounts": 3
        }
    },
    "AccessTypes": {
        "FullAccess": 15,
        "ChangeBrandingAccess": 2,
        "MigrationAccess": 16,
        "ReadWriteAccess": 5,
        "ReadAccess": 1,
        "ExternalWriteAccess": 9
    },
    "Pricing": {
        "Status": {
            "Demo": 2,
            "DemoPersistent": 3,
            "Production": 1
        }
    },
    "AlarmsKind": {
        "SoftwareUpdate": 1
    },
    "Service": {
        "Type": {
            "Backup": 1,
            "Access": 3,
            "DR": 2
        }
    },
    "CertificateAuthorities": {
        "Services": 1
    },
    "GroupsCapability": {
        "Modification": 16,
        "Children": 4,
        "Isolation": 8,
        "RequireCustomerId": 128,
        "Backup": 1,
        "CustomPricing": 32,
        "CustomStorage": 256,
        "Branding": 2,
        "CustomPrice": 64
    },
    "Notification": {
        "Backup": {
            "Warning": 2,
            "Error": 1,
            "Info": 4,
            "DailyReport": 8,
            "Critical": 16
        },
        "DeviceControl": {
            "Warning": 1
        },
        "CertificateManagement": {
            "Error": 1,
            "Warning": 2,
            "Info": 4
        }
    },
    "Status": {
        "Inactive": -1,
        "Disabled": 0,
        "Enabled": 1
    },
    "StorageKind": {
        "Express": 1,
        "Advanced": 2
    },
    "Rating": {
        "Basic": 5,
        "Bronze": 4,
        "Silver": 3,
        "Platinum": 1,
        "Gold": 2
    },
    "GroupsQuota": {
        "Unlimited": -1
    },
    "Roles": {
        "Buyer": 1
    },
    "GroupsKind": {
        "Reseller": 31,
        "Distributor": 10,
        "EndUserCompany": 40,
        "CompanyDepartment": 50,
        "SubDistributor": 20,
        "Provider": 21,
        "ServiceUser": -1,
        "MSP": 30,
        "Root": 0
    }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/logic/languages get

Get supported languages

get

Get supported languages

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "title": "logiclanguagesGETresponse",
    "type": "array",
    "description": "/logic/languages/GET response",
    "items": [
        {
            "properties": {
                "code": {
                    "type": "string",
                    "title": "code",
                    "description": "ISO code of language"
                }
            },
            "type": "object"
        }
    ],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

[
    {
        "code": "en"
    }
]

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/logic/languages/ui get

Get supported languages

get

Join client languages with supported languages

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "title": "logiclanguagesuiGETresponse",
    "type": "array",
    "description": "/logic/languages/ui/GET response",
    "items": [
        {
            "type": "string",
            "title": "item",
            "description": "language code"
        }
    ],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

[
    "en-US"
]

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/logic/rules get

Groups constants

get

Retrieve rules for groups, GroupBusinessRules[str(group_kind)][str(group_grade)], see /logic/constants.GroupsKind for details

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "HidePricingRules": {
            "type": "array",
            "title": "HidePricingRules",
            "items": {
                "type": "integer"
            },
            "description": "HidePricingRules"
        },
        "GroupBusinessRules": {
            "properties": {
                "creation": {
                    "properties": {
                        "21": {
                            "properties": {
                                "any": {
                                    "type": "array",
                                    "title": "any",
                                    "items": {
                                        "type": "integer"
                                    },
                                    "description": "any"
                                }
                            },
                            "type": "object",
                            "title": "21",
                            "description": "21"
                        },
                        "20": {
                            "properties": {
                                "any": {
                                    "type": "array",
                                    "title": "any",
                                    "items": {
                                        "type": "integer"
                                    },
                                    "description": "any"
                                }
                            },
                            "type": "object",
                            "title": "20",
                            "description": "20"
                        },
                        "0": {
                            "properties": {
                                "any": {
                                    "type": "array",
                                    "title": "any",
                                    "items": {
                                        "type": "integer"
                                    },
                                    "description": "any"
                                },
                                "0": {
                                    "type": "array",
                                    "title": "0",
                                    "items": {
                                        "type": "integer"
                                    },
                                    "description": "0"
                                }
                            },
                            "type": "object",
                            "title": "0",
                            "description": "0"
                        },
                        "30": {
                            "properties": {
                                "any": {
                                    "type": "array",
                                    "title": "any",
                                    "items": {
                                        "type": "integer"
                                    },
                                    "description": "any"
                                }
                            },
                            "type": "object",
                            "title": "30",
                            "description": "30"
                        },
                        "40": {
                            "properties": {
                                "any": {
                                    "type": "array",
                                    "title": "any",
                                    "items": {
                                        "type": "integer"
                                    },
                                    "description": "any"
                                }
                            },
                            "type": "object",
                            "title": "40",
                            "description": "40"
                        },
                        "31": {
                            "properties": {
                                "any": {
                                    "type": "array",
                                    "title": "any",
                                    "items": {
                                        "type": "integer"
                                    },
                                    "description": "any"
                                }
                            },
                            "type": "object",
                            "title": "31",
                            "description": "31"
                        },
                        "10": {
                            "properties": {
                                "any": {
                                    "type": "array",
                                    "title": "any",
                                    "items": {
                                        "type": "integer"
                                    },
                                    "description": "any"
                                }
                            },
                            "type": "object",
                            "title": "10",
                            "description": "10"
                        },
                        "50": {
                            "properties": {
                                "any": {
                                    "type": "array",
                                    "title": "any",
                                    "items": {
                                        "type": "integer"
                                    },
                                    "description": "any"
                                }
                            },
                            "type": "object",
                            "title": "50",
                            "description": "50"
                        }
                    },
                    "type": "object",
                    "title": "creation",
                    "description": "creation"
                },
                "modification": {
                    "properties": {
                        "30": {
                            "properties": {
                                "1": {
                                    "type": "array",
                                    "title": "1",
                                    "items": {
                                        "type": "integer"
                                    },
                                    "description": "1"
                                },
                                "3": {
                                    "type": "array",
                                    "title": "3",
                                    "items": {
                                        "type": "integer"
                                    },
                                    "description": "3"
                                },
                                "2": {
                                    "type": "array",
                                    "title": "2",
                                    "items": {
                                        "type": "integer"
                                    },
                                    "description": "2"
                                }
                            },
                            "type": "object",
                            "title": "30",
                            "description": "30"
                        }
                    },
                    "type": "object",
                    "title": "modification",
                    "description": "modification"
                }
            },
            "type": "object",
            "title": "GroupBusinessRules",
            "description": "GroupBusinessRules"
        },
        "PricingDefaultModes": {
            "type": "array",
            "title": "PricingDefaultModes",
            "items": {
                "properties": {
                    "mode": {
                        "type": "integer",
                        "title": "mode",
                        "description": "mode"
                    },
                    "parent_group_kind": {
                        "type": ["integer", "null"],
                        "title": "parent_group_kind",
                        "description": "parent_group_kind"
                    },
                    "group_kind": {
                        "type": ["integer", "null"],
                        "title": "group_kind",
                        "description": "group_kind"
                    }
                },
                "type": "object"
            },
            "description": "items"
        },
        "GroupEnablePricingRules": {
            "type": "array",
            "title": "GroupEnablePricingRules",
            "items": {
                "properties": {
                    "parent_group_kind": {
                        "type": ["integer", "null"],
                        "title": "parent_group_kind",
                        "description": "parent_group_kind"
                    },
                    "group_kind": {
                        "type": ["integer", "null"],
                        "title": "group_kind",
                        "description": "group_kind"
                    }
                },
                "type": "object"
            },
            "description": "items"
        },
        "PricingGroupModeRules": {
            "type": "array",
            "title": "PricingGroupModeRules",
            "items": {
                "properties": {
                    "group_kind": {
                        "type": ["integer", "null"],
                        "title": "group_kind",
                        "description": "group_kind"
                    },
                    "parent_group_kind": {
                        "type": ["integer", "null"],
                        "title": "parent_group_kind",
                        "description": "parent_group_kind"
                    },
                    "to_mode": {
                        "type": "integer",
                        "title": "to_mode",
                        "description": "to_mode"
                    },
                    "from_mode": {
                        "type": ["integer", "null"],
                        "title": "from_mode",
                        "description": "from_mode"
                    }
                },
                "type": "object"
            },
            "description": "items"
        }
    },
    "title": "logicrulesGETresponse",
    "type": "object",
    "description": "/logic/rules/GET response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "HidePricingRules": [
        50
    ],
    "GroupBusinessRules": {
        "creation": {
            "21": {
                "any": [
                    31
                ]
            },
            "20": {
                "any": [
                    30,
                    40
                ]
            },
            "0": {
                "any": [
                    10,
                    20,
                    30,
                    21,
                    40
                ],
                "0": [
                    0,
                    10,
                    20,
                    30,
                    40
                ]
            },
            "30": {
                "any": [
                    40
                ]
            },
            "40": {
                "any": [
                    50,
                    -1
                ]
            },
            "31": {
                "any": [
                    31,
                    40
                ]
            },
            "10": {
                "any": [
                    20,
                    30,
                    40
                ]
            },
            "50": {
                "any": [
                    50,
                    -1
                ]
            }
        },
        "modification": {
            "30": {
                "1": [
                    10,
                    20
                ],
                "3": [
                    20
                ],
                "2": [
                    10,
                    20
                ]
            }
        }
    },
    "PricingDefaultModes": [
        {
            "mode": 2,
            "parent_group_kind": null,
            "group_kind": 40
        }
    ],
    "GroupEnablePricingRules": [
        {
            "parent_group_kind": 0,
            "group_kind": null
        }
    ],
    "PricingGroupModeRules": [
        {
            "group_kind": null,
            "parent_group_kind": null,
            "to_mode": 1,
            "from_mode": null
        }
    ]
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/logic/versions get

Get components versions

get

returns components versions

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "database": {
            "type": "string",
            "description": "version of account-database module"
        },
        "api": {
            "type": "string",
            "description": "version of account-server module"
        }
    },
    "title": "logicversionsGETresponse",
    "type": "object",
    "description": "/logic/versions/GET response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "database": "2.1.100",
    "api": "1.0.230"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/login get post

get

post

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

jwt: (string)
Jwt login token
Example:
```
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
   "properties":{
      "access_type":{"$ref": "#/definitions/access_type"},
      "allow_moving_groups":{
          "$ref": "#/definitions/flag",
          "title": "allow_moving_groups",
          "description": "Flag that defines if current user is allowed to move groups"
      },
      "brand":{"$ref": "#/definitions/id"},
      "email":{"$ref": "#/definitions/email"},
      "firstname":{
         "title":"firstname",
         "type":"string",
         "description": "User`s firstname"
      },
      "group":{
         "properties":{
            "customer_type":{ "$ref": "#/definitions/customer_type" },
            "id":{"$ref": "#/definitions/id"},
            "uuid": {
               "$ref": "#/definitions/uuid",
               "description": "Group unique identifier"
            },
            "kind":{ "$ref": "#/definitions/group_kind" },
            "language":{
               "type":"string",
               "description": "Group default language"
            },
            "name":{
               "type":"string",
               "description": "Group name"
            }
         },
         "type":"object"
      },
      "id":{"$ref": "#/definitions/id"},
      "account_group_id":{"$ref": "#/definitions/id"},
      "integration_active":{
          "$ref": "#/definitions/flag",
          "description": "Flag that defines if current user is managed by an external system"
      },
      "language":{
         "title":"language",
         "type":"string",
         "description": "Default language"
      },
      "lastname":{
         "type":"string",
         "description": "User`s lastname"
      },
      "links":{
         "properties":{
            "astorage_doc":{
               "title":"astorage_doc",
               "type":"string",
               "description": "Acronis Storage documentation link"
            },
            "astorage_gateway_guide":{
               "title":"astorage_gateway_guide",
               "type":"string",
               "description": "Acronis Storage Gateway documentation link"
            },
            "astorage_guide":{
               "title":"astorage_guide",
               "type":"string",
               "description": "Acronis Storage quick start guide link"
            },
            "astorage_iso":{
               "title":"astorage_iso",
               "type":"string",
               "description": "Acronis Storage ISO link"
            },
            "video_tutorial":{
               "title":"video_tutorial",
               "type":"string",
               "description": "Video tutorial link"
            },
            "hci_guide":{
               "title":"hci_guide",
               "type":"string",
               "description": "HCI quick start guide link"
            },
            "hci_iso":{
               "title":"hci_iso",
               "type":"string",
               "description": "HCI ISO link"
            }
         },
         "type":"object"
      },
      "login":{
         "title":"login",
         "type":"string",
         "description": "User`s login"
      },
      "privileged":{
          "$ref": "#/definitions/flag",
          "description": "Flag that defines if current user is privileged or not"
      },
      "roles":{"$ref": "#/definitions/admin_role"},
      "services":{
         "items":{
            "properties":{
               "id":{
                  "$ref": "#/definitions/id",
                  "description": "Service identifier"
               },
               "uuid": {
                  "$ref": "#/definitions/uuid",
                  "description": "Service global identifier"
               },
               "name":{
                  "type":"string",
                  "description": "Service name"
               },
               "type":{
                  "type":"string",
                  "description": "Service type"
               },
               "entry_point":{
                  "type":"string",
                  "description": "Service entry point URL"
               }
            },
            "type":"object"
         },
         "type":[
            "array",
            "null"
         ]
      },
      "smtp_brand":{
         "title":"smtp_brand",
         "type":"number",
         "description": "User SMTP brand"
      },
      "terms_accepted":{
          "$ref": "#/definitions/flag",
          "description": "Flag that defines if this user has accepted EULA"
      },
      "platform_terms_accepted":{
          "$ref": "#/definitions/flag",
          "description": "Flag that defines if this user has accepted Platform Terms"
      },
      "privacy_policy_accepted":{
          "$ref": "#/definitions/flag",
          "description": "Flag that defines if this user has accepted Privacy Policy"
      },
      "uuid": {
          "title": "uuid",
          "$ref": "#/definitions/uuid",
          "description": "unique identifier"
      },
      "user_id":{"$ref": "#/definitions/id"},
      "mfa_status": {
        "type": "string",
        "description": "Multi-factor authentication status for user: 'disabled', 'forcibly_disabled', 'setup_required', 'enabled'"
      },
      "session_mfa_status": {
        "type": "string",
        "description": "Multi-factor authentication status for the current user's session: 'passed_or_not_required', 'passed_as_trusted', 'required'"
      },
      "version":{"$ref": "#/definitions/version"}
   },
   "type":"object",
   "definitions": {
     "email": {"$ref": "../_common/types/email.json"},
     "flag": {"$ref": "../_common/types/flag.json"},
     "customer_type": {"$ref": "../_common/types/customer_type.json"},
     "group_kind": {"$ref": "../_common/types/group_kind.json"},
     "version": {"$ref": "../_common/types/version.json"},
     "access_type": {"$ref": "../_common/types/access_type.json"},
     "admin_role": {"$ref": "../_common/types/admin_role.json"},
     "id": {"$ref": "../_common/types/id.json"},
     "uuid": {"$ref": "../_common/types/uuid.json"}
   }
}

Example:

{
    "access_type": 1,
    "allow_moving_groups": 0,
    "brand": 11223344,
    "firstname": "Example",
    "account_group_id": 12,
    "group": {
        "customer_type": 0,
        "id": 11223344,
        "uid": "1ca5bc46-0b18-4ed6-a341-6c42bda6d95e",
        "kind": 40,
        "language": "en",
        "name": "Some Group"
    },
    "id": 11223344,
    "integration_active": 0,
    "language": "en",
    "lastname": "Example",
    "links": {
        "astorage_doc": "https://example.com/astorage_doc.html",
        "astorage_gateway_guide": "https://example.com/astorage_gateway_guide.html",
        "astorage_guide": "http://download.acronis.com/storage2/pdf/AcronisStorage_2_quick_start_guide_en-US.pdf",
        "astorage_iso": "https://example.com/astorage_iso.html",
        "hci_guide": "https://download.acronis.com/storage2/pdf/AcronisStorage_2_quick_start_guide_en-US.pdf",
        "hci_iso": "https://example.com/astorage_iso.html",
        "video_tutorial": "https://example.com/video_tutorial.html"
    },
    "login": "example",
    "privileged": 0,
    "roles": 1,
    "services": [
        {
            "id": 11223344,
            "uuid": "807e0908-6768-48b3-93f5-fb04d93dea96",
            "name": "Example",
            "type": "backup",
            "entry_point": "/app/"
        }
    ],
    "smtp_brand": 11223344,
    "terms_accepted": 1,
    "platform_terms_accepted": 1,
    "privacy_policy_accepted": 1,
    "user_id": 11223344,
    "mfa_status": "enabled",
    "session_mfa_status": "not_required",
    "uuid": "42cd423b-0a40-40f2-9a55-ef8427d48842",
    "version": 1
}

HTTP status code 302

Found

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Found"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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 has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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 503

If response consists header 'Retry-After' with value N, then user locked on N seconds, else user locked. Attention! This is a placeholder for a code 423! Due to RAML specification restrictions, this code can not be used.

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "username": {
            "type": "string",
            "title": "username",
            "description": "User credentials(login)"
        },
        "user_id": {"$ref": "#/definitions/id"},
        "password": {
            "type": "string",
            "title": "password",
            "description": "User credentials(password)"
        }
    },
    "title": "post_request",
    "type": "object",
    "description": "/login/POST request",
    "definitions": {
        "id": {"$ref": "../_common/types/id.json"}
    },
    "additionalProperties": false,
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "username": "john.doe@mail.com",
    "user_id": 1,
    "password": "********"
}

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "title": "post_response",
    "type": "object",
    "description": "/login/POST response",
    "$schema": "http://json-schema.org/draft-04/schema",
    "definitions": {
        "profile":{"$ref": "profile.json"}
    },
    "properties":{
        "message":{
            "type": "string",
            "description": "Response message"
        },
        "client_ip":{
            "type": "string",
            "description": "Client ip",
            "format": "ipv4"
        },
        "accounts":{
            "type":"array",
            "items":{
                "$ref": "#/definitions/profile"
            }
        }
    }
}

Example:

{
    "message": "Example",
    "client_ip": "123.123.123.123",
    "accounts": [
        {
            "access_type": 1,
            "allow_moving_groups": 0,
            "brand": 11223344,
            "firstname": "Example",
            "group": {
                "customer_type": 0,
                "id": 11223344,
                "uid": "1ca5bc46-0b18-4ed6-a341-6c42bda6d95e",
                "kind": 40,
                "language": "en",
                "name": "Some Group"
            },
            "id": 11223344,
            "integration_active": 0,
            "language": "en",
            "lastname": "Example",
            "links": {
                "astorage_doc": "https://example.com/astorage_doc.html",
                "astorage_gateway_guide": "https://example.com/astorage_gateway_guide.html",
                "astorage_guide": "http://download.acronis.com/storage2/pdf/AcronisStorage_2_quick_start_guide_en-US.pdf",
                "astorage_iso": "https://example.com/astorage_iso.html",
                "hci_guide": "https://download.acronis.com/storage2/pdf/AcronisStorage_2_quick_start_guide_en-US.pdf",
                "hci_iso": "https://example.com/astorage_iso.html",
                "video_tutorial": "https://example.com/video_tutorial.html"
            },
            "login": "example",
            "privileged": 0,
            "roles": 1,
            "services": [
                {
                    "id": 11223344,
                    "uuid": "807e0908-6768-48b3-93f5-fb04d93dea96",
                    "name": "Example",
                    "type": "backup",
                    "entry_point": "/app/"
                }
            ],
            "smtp_brand": 11223344,
            "terms_accepted": 1,
            "platform_terms_accepted": 1,
            "privacy_policy_accepted": 1,
            "user_id": 11223344,
            "version": 1
        }
    ]
}

HTTP status code 302

Found

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Found"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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

Access from given IP is not allowed

Body

Media type: application/json

Type: json

Content:

{
    "title": "post_response_403",
    "type": "object",
    "description": "/login/POST 403 response",
    "$schema": "http://json-schema.org/draft-04/schema",
    "properties":{
        "message":{
            "type": "string",
            "description": "Response message"
        },
        "client_ip":{
            "type": "string",
            "description": "Client ip",
            "format": "ipv4"
        }
    }
}

Example:

{
    "client_ip": "7.7.7.7",
    "message": "Access from your IP is not allowed"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"
    }
  }
}

HTTP status code 423

Lets try

HTTP status code 503

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/logout

Logout from the system

/logout get post

get

Logout from the system

post

Logout from the system

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

HTTP status code 302

Found

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Found"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Logout from the system

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/profile

Show information about current user

/profile get

get

Show information about current user

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
   "properties":{
      "access_type":{"$ref": "#/definitions/access_type"},
      "allow_moving_groups":{
          "$ref": "#/definitions/flag",
          "title": "allow_moving_groups",
          "description": "Flag that defines if current user is allowed to move groups"
      },
      "brand":{"$ref": "#/definitions/id"},
      "email":{"$ref": "#/definitions/email"},
      "firstname":{
         "title":"firstname",
         "type":"string",
         "description": "User`s firstname"
      },
      "group":{
         "properties":{
            "customer_type":{ "$ref": "#/definitions/customer_type" },
            "id":{"$ref": "#/definitions/id"},
            "uuid": {
               "$ref": "#/definitions/uuid",
               "description": "Group unique identifier"
            },
            "kind":{ "$ref": "#/definitions/group_kind" },
            "language":{
               "type":"string",
               "description": "Group default language"
            },
            "name":{
               "type":"string",
               "description": "Group name"
            }
         },
         "type":"object"
      },
      "id":{"$ref": "#/definitions/id"},
      "account_group_id":{"$ref": "#/definitions/id"},
      "integration_active":{
          "$ref": "#/definitions/flag",
          "description": "Flag that defines if current user is managed by an external system"
      },
      "language":{
         "title":"language",
         "type":"string",
         "description": "Default language"
      },
      "lastname":{
         "type":"string",
         "description": "User`s lastname"
      },
      "links":{
         "properties":{
            "astorage_doc":{
               "title":"astorage_doc",
               "type":"string",
               "description": "Acronis Storage documentation link"
            },
            "astorage_gateway_guide":{
               "title":"astorage_gateway_guide",
               "type":"string",
               "description": "Acronis Storage Gateway documentation link"
            },
            "astorage_guide":{
               "title":"astorage_guide",
               "type":"string",
               "description": "Acronis Storage quick start guide link"
            },
            "astorage_iso":{
               "title":"astorage_iso",
               "type":"string",
               "description": "Acronis Storage ISO link"
            },
            "video_tutorial":{
               "title":"video_tutorial",
               "type":"string",
               "description": "Video tutorial link"
            },
            "hci_guide":{
               "title":"hci_guide",
               "type":"string",
               "description": "HCI quick start guide link"
            },
            "hci_iso":{
               "title":"hci_iso",
               "type":"string",
               "description": "HCI ISO link"
            }
         },
         "type":"object"
      },
      "login":{
         "title":"login",
         "type":"string",
         "description": "User`s login"
      },
      "privileged":{
          "$ref": "#/definitions/flag",
          "description": "Flag that defines if current user is privileged or not"
      },
      "roles":{"$ref": "#/definitions/admin_role"},
      "services":{
         "items":{
            "properties":{
               "id":{
                  "$ref": "#/definitions/id",
                  "description": "Service identifier"
               },
               "uuid": {
                  "$ref": "#/definitions/uuid",
                  "description": "Service global identifier"
               },
               "name":{
                  "type":"string",
                  "description": "Service name"
               },
               "type":{
                  "type":"string",
                  "description": "Service type"
               },
               "entry_point":{
                  "type":"string",
                  "description": "Service entry point URL"
               }
            },
            "type":"object"
         },
         "type":[
            "array",
            "null"
         ]
      },
      "smtp_brand":{
         "title":"smtp_brand",
         "type":"number",
         "description": "User SMTP brand"
      },
      "terms_accepted":{
          "$ref": "#/definitions/flag",
          "description": "Flag that defines if this user has accepted EULA"
      },
      "platform_terms_accepted":{
          "$ref": "#/definitions/flag",
          "description": "Flag that defines if this user has accepted Platform Terms"
      },
      "privacy_policy_accepted":{
          "$ref": "#/definitions/flag",
          "description": "Flag that defines if this user has accepted Privacy Policy"
      },
      "uuid": {
          "title": "uuid",
          "$ref": "#/definitions/uuid",
          "description": "unique identifier"
      },
      "user_id":{"$ref": "#/definitions/id"},
      "mfa_status": {
        "type": "string",
        "description": "Multi-factor authentication status for user: 'disabled', 'forcibly_disabled', 'setup_required', 'enabled'"
      },
      "session_mfa_status": {
        "type": "string",
        "description": "Multi-factor authentication status for the current user's session: 'passed_or_not_required', 'passed_as_trusted', 'required'"
      },
      "version":{"$ref": "#/definitions/version"}
   },
   "type":"object",
   "definitions": {
     "email": {"$ref": "../_common/types/email.json"},
     "flag": {"$ref": "../_common/types/flag.json"},
     "customer_type": {"$ref": "../_common/types/customer_type.json"},
     "group_kind": {"$ref": "../_common/types/group_kind.json"},
     "version": {"$ref": "../_common/types/version.json"},
     "access_type": {"$ref": "../_common/types/access_type.json"},
     "admin_role": {"$ref": "../_common/types/admin_role.json"},
     "id": {"$ref": "../_common/types/id.json"},
     "uuid": {"$ref": "../_common/types/uuid.json"}
   }
}

Example:

{
    "access_type": 1,
    "allow_moving_groups": 0,
    "brand": 11223344,
    "firstname": "Example",
    "account_group_id": 12,
    "group": {
        "customer_type": 0,
        "id": 11223344,
        "uid": "1ca5bc46-0b18-4ed6-a341-6c42bda6d95e",
        "kind": 40,
        "language": "en",
        "name": "Some Group"
    },
    "id": 11223344,
    "integration_active": 0,
    "language": "en",
    "lastname": "Example",
    "links": {
        "astorage_doc": "https://example.com/astorage_doc.html",
        "astorage_gateway_guide": "https://example.com/astorage_gateway_guide.html",
        "astorage_guide": "http://download.acronis.com/storage2/pdf/AcronisStorage_2_quick_start_guide_en-US.pdf",
        "astorage_iso": "https://example.com/astorage_iso.html",
        "hci_guide": "https://download.acronis.com/storage2/pdf/AcronisStorage_2_quick_start_guide_en-US.pdf",
        "hci_iso": "https://example.com/astorage_iso.html",
        "video_tutorial": "https://example.com/video_tutorial.html"
    },
    "login": "example",
    "privileged": 0,
    "roles": 1,
    "services": [
        {
            "id": 11223344,
            "uuid": "807e0908-6768-48b3-93f5-fb04d93dea96",
            "name": "Example",
            "type": "backup",
            "entry_point": "/app/"
        }
    ],
    "smtp_brand": 11223344,
    "terms_accepted": 1,
    "platform_terms_accepted": 1,
    "privacy_policy_accepted": 1,
    "user_id": 11223344,
    "mfa_status": "enabled",
    "session_mfa_status": "not_required",
    "uuid": "42cd423b-0a40-40f2-9a55-ef8427d48842",
    "version": 1
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/profiles

Show information about all accounts associated with currently logged in identity

/profiles get

get

Show information about all accounts associated with currently logged in identity

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "$schema": "http://json-schema.org/draft-04/schema",
    "definitions": {
        "profile":{"$ref": "profile.json"}
    },
    "type":"array",
    "items":{
        "$ref": "#/definitions/profile"
    }
}

Example:

[
    {
        "access_type": 1,
        "allow_moving_groups": 0,
        "brand": 11223344,
        "firstname": "Example",
        "account_group_id": 12,
        "group": {
            "customer_type": 0,
            "id": 11223344,
            "uid": "1ca5bc46-0b18-4ed6-a341-6c42bda6d95e",
            "kind": 40,
            "language": "en",
            "name": "Some Group"
        },
        "id": 11223344,
        "integration_active": 0,
        "language": "en",
        "lastname": "Example",
        "links": {
            "astorage_doc": "https://example.com/astorage_doc.html",
            "astorage_gateway_guide": "https://example.com/astorage_gateway_guide.html",
            "astorage_guide": "http://download.acronis.com/storage2/pdf/AcronisStorage_2_quick_start_guide_en-US.pdf",
            "astorage_iso": "https://example.com/astorage_iso.html",
            "hci_guide": "https://download.acronis.com/storage2/pdf/AcronisStorage_2_quick_start_guide_en-US.pdf",
            "hci_iso": "https://example.com/astorage_iso.html",
            "video_tutorial": "https://example.com/video_tutorial.html"
        },
        "login": "example",
        "privileged": 0,
        "roles": 1,
        "services": [
            {
                "id": 11223344,
                "uuid": "807e0908-6768-48b3-93f5-fb04d93dea96",
                "name": "Example",
                "type": "backup",
                "entry_point": "/app/"
            }
        ],
        "smtp_brand": 11223344,
        "terms_accepted": 1,
        "platform_terms_accepted": 1,
        "privacy_policy_accepted": 1,
        "user_id": 11223344,
        "uuid": "42cd423b-0a40-40f2-9a55-ef8427d48842",
        "version": 1
    }
]

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/reports

Usage reports management

/reports post get

post

Create a new report

get

Get list of reports

Create a new report

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "description": "/reports/POST request",
    "title": "Reports POST request",
    "type": "object",
    "properties": {
        "level": {
            "title": "level",
            "type": "integer",
            "enum": [0, 1, 2, 3],
            "description": "report detail level (0|1|2|3)"
        },
        "schedule": {
            "title": "schedule",
            "type": "object",
            "properties": {
                "timeshift": {
                    "title": "timeshift",
                    "type": "integer",
                    "description": "Time shift"
                }
            },
            "required": ["timeshift"],
            "description": "schedule"
        },
        "enabled": {"$ref": "#/definitions/flag"}
    },
    "required": ["level", "schedule", "enabled"],
    "definitions": {
        "flag": {"$ref": "../_common/types/flag.json"}
    },
    "additionalProperties": false,
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "level": 3,
    "schedule": {
        "timeshift": 0
    },
    "enabled": 1
}

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "version": {"$ref": "#/definitions/version"},
        "id": {"$ref": "#/definitions/id"}
    },
    "title": "version_and_id",
    "type": "object",
    "description": "Common version and id response",
    "definitions": {
        "version": {"$ref": "types/version.json"},
        "id": {"$ref": "types/id.json"}
    },
    "required": ["version", "id"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "version": 1,
    "id": 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Get list of reports

Secured by session

Secured by basicAuth

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "description": "/reports/GET response",
    "title": "Reports GET response",
    "items": [
        {
            "type": "object",
            "properties": {
                "level": {
                    "title": "level",
                    "type": "integer",
                    "enum": [0, 1, 2, 3],
                    "description": "report detail level (0|1|2|3)"
                },
                "enabled": {"$ref": "#/definitions/flag"},
                "id": {"$ref": "#/definitions/id"}
            },
            "required": ["level", "enabled", "id"]
        }
    ],
    "type": "array",
    "definitions": {
        "flag": {"$ref": "../_common/types/flag.json"},
        "id": {"$ref": "../_common/types/id.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

[
    {
        "level": 3,
        "enabled": 1,
        "id": 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/reports/{report} delete put get

Certain report management

delete

Remove report

put

Modify properties of specific report

get

Get information about specific report

Remove report

Secured by session

Secured by basicAuth

URI Parameters

report: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

version: (number)
Client`s version of an object
Example:
```
1
```

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 426

Version mismatch

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Version mismatch"
    },
    "message": "Version mismatch",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 426
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Modify properties of specific report

Secured by session

Secured by basicAuth

URI Parameters

report: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

version: (number)
Client`s version of an object
Example:
```
1
```

Body

Media type: application/json

Type: json

Content:

{
    "description": "/reports/{report}/PUT request",
    "title": "Certain report PUT request",
    "type": "object",
    "properties": {
        "level": {
            "title": "level",
            "type": "integer",
            "enum": [0, 1, 2, 3],
            "description": "Report detail level (0|1|2|3)"
        },
        "schedule": {
            "title": "schedule",
            "type": "object",
            "properties": {
                "timeshift": {
                    "title": "timeshift",
                    "type": "integer",
                    "description": "Time shift"
                }
            },
            "description": "schedule"
        },
        "enabled": {"$ref": "#/definitions/flag"}
    },
    "additionalProperties": false,
    "$schema": "http://json-schema.org/draft-04/schema",
    "definitions": {
        "flag": {"$ref": "../../_common/types/flag.json"}
    }
}

Example:

{
    "level": 3,
    "schedule": {
        "timeshift": 0
    },
    "enabled": 1
}

HTTP status code 200

Object has been updated

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "version": {"$ref": "#/definitions/version"}
    },
    "title": "version",
    "type": "object",
    "description": "Common version response",
    "definitions": {
        "version": {"$ref": "types/version.json"}
    },
    "required": ["version"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "version": 11223344
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

HTTP status code 426

Version mismatch

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Version mismatch"
    },
    "message": "Version mismatch",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 426
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Get information about specific report

Secured by session

Secured by basicAuth

URI Parameters

report: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Body

Media type: application/json

Type: json

Content:

{
    "description": "/reports/{report}/GET response",
    "title": "Certain report GET response",
    "type": "object",
    "properties": {
        "version": {"$ref": "#/definitions/version"},
        "level": {
            "title": "level",
            "type": "integer",
            "enum": [0, 1, 2, 3],
            "description": "Report detail level (0|1|2|3)"
        },
        "schedule": {
            "title": "schedule",
            "type": "object",
            "properties": {
                "timeshift": {
                    "title": "timeshift",
                    "type": "integer",
                    "description": "Time shift"
                }
            },
            "required": ["timeshift"],
            "description": "schedule"
        },
        "enabled": {"$ref": "#/definitions/flag"},
        "id": {"$ref": "#/definitions/id"}
    },
    "definitions": {
        "version": {"$ref": "../../_common/types/version.json"},
        "flag": {"$ref": "../../_common/types/flag.json"},
        "id": {"$ref": "../../_common/types/id.json"}
    },
    "required": ["enabled", "id", "schedule", "level", "version"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "version": 1,
    "level": 3,
    "schedule": {
        "timeshift": 0
    },
    "enabled": 1,
    "id": 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/reports/{report}/adhoc post

Send ad hock report

post

Send ad hock report

Secured by session

Secured by basicAuth

URI Parameters

report: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "description": "/reports/{report}/adhoc/POST request",
    "title": "adhock reports POST request",
    "type": "object",
    "properties": {
        "begin_date": {
            "title": "begin_date",
            "type": "integer",
            "description": "begin date"
        },
        "end_date": {
            "title": "end_date",
            "type": "integer",
            "description": "end date"
        }
    },
    "required": ["begin_date", "end_date"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "begin_date": 1,
    "end_date": 2
}

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/reports/{report}/send post

Schedule sending of report

post

Send report

Secured by session

Secured by basicAuth

URI Parameters

report: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/users

/users/{user} delete get put

Service user management

delete

Remove service user

get

Get detailed information on the service user

put

Update service user properties

Remove service user

Secured by session

Secured by basicAuth

URI Parameters

user: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

version: (number)
Client`s version of an object
Example:
```
1
```

HTTP status code 204

No content

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"No Content"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 426

Version mismatch

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Version mismatch"
    },
    "message": "Version mismatch",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 426
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Get detailed information on the service user

Secured by session

Secured by basicAuth

URI Parameters

user: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties":{
        "id": {"$ref": "#/definitions/id"},
        "uuid": {"$ref": "#/definitions/uuid"},
        "tenant_id": {"$ref": "#/definitions/id"},
        "user_id": {"$ref": "#/definitions/id"},
        "access_type": {"$ref": "#/definitions/access_type"},
        "language": {
            "type": "string",
            "title": "language",
            "description": "Account language"
        },
        "roles":  {"$ref": "#/definitions/admin_role"},
        "usage": {"$ref": "#/definitions/usage"},
        "email": {"$ref": "#/definitions/email"},
        "firstname": {
            "type": "string",
            "title": "firstname",
            "description": "Backup account`s first-name"
        },
        "version": {"$ref": "#/definitions/version"},
        "lastname": {
            "type": "string",
            "title": "lastname",
            "description": "Backup account`s last-name"
        },
        "login": {
            "type": "string",
            "title": "login",
            "description": "Backup account`s login"
        },
        "privileges": {"$ref": "#/definitions/quotas_and_privileges_local_backup_is_integer"},
        "status": {
            "$ref": "#/definitions/account_status"
        },
        "backup": {
            "properties": {
                "monitor": {
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if backup tray monitor is disabled"
                }
            },
            "type": "object",
            "title": "backup",
            "description": "Backup monitoring information"
        },
        "privileged": {
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if user is privileged"
        },
        "idp_id": {
            "$ref": "#/definitions/id",
            "description": "User's Identity Provider"
        },
        "idp_uuid": {
            "$ref": "#/definitions/uuid",
            "description": "User's Identity Provider"
        },
        "address1": {
            "type": "string",
            "title": "address1",
            "description": "Address line 1"
        },
        "address2": {
            "type": "string",
            "title": "address2",
            "description": "Address line 2"
        },
        "city": {
            "type": "string",
            "title": "city",
            "description": "City"
        },
        "state": {
            "type": "string",
            "title": "state",
            "description": "State"
        },
        "country": {
            "type": "string",
            "title": "country",
            "description": "Country"
        },
        "phone": {
            "type": "string",
            "title": "phone",
            "description": "Phone number"
        },
        "terms_accepted": {
            "$ref": "#/definitions/flag",
            "description": "User accepted terms and conditions"
        },
        "platform_terms_accepted":{
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if this user has accepted Platform Terms"
        },
        "privacy_policy_accepted":{
            "$ref": "#/definitions/flag",
            "description": "Flag that defines if this user has accepted Privacy Policy"
        },
        "zipcode": {
            "type": "string",
            "title": "zipcode",
            "description": "Zipcode"
        },
        "agents": {
            "properties": {
                "autoupdate": {
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if autoupdate is enable"
                }
            },
            "type": "object",
            "title": "agents",
            "description": "agents"
        }
    },

    "required": [
        "id",
        "uuid",
        "user_id",
        "access_type",
        "language",
        "roles",
        "usage",
        "email",
        "firstname",
        "version",
        "lastname",
        "login",
        "privileges",
        "status",
        "backup",
        "privileged",
        "address1",
        "address2",
        "city",
        "state",
        "country",
        "phone",
        "terms_accepted",
        "platform_terms_accepted",
        "privacy_policy_accepted",
        "zipcode",
        "agents"
    ],

    "title": "user_get_response",
    "type": "object",
    "description": "/users/{user}/GET response",
    "definitions": {
        "account_status": {"$ref": "../_common/types/account_status.json"},
        "flag": {"$ref": "../_common/types/flag.json"},
        "id": {"$ref": "../_common/types/id.json"},
        "uuid": {"$ref": "../_common/types/uuid.json"},
        "version": {"$ref": "../_common/types/version.json"},
        "admin_role": {"$ref": "../_common/types/admin_role.json"},
        "email": {"$ref": "../_common/types/email.json"},
        "usage": {"$ref": "../_common/usage.json"},
        "quotas_and_privileges_local_backup_is_integer":
        {"$ref": "../_common/quotas_and_privileges_local_backup_is_integer.json"},
        "access_type": {"$ref": "../_common/types/access_type.json"}
    },
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "id": 1,
    "uuid": "fcd6751d-e9fe-4236-872c-7286f6f5cf76",
    "tenant_id": 1,
    "user_id": 1,
    "language": "en",
    "roles": 0,
    "access_type": 1,
    "usage": {
        "server_count": 1,
        "win_server_essential_count": 1,
        "vm_count": 1,
        "storage_size": 1,
        "local_storage_size": 1,
        "virtualhost_count": 1,
        "mailbox_count": 1,
        "website_count": 1,
        "universal_devices_count": 0,
        "workstation_count": 1,
        "mobile_count": 1
    },
    "email": "john.doe@mail.com",
    "firstname": "John",
    "version": 1,
    "lastname": "Doe",
    "login": "john.doe@mail.com",
    "privileges": {
        "server_count": 1,
        "quota_vms_hard": 1,
        "vm_count": 1,
        "quota_mailbox_instance_storage": 1,
        "quota_win_server_essentials_hard": 1,
        "virtualhost_count": 1,
        "workstation_count": 1,
        "local_backup": 1,
        "quota_workstations_hard": 1,
        "win_server_essential_count": 1,
        "quota_mobiles_hard": 1,
        "quota_virtualhosts_hard": 1,
        "quota_storage_hard": 1000,
        "quota_local_storage_hard": 1000,
        "mailbox_count": 1,
        "website_count": 1,
        "universal_devices_count": 1,
        "storage_size": 1000,
        "local_storage_size": 1000,
        "quota_servers_hard": 1,
        "mobile_count": 1,
        "quota_mailboxes_hard": 1,
        "quota_websites_hard": 1,
        "quota_universal_devices_hard": 1
    },
    "status": 1,
    "backup": {
        "monitor": 1
    },
    "privileged": 0,
    "address1": "My address string",
    "address2": "address string continuation",
    "city": "Default city",
    "state": "TX",
    "country": "Brobdingnag",
    "phone": "+1-111-111111",
    "terms_accepted": 0,
    "platform_terms_accepted": 0,
    "privacy_policy_accepted": 0,
    "zipcode": "123456",
    "agents": {
        "autoupdate": 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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Update service user properties

Secured by session

Secured by basicAuth

URI Parameters

user: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

version: (number)
Client`s version of an object
Example:
```
1
```

Body

Media type: application/json

Type: json

Content:

{
    "allOf": [
        {"$ref": "#/definitions/contact"},
        {
            "properties": {
                "language": {
                    "type": "string",
                    "title": "language",
                    "description": "Preferred account language"
                },
                "privileged": {
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if user is privileged"
                },
                "roles": {"$ref": "#/definitions/admin_role"},
                "login": {
                    "type": "string",
                    "title": "login",
                    "description": "Backup account`s login"
                },
                "use_existing_identity": {
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if existing identity would be used to create new account"
                },
                "privileges": {"$ref": "#/definitions/quotas_and_privileges_local_backup_is_integer"},
                "notifications_management": {
                    "$ref": "#/definitions/flag",
                    "description": "Flag that defines if backup management subscription is enabled"
                },
                "agents": {
                    "properties": {
                        "autoupdate": {
                            "$ref": "#/definitions/flag",
                            "description": "Flag that defines if autoupdate is enabled"
                        }
                    },
                    "type": "object",
                    "title": "agents",
                    "description": "agents"
                },
                "backup": {
                    "properties": {
                        "monitor": {
                            "$ref": "#/definitions/flag",
                            "description": "Flag that defines if backup tray monitor is disabled"
                        }
                    },
                    "type": "object",
                    "title": "backup",
                    "description": "Backup monitoring information"
                },
                "notifications_backup": {"$ref": "#/definitions/notifications_backup"},
                "notifications_device_control": {"$ref": "#/definitions/notifications_device_control"},
                "notifications_certificate_management": {"$ref": "#/definitions/notifications_certificate_management"},
                "idp_id": {
                    "$ref": "#/definitions/id",
                    "description": "External Identity Provider for user"
                },
                "idp_uuid": {
                    "$ref": "#/definitions/uuid",
                    "description": "External Identity Provider for user"
                }
            }
        }
    ],
    "definitions": {
        "contact": {"$ref": "../../../_common/contact.json"},
        "id": {"$ref": "../../../_common/types/id.json"},
        "uuid": {"$ref": "../../../_common/types/uuid.json"},
        "access_type": {"$ref": "../../../_common/types/access_type.json"},
        "admin_role": {"$ref": "../../../_common/types/admin_role.json"},
        "flag": {"$ref": "../../../_common/types/flag.json"},
        "notifications_backup": {"$ref": "../../../_common/types/notifications_backup.json"},
        "notifications_device_control": {"$ref": "../../../_common/types/notifications_device_control.json"},
        "notifications_certificate_management": {"$ref": "../../../_common/types/notifications_certificate_management.json"},
        "version": {"$ref": "../../../_common/types/version.json"},
        "quotas_and_privileges_local_backup_is_integer": {"$ref": "../../../_common/quotas_and_privileges_local_backup_is_integer.json"}
    },
    "title": "users_post_request",
    "type": "object",
    "description": "/groups/{group}/users/POST request",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "language": "en",
    "city": "Nowhere",
    "privileged": 1,
    "country": "USA",
    "roles": 1,
    "login": "john.doe",
    "email": "john.doe@mail.com",
    "zipcode": "11111-1111",
    "firstname": "John",
    "use_existing_identity": 1,
    "state": "US",
    "lastname": "Doe",
    "phone": "+1(1111)-1111-1111",
    "address1": "555 Main Street",
    "privileges": {
        "server_count": 1,
        "quota_vms_hard": 1,
        "vm_count": 1,
        "quota_mailbox_instance_storage": 1,
        "quota_win_server_essentials_hard": 1,
        "virtualhost_count": 1,
        "workstation_count": 1,
        "local_backup": 1,
        "quota_workstations_hard": 1,
        "win_server_essential_count": 1,
        "quota_mobiles_hard": 1,
        "quota_virtualhosts_hard": 1,
        "quota_storage_hard": 1111,
        "quota_local_storage_hard": 1111,
        "mailbox_count": 1,
        "website_count": 1,
        "universal_devices_count": 1,
        "storage_size": 1111,
        "local_storage_size": 1111,
        "quota_servers_hard": 1,
        "mobile_count": 1,
        "quota_mailboxes_hard": 1,
        "quota_websites_hard": 1,
        "quota_universal_devices_hard": 1
    },
    "notifications_management": 1,
    "agents": {
        "autoupdate": 1
    },
    "address2": "Apt. 5A",
    "backup": {
        "monitor": 1
    },
    "notifications_backup": 3,
    "notifications_device_control": 1,
    "notifications_certificate_management": 7
}

HTTP status code 200

Object has been updated

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "version": {"$ref": "#/definitions/version"}
    },
    "title": "version",
    "type": "object",
    "description": "Common version response",
    "definitions": {
        "version": {"$ref": "types/version.json"}
    },
    "required": ["version"],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "version": 11223344
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 409

Conflict

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Conflict"
    },
    "message": "Conflict",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 409
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

HTTP status code 426

Version mismatch

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Version mismatch"
    },
    "message": "Version mismatch",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 426
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/users/{user}/hosts post

Get host addresses for account

post

Return list of host-names and ports that will be used by Backup Client

Secured by session

Secured by basicAuth

URI Parameters

user: required(string)

Annotations

AllowedTo
```
["company_admin","unit_admin"]
```
roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "title": "hosts_post_response",
    "type": "array",
    "description": "/users/{user}/hosts/POST response",
    "items": [
        {
            "properties": {
                "name": {
                    "type": "string",
                    "title": "name",
                    "description": "Name of a service"
                },
                "port": {
                    "type": "integer",
                    "title": "port",
                    "description": "Server port"
                },
                "host": {
                    "type": "string",
                    "title": "host",
                    "description": "Hostname"
                }
            },
            "type": "object"
        }
    ],
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

[
    {
        "name": "web console",
        "port": 443,
        "host": "baas.acronis.com"
    }
]

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/users/{user}/impersonate get

Service user impersonation

get

Get impersonated JWT token for specified service user

Secured by session

Secured by basicAuth

URI Parameters

user: required(string)

Annotations

AllowedTo
```
["root_admin"]
```
roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "jwt": {
            "type": "string",
            "description": "Issued jwt"
        }
    },
    "title": "jwt_response",
    "type": "object",
    "description": "Common jwt response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9Cg.eyJhdWQiOlsibWMtdnotc25hdW1lbmtvLTEyLTA4LTE4LTMyLTExNjU0Lm1zcC5ydS5jb3JwLmFjcm9uaXMuY29tIl0sImVtYWlsIjoic3VAdGVzdC5jb20iLCJleHAiOjE0NDk2NzE0MDAsImlhdCI6MTQ0OTY2NzgwMCwiaXNzIjoibWMtdnotc25hdW1lbmtvLTEyLTA4LTE4LTMyLTExNjU0Lm1zcC5ydS5jb3JwLmFjcm9uaXMuY29tIiwibmFtZSI6Ikl2YW4gSXZhbm92IiwibmJmIjoxNDQ5NjY3ODAwLCJzY29wZSI6WyJBZ2VudFJlZ2lzdHJhdGlvbiJdLCJ0ZW5hbnRJZCI6IjQiLCJ1aWQiOiJzdUB0ZXN0LmNvbSJ9Cg.fcbY_QmuDH7FMAhM6JySPpHpFUdnPxuXJxnoetyG6p8"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/users/{user}/jwt get

Issuing JWT token

get

Issue JWT token. You can add jwt='your jwt token' query parameter to most of requests to perform this action as selected user

Secured by session

Secured by basicAuth

URI Parameters

user: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

scope: (string)
Comma-separated list of user scopes
Example:
```
SomeScope1, SomeScope2, SomeScope3
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "jwt": {
            "type": "string",
            "description": "Issued jwt"
        }
    },
    "title": "jwt_response",
    "type": "object",
    "description": "Common jwt response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9Cg.eyJhdWQiOlsibWMtdnotc25hdW1lbmtvLTEyLTA4LTE4LTMyLTExNjU0Lm1zcC5ydS5jb3JwLmFjcm9uaXMuY29tIl0sImVtYWlsIjoic3VAdGVzdC5jb20iLCJleHAiOjE0NDk2NzE0MDAsImlhdCI6MTQ0OTY2NzgwMCwiaXNzIjoibWMtdnotc25hdW1lbmtvLTEyLTA4LTE4LTMyLTExNjU0Lm1zcC5ydS5jb3JwLmFjcm9uaXMuY29tIiwibmFtZSI6Ikl2YW4gSXZhbm92IiwibmJmIjoxNDQ5NjY3ODAwLCJzY29wZSI6WyJBZ2VudFJlZ2lzdHJhdGlvbiJdLCJ0ZW5hbnRJZCI6IjQiLCJ1aWQiOiJzdUB0ZXN0LmNvbSJ9Cg.fcbY_QmuDH7FMAhM6JySPpHpFUdnPxuXJxnoetyG6p8"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/users/{user}/links get

Get links for users

get

Get links for user

Secured by session

Secured by basicAuth

URI Parameters

user: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

Query Parameters

origin: (string)
Indicator of where the link will be shown
Example:
```
email_notification
```
redirect_url: (string)
URL that the buyer will be redirected to after the purchase
Example:
```
cloud.mysite.com
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "links": {
            "properties": {
                "quotas_upsell": {
                    "type": ["string", "null"],
                    "title": "quotas_upsell",
                    "description": "Link to partner site for bigger quotas purachase"
                }
            },
            "type": "object",
            "title": "links",
            "description": "Links array"
        }
    },
    "title": "links_get_response",
    "type": "object",
    "description": "/users/{user}/links/GET response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "links": {
        "quotas_upsell": "upsell.partner.com"
    }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

/users/{user}/machines head post

High-level machines management

head

Check user`s write permissions

post

Add a new machine to backup account

Check user`s write permissions

Secured by session

Secured by basicAuth

URI Parameters

user: required(string)

Annotations

AllowedTo

["root_admin","partner_admin","company_admin","unit_admin","readonly_admin"]

roles_lib.x-tags
```
["private"]
```

HTTP status code 200

Success

Body

Media type: application/json

Type: json

Content:

{"$schema": "http://json-schema.org/draft-04/schema#"}

Example:

"Success"

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Add a new machine to backup account

Secured by session

Secured by basicAuth

URI Parameters

user: required(string)

Annotations

AllowedTo
```
["company_admin","unit_admin"]
```
roles_lib.x-tags
```
["private"]
```

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "public_key": {
            "type": "string",
            "title": "public_key",
            "description": "ZMQ public key of machine"
        },
        "agent_id": {
            "type": "string",
            "title": "agent_id",
            "description": "Unique machine id"
        },
        "secret": {
            "type": "string",
            "title": "secret",
            "description": "Internal password for machine"
        }
    },
    "title": "machines_post_request",
    "type": "object",
    "additionalProperties": false,
    "description": "/users/{user}/machines/POST request",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "public_key": "zs/u1jgKQ$WoBj]=bN^5*>dvFgEuRFW+1zv1xGZ",
    "agent_id": "839AB661-2573-4E23-8440-CF37B5429B4E",
    "secret": "v6fXz.[U$^G1qPq<07^}KvaD3iHM^fJH!b{>5e^F"
}

HTTP status code 200

Created

Body

Media type: application/json

Type: json

Content:

{
    "properties": {
        "server_pubkey": {
            "type": "string",
            "title": "server_pubkey",
            "description": "ZMQ public key of server"
        },
        "server_address": {
            "type": "string",
            "title": "server_address",
            "description": "Server ip-address or dns name"
        }
    },
    "title": "machines_post_response",
    "type": "object",
    "description": "/users/{user}/machines/POST response",
    "$schema": "http://json-schema.org/draft-04/schema"
}

Example:

{
    "server_pubkey": "0Lom5P]cxOKp2K()W4LY<BT7wM^+kp5mtYh0nsd",
    "server_address": "baas.acronis.com"
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

HTTP status code 403

Current user has no permissions for this URL/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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Not found"
    },
    "message": "Not found",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 404
  }
}

HTTP status code 409

Conflict

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Conflict"
    },
    "message": "Conflict",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 409
  }
}

HTTP status code 415

Invalid content type

Body

Media type: application/json

Type: json

Content:

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "error": {
      "type": "object",
      "properties": {
        "code": {
          "type": ["string", "integer"]
        },
        "context": {
          "type": "object"
        },
        "domain": {
          "type": ["string", "null"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Invalid content type"
    },
    "message": "Invalid content type",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 415
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Method required an authenticated user"
    },
    "message": "Method required an authenticated user",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 401
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

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"]
        },
        "message": {
          "type": "string"
        },
        "details": {
          "type": "object",
          "description": "Additional info",
          "properties": {
            "info": {"type": ["string", "null"]}
          }
        },
        "data": {
          "type": "array",
          "items": {"type": "string"}
        }
      },
      "required": [
        "code",
        "details",
        "domain",
        "message"
      ]
    }
  },
  "required": [
    "error"
  ]
}

Example:

{
  "error": {
    "details": {
      "info": "Current user has no permissions for this URL/method"
    },
    "message": "Current user has no permissions for this URL/method",
    "domain": "PlatformAccountServer",
    "context": {},
    "code": 403
  }
}

Multi-service Portal API documentation version 1

/accounts

/accounts get post

get /accounts

Annotations

Query Parameters

HTTP status code 200

Body

Secured by session

Headers

HTTP status code 401

Body

HTTP status code 403

Body

Secured by basicAuth

Headers

HTTP status code 403

Body

post /accounts

Annotations

Query Parameters

Body

HTTP status code 201

Body

HTTP status code 406

Body

HTTP status code 409

Body

HTTP status code 415

Body

Secured by session

Headers

HTTP status code 401

Body

HTTP status code 403

Body

Secured by basicAuth

Headers

HTTP status code 403

Body

/accounts/check get

get /accounts/check

Annotations

Query Parameters

HTTP status code 404

Body

HTTP status code 409

Body

Secured by session

Headers

HTTP status code 401

Body

HTTP status code 403

Body

Secured by basicAuth

Headers

HTTP status code 403

Body

/actions

/actions/activate get post

get /actions/activate

Annotations

Query Parameters

HTTP status code 200

Body

HTTP status code 401

Body

HTTP status code 403

Body

HTTP status code 404

Body

Secured by session

Headers

HTTP status code 401

Body

HTTP status code 403

Body

Secured by basicAuth

Headers

HTTP status code 403