Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

User

Create a new user

Invite a user to the Amigo platform. The endpoint will create a new user in the organization, linked to the supplied email address. The created user will remain in the unverified status and will not have access to most of Amigo's services.

If login_link is not-None, an email containing it will be sent to the user's email with descriptions indicating that this would allow the user to login and start their Amigo experience. Otherwise, no email will be sent.

Permissions

This endpoint requires the following permissions:

  • User:InviteUser on the user to invite.
  • The authenticated user must have greater privileges than the role assigned to the new user.
post/v1/{organization}/user/

Path parameters

organizationstring required

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Request body

first_namestring required
last_namestring required
emailstring email required

The email of the user. This email uniquely identifies the user in the organization.

login_linkstring uri nullable

If specified, this link will be sent to the user's email as the link to start their Amigo experience. For Amigo's frontend, this would be the user's organization's login page with their email already filled in.

role_namestring required

The role to assign to the user. Only roles that are returned from the Get roles endpoint are allowed.

nonsensitive_user_variablesobject

The nonsensitive user variables to provide to the tool during invocation.

sensitive_user_variablesobject

The sensitive user variables to provide to the tool during invocation.

Response

Succeeded

user_idstring required

The identifier of the new user.

verify_linkstring nullable required

The link sent to the user. Only present if login_link is True in the request.