Sign in

v1

latestOpenAPI 3.0.12026-08-064278250.7 KB
portal-users

Add a portal user

Add an admin portal user to a specified workspace. The user is assigned a super admin role.

post/v1/portal-users

Headers

Workspacestring required

The workspace identifier, which isolates API requests inside the provided workspace scope.

Request body

firstNamestring required

The admin portal user's first name.

lastNamestring required

The admin portal user's last name.

emailstring required

The admin portal user's email address.

invitedByAdminNamestring

The full name of the administrator who sent the invitation.

invitedByAdminEmailstring

The email address of the administrator who sent the invitation.

Example request

{
  "firstName": "Martin",
  "lastName": "Simpson",
  "email": "corotest@corotest.com",
  "invitedByAdminName": "Martin Miller",
  "invitedByAdminEmail": "corotest@corotest.com"
}

Response

Success

idstring

The unique identifier for the admin portal user.

userStatusstring

The status of the add admin portal user response.

Example response

{
  "id": "1028361sy8163gqa",
  "userStatus": "Unable to add user"
}