Invite User via API

This method allows you to invite a new user to your DeployHQ account.

Tip: You can explore and test this endpoint interactively using our OpenAPI documentation.

URL

/users

HTTP Method

POST

Supported Parameters

All parameters are wrapped in a user key.

• first_name - The user's first name (required)
• email_address - The user's email address (required)
• last_name - The user's last name (optional)
• time_zone - The user's preferred time zone (optional)
• account_administrator - Whether the user should be an account administrator (optional, boolean)
• can_manage_users - Whether the user can manage other users (optional, boolean)
• can_manage_billing - Whether the user can manage billing (optional, boolean)
• can_create_projects - Whether the user can create new projects (optional, boolean)
• can_manage_agents - Whether the user can manage network agents (optional, boolean)
• all_projects_allowed - Whether the user has access to all projects (optional, boolean)

Example cURL Request

curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
-X POST \
-d '{ \
  "user": { \
    "first_name": "Jane", \
    "last_name": "Smith", \
    "email_address": "jane@example.com", \
    "can_create_projects": true, \
    "all_projects_allowed": false \
  } \
}' \
https://test.deployhq.com/users

Example Response

{
  "id": 12345,
  "identifier": "a1b2c3d4-5e6f-7890-abcd-ef1234567890",
  "first_name": "Jane",
  "last_name": "Smith",
  "email_address": "jane@example.com",
  "time_zone": "Etc/UTC",
  "account_administrator": false,
  "activated": false,
  "can_manage_users": false,
  "can_manage_billing": false,
  "can_create_projects": true,
  "can_manage_agents": false,
  "all_projects_allowed": false
}

Notes

• An invitation email will be sent to the specified email address
• The invited user will need to accept the invitation and set a password before they can log in
• Permission boolean fields default to false if not specified