Atmos Cloud API: Axis IdP

The Atmos Cloud API allows administrators to have programmatic control over Axis IdP. Click here to learn more about generating an API token.

Create a new user in Axis IdP

The management API allows administrators to create new users in Axis IdP.

Request Details:

• Request URL: “admin-api.axissecurity.com/api/v1/users”
• Request Method: POST
• Request Headers: Authorization: “Bearer {API Token}”
• Request Body (JSON):

Example:

{
"userName":"JohnDoe",
"email":"[email protected]",
"firstName":"John",
"lastName":"Doe",
"enabled":true,
"expiration":"2021-08-05T08:59:00.772Z",
"groups":[
          {
           "id":"string"
          }
        ],
"sshPrivateKey":"string"
}

Successful Response Format:

{
"id":"string",
"userName":"string",
"email":"string",
"firstName":"string",
"lastName":"string",
"enabled":true,
"expiration":"2021-08-05T09:33:50.246Z",
"groups":[
  {
   "id":"string",
   "value":"string"
  }
 ],
"hasSshPrivateKey":true
}

Response Codes:

Get the details of an existing user in Axis IdP

To get the details of an existing user, the user’s ID should be added to the request URL.

Request Details:

• Request URL: “admin-api.axissecurity.com/api/v1/users/<user ID>”
• Request Method: GET
• Request Headers: Authorization: “Bearer {API Token}”
• Request Body: empty

Successful Response Format:

{
"id":"string",
"userName":"string",
"email":"string",
"firstName":"string",
"lastName":"string",
"enabled":true,
"expiration":"2021-08-05T09:33:50.246Z",
"groups":[
  {
   "id":"string",
   "value":"string"
  }
 ],
"hasSshPrivateKey":true
}

Response Codes:

Get a list of existing users in Axis IdP

Request Details

• Request URL: “admin-api.axissecurity.com/api/v1/users?pageSize=100&pageNumber=1”
• Request Method: GET
• Request Headers: Authorization: “Bearer {API Token}”
• Query params:

Successful Response Format

{
"pageNumber":1,
"pageSize":100,
"firstPage":"<URL to retrieve first page>",
"lastPage":"<URL to retrieve last page>",
"totalPages":1,
"totalRecords":50,
"nextPage":"<URL to retrieve next page>",
"previousPage":"<URL to retrieve previous page>",
"data":[
  {
   "id":"string",
   "name":"string",
   "description":"string",
   "users":[
     {
      "id":"string",
      "value":"string"
     }
    ]
   }
 ]
}

Response Codes:

Update an existing user in Axis IdP

To update an existing user, the user’s ID should be added to the request URL.

📘

Note

The values stated in the request body will override the user's existing values.

Request Details:
Request URL: “admin-api.axissecurity.com/api/v1/users/<user id>”
Request Method: PUT
Request Headers: Authorization: “Bearer {API Token}”

Example:

{
"userName":"JohnDoe",
"email":"[email protected]",
"firstName":"John",
"lastName":"Doe",
"enabled":true,
"expiration":"2021-08-05T08:59:00.772Z",
"groups":[
  {
   "id":"string"
  }
 ],
"sshPrivateKey":"string”
}

Successful Response Format

{
"id":"string",
"userName":"string",
"email":"string",
"firstName":"string",
"lastName":"string",
"enabled":true,
"expiration":"2021-08-05T09:33:50.246Z",
"groups":[
  {
   "id":"string",
   "value":"string"
  }
 ],
"hasSshPrivateKey":true
}

Response Codes:

Update an existing user group in Axis IdP

To update an existing user group, the user group ID should be added to the request URL.

📘

Note

The values in the request body override existing user group values.

Request Details:

• Request URL: “admin-api.axissecurity.com/api/v1/groups/”
• Request Method: PUT
• Request Headers: Authorization: “Bearer {API Token}”

Example:

{
"name":"sales department",
"description":"A group for the sales representatives",
"users":[
  {
   "id":"string"
  }
 ]
}

Delete a user in Axis IdP

To delete an existing user, the user ID should be added to the request URL.

Request Details

• Request URL: “admin-api.axissecurity.com/api/v1/users/<user id>”
• Request Method: Delete
• Request Headers: Authorization: “Bearer {API Token}”
• Request Body: empty

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

Delete a user group in Axis IdP

To delete an existing user group, the user group ID should be added to the request URL.

Request Details

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

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