Atmos Cloud API: Management API

The Axis Cloud API allows administrators to have programmatic control over Axis IdP. In addition, it allows for the following actions in Axis IdP:

Getting Started

  • Set up the API
  • Configure an API request to Axis

Management API Commands and Parameters

  • Commit changes
  • Create new users in Axis IdP
  • Get the details of an existing user
  • Get a list of existing users
  • Update an existing user
  • Delete a user
  • Create a new user group
  • Get the details of an existing user group in Axis IdP
  • Get a list of existing user groups in Axis IdP
  • Update an existing user group
  • Delete a user group

Set up the API

  1. Generate a new API token in the Management Console. The token will be used to authorize the API calls to make changes to your workspace. To authorize your API request to Axis Cloud, configure the token as a bearer token in your request Authentication header.
  2. Download the API Swagger file that lists the supported API calls. The Swagger file can be used to import the API calls' details to your code platform.
  3. Send the API calls to the API Base URI, followed by the request name. For example, to commit changes, send a POST request to “admin-api.axissecurity.com/api/v1/commit/”

Configure an API request to Axis

  1. Generate an API token in the Management Console.
  2. Configure the API token as a bearer token in the Authorization header.
  3. Configure the request to use the GET/POST/DELETE method according to the action you want to take.
  4. Create a JSON file with the relevant parameters and add it to the request body
  5. Send the request to the base URI: “admin-api.axissecurity.com/api/v1/” with the relevant command suffix.
  6. Send a “commit” request for the changes to take effect.

Management API Commands and Parameters

Commit Changes

For changes made with the API or the Management Console UI to take effect, you must commit your changes. The management API allows committing changes with the "Commit" command.

Request Details

  • Request URL: “admin-api.axissecurity.com/api/v1/commit”
  • Request Method: Post
  • Request Headers: Authorization: “{API Token}”
  • Request Body: empty

A successful response will return a 204 response with an empty body.


Did this page help you?