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: “{API Token}”
  • Request Body (JSON):

Field

Type

Description

UserName

Mandatory

The username the user provided to Axis Security and used to access the Axis User Portal and applications.

Email

Mandatory

The email address to which a link for setting a password is sent.

FirstName

Mandatory

The user’s first name.

LastName

Mandatory

The user’s last name.

Enabled

Optional

The time in ISO format when the user's account will be automatically disabled. If the field is left blank, the user's account will not expire.

Groups

Optional

A list of groups in Axis IdP to which the user is added. The "groups" field is a list of objects, where each object contains an “ID” field with the group’s ID.

SSHPrivateKey

Optional

A personal SSH key that can be used to log users to an SSH server.

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:

Code

Description

200

Groups retrieved successfully

204

Changes committed successfully

400

Bad request

401

Unauthorized access. Make sure the API token includes writing permissions. Click here for more information.

404

Entity not found

500

Internal server error

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/
  • Request Method: GET
  • Request Headers: Authorization: “{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:

Code

Description

200

User information retrieved successfully

204

Changes committed successfully

400

Bad request

401

Unauthorized access

404

Entity not found

500

Internal server error

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: “{API Token}”
  • Query params:

Query Param

Description

PageSize

Specify the maximum number of users to retrieve.

PageNumber

Page number 1 will retrieve the first users.

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:

Code

Description

200

Groups retrieved successfully

204

Changes committed successfully

400

Bad request

401

Unauthorized access

404

Entity not found

500

Internal server error

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/
Request Method: POST
Request Headers: Authorization: “{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:

Code

Description

200

User updated successfully

204

Changes committed successfully

400

Bad request

401

Unauthorized access. Make sure the API token includes writing permissions. Click here for more information.

404

Entity not found

500

Internal server error

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: POST
  • Request Headers: Authorization: “{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/
  • Request Method: Delete
  • Request Headers: Authorization: “{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: “{API Token}”
  • Request Body: empty

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


Did this page help you?