AXaxiom
Users

POST /users

Changed on

Adds a user to the organization with the given role and sends them an invite email. If the email address already belongs to an Axiom account, Axiom keeps its existing name. API tokens can't assign the owner role.

Request

  • Base URL
    https://api.axiom.co/v2
  • Auth
    OAuth 2
    Authorization codehttps://accounts.google.com/o/oauth2/v2/auth
    Token URLhttps://www.googleapis.com/oauth2/v4/token
    Scopesusers|create
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

emailstring required

Email address of the new user

namestring required

Full name of the new user

rolestring required

Role to assign to the new user

Example request

{
  "email": "jane.doe@example.com",
  "name": "Jane Doe",
  "role": "member"
}

Response

Added user.

emailstring required

User's email address

idstring required

Unique identifier for the user

namestring required

User's full name

Example response

{
  "email": "john.doe@example.com",
  "id": "usr_123456789",
  "name": "John Doe",
  "role": {
    "id": "role_123456789",
    "name": "Organization Admin"
  }
}

Changes

  • v2fbc1b8430febRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status