[{"label":"Latest (v1.0)","version":"latest"}]
csp
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 Owner | ✔️ | ❌ |
Request
URLURL
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/invitations
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:
simple Explode:false
Query Parameters
Query Parameters
string
action
Optional
Action option, should be used for revoke
Parameter Serialization Style:
form Explode:true
Request Body
Request Body
UsersOrganizationInvitationRequest
of mimetype application/json
Required
{
"usernames": [
"string"
]
}
array of
string
usernames
Required
List of Usernames (e-mails) of users.
array of
string
customGroupsIds
Optional
Custom Groups (relevant only for invite).
array of
string
orgRoleNames
Optional
Deprecated: Org role names (use organizationRoles instead)
array of
BaseRoleBindingDto
organizationRoles
Optional
Organization roles (relevant only for invite).
boolean
skipNotify
Optional
Indicates if the notification have to be skipped
boolean
skipNotifyRegistration
Optional
Prevent sending mails to users that do not yet have a CSP profile
string
invitedBy
Optional
Invited By, specify the actual user who is inviting.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
Invalid request body | Platform Operator and Read-only Operator roles can only be assigned to vmware.com and csp.local users
Code Samples
Code Samples
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"customGroupsIds":["string"],"customRoles":[{"createdBy":"string","createdDate":"string","expiresAt":3609941597,"lastUpdatedBy":"string","lastUpdatedDate":"string","membershipType":"DIRECT","name":"string","resource":"string"}],"invitedBy":"string","orgRoleNames":["string"],"organizationRoles":[{"createdBy":"string","createdDate":"string","expiresAt":3609941597,"lastUpdatedBy":"string","lastUpdatedDate":"string","membershipType":"DIRECT","name":"string","resource":"string"}],"serviceRolesDtos":[{"serviceDefinitionLink":"string","serviceRoleNames":["string"],"serviceRoles":[{"createdBy":"string","createdDate":"string","expiresAt":3609941597,"lastUpdatedBy":"string","lastUpdatedDate":"string","membershipType":"DIRECT","name":"string","resource":"string"}]}],"skipNotify":false,"skipNotifyRegistration":false,"usernames":["string"]}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/invitations
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2
[{"label":"Latest (v1.0)","version":"latest"}]
csp
On This Page
Organization Operations
post
post
