post
https://api.picussecurity.com/v1/users/invite
Invite User; Email, Role ID, Login Type, LDAP Username
When LDAP SSO is enabled for the account, invitations with login_type sso must include ldap_username. The username must exist in the LDAP directory and must not belong to another user or pending invitation.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
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": "[email protected]",
"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": "[email protected]",
"role_id": 3,
"login_type": "password"
}'{
"id": 1235
}| Field Name | Type | Options |
|---|---|---|
| string | - | |
| role_id | uint | - |
| login_type | string | sso, password |