Learn how to manage Axiom users via API.
This page explains how to manage users programmatically via the API.
API_TOKEN
with the Axiom API token you have generated. For added security, store the API token in an environment variable.To create a user, send a POST request to the users
endpoint. In the body of the request, specify the following:
name
email
role
For example:
Replace AXIOM_DOMAIN
with api.axiom.co
if your organization uses the US region, and with api.eu.axiom.co
if your organization uses the EU region. For more information, see Regions.
Replace API_TOKEN
with the Axiom API token you have generated. For added security, store the API token in an environment variable.
The example response contains the user ID that you can later use to access the user programmatically.
For more information, see the API reference.
To get information about all the users in your Axiom organization, send a GET request to the users
endpoint. For example:
Replace AXIOM_DOMAIN
with api.axiom.co
if your organization uses the US region, and with api.eu.axiom.co
if your organization uses the EU region. For more information, see Regions.
Replace API_TOKEN
with the Axiom API token you have generated. For added security, store the API token in an environment variable.
The example response is a list of user objects. Each object contains a unique user ID that you can later use to access the user programmatically.
For more information, see the API reference.
To get information about a specific user, send a GET request to the users/USER_ID
endpoint where USER_ID
is the unique ID of the user. For example:
Replace AXIOM_DOMAIN
with api.axiom.co
if your organization uses the US region, and with api.eu.axiom.co
if your organization uses the EU region. For more information, see Regions.
Replace API_TOKEN
with the Axiom API token you have generated. For added security, store the API token in an environment variable.
Example response:
For more information, see the API reference.