POST
/
users
curl --request POST \
  --url https://api.altostrat.io/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "jsmith@example.com",
  "name": "<string>",
  "allow_login": true,
  "mobile": {
    "local": "<string>",
    "country": "<string>"
  },
  "timezone": "<string>",
  "roles": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}'
{
  "user": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "idp": "azure",
    "name": "<string>",
    "email": "jsmith@example.com",
    "email_verified": true,
    "mobile": {
      "e164": 12125551212,
      "local": "(212) 555-1212",
      "country": "US"
    },
    "mobile_verified": true,
    "allow_login": true,
    "country": "<string>",
    "timezone": "Australia/Melbourne",
    "date_format": "d M Y",
    "time_format": "H:i:s",
    "locale": "<string>",
    "picture": "<string>",
    "mfa_enabled": true,
    "roles": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ]
  },
  "password": "<string>"
}

Authorizations

​
Authorization
string
header
required

Standard OAuth2 flow for user authentication. Use Authorization Code Grant or Implicit Grant. JWT Bearer tokens obtained are used for subsequent requests.

Body

application/json
User details for creation or addition.
​
email
string
required

User's email address. Must be unique if creating a new user.

​
name
string

User's full name (required if creating new user).

Maximum length: 100
​
allow_login
boolean

Whether the new user should be allowed to log in.

​
mobile
object
​
timezone
string

User's timezone (required if creating new user).

​
roles
string[] | null

Array of Role UUIDs to assign to the user within the current team.

Response

201
application/json
User created or added successfully. Includes temporary password if user was newly created.
​
user
object
​
password
string | null

Temporary password for the newly created user (only present on creation).

Was this page helpful?