Invite Users
DescriptionCreate/Revoke Organization User Invitation.
Note: When passing the action query param with value revoke the invitations for the given usernames will be revoked.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Admin | ✔️ | ❌ |
| Organization Owner | ✔️ | ❌ |
Request
URLURL
Path Parameters
Path Parameters
Unique identifier (GUID) of the organization.
Query Parameters
Query Parameters
Action option, should be used for revoke
Possible values are: revoke
Request Body
{
"usernames": [
"string"
]
}
List of Usernames (e-mails) of users.
Custom Groups (relevant only for invite).
Deprecated: Org role names (use organizationRoles instead)
Organization roles (relevant only for invite).
Indicates if the notification have to be skipped
Prevent sending mails to users that do not yet have a CSP profile
Invited By, specify the actual user who is inviting.
Authentication
Errors
Errors
Invalid request body | Platform Operator and Read-only Operator roles can only be assigned to vmware.com and csp.local users
The user is not authorized to use the API
The user is forbidden to use the API
Organization with this identifier is not found.
The request could not be processed due to a conflict
The user has sent too many requests
An unexpected error has occurred while processing the request
