v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB

User Invites

Create User Invite

post/v2/facts/{proj_id}/{env_id}/user_invites

Path parameters

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Request body

keystring required

The key of the user that is being invited

status'pending' | 'approved' required

An enumeration.

emailstring email required

The email of the user that being invited

first_namestring required

The first name of the user that is being invited

last_namestring required

The last name of the user that is being invited

role_idstring uuid required

The role of the user that is being invited

tenant_idstring uuid required

The tenant id of the user that is being invited

resource_instance_idstring uuid required

The resource instance id of the user that is being invited

Response

Successful Response

idstring uuid required

Unique id of the elements_user_invite

organization_idstring uuid required

Unique id of the organization that the elements_user_invite belongs to.

project_idstring uuid required

Unique id of the project that the elements_user_invite belongs to.

environment_idstring uuid required

Unique id of the environment that the elements_user_invite belongs to.

created_atstring date-time required

Date and time when the elements_user_invite was created (ISO_8601 format).

updated_atstring date-time required

Date and time when the elements_user_invite was last updated/modified (ISO_8601 format).