[{"label":"Latest (v1.0)","version":"latest"}]
csp

Invite Users

Description

Create/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

Request

URL

URL


post
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/invitations
Copy

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).


customRoles Optional

Custom Roles (relevant only for invite).


array of string
orgRoleNames Optional

Deprecated: Org role names (use organizationRoles instead)


organizationRoles Optional

Organization roles (relevant only for invite).


array of ServiceRolesDto
serviceRolesDtos Optional

Service 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

Authentication

This operation uses the following authentication methods.

Response

Response

202 Accepted

Accepted

Errors

Errors

400

Invalid request body | Platform Operator and Read-only Operator roles can only be assigned to vmware.com and csp.local users


401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

Organization with this identifier is not found.


409

The request could not be processed due to a conflict


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

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

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2


Feedback

Was this page helpful?