About

This endpoint creates a pending invitation for a new user. When called, this endpoint sends an email invitation with a signup link and assigns default roles or access settings if configured. Invited users can log in using either password authentication or SSO, depending on your organization’s login setup.

Example

Invite user with SSO

curl -X POST "https://api.picussecurity.com/v1/users/invite" \
  -H "Access-Token: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "newuser@example.com",
    "role_id": 2,
    "login_type": "sso"
  }'

{
  "id": 1234
}

Invite user with password login

curl -X POST "https://api.picussecurity.com/v1/users/invite" \
  -H "Access-Token: YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "another.user@example.com",
    "role_id": 3,
    "login_type": "password"
  }'

{
  "id": 1235
}

Field Name	Type	Options
email	string	-
role_id	uint	-
login_type	string	sso, password