OPopal
users

POST /users

Changed on

Invites a user to your organization.

Request

  • Base URL
    https://api.opal.dev/v1
  • Auth
    HTTP bearer

Request body

emailstring email required
first_namestring required
last_namestring required
role'MEMBER' | 'ADMIN' required

The product role assigned to a user.

Response

The invited user.

user_idstring uuid required

The ID of the user.

emailstring required

The email of the user.

full_namestring required

The full name of the user.

first_namestring required

The first name of the user.

last_namestring required

The last name of the user.

positionstring required

The user's position.

manager_idstring uuid nullable

The ID of the user's manager. Null if the user has no manager.

hr_idp_status'ACTIVE' | 'SUSPENDED' | 'DEPROVISIONED' | 'DELETED' | 'NOT_FOUND'

User status pulled from an HR/IDP provider.

Example response

{
  "user_id": "29827fb8-f2dd-4e80-9576-28e31e9934ac",
  "email": "john.doe@company.dev",
  "full_name": "John Doe",
  "first_name": "John",
  "last_name": "Doe",
  "position": "Engineer"
}

Changes