[{"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 Admin	✔️	❌
Organization Owner	✔️	❌

Request

URL

post

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

Copy

Path Parameters

string

orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

Query Parameters

string

action Optional

Action option, should be used for revoke

Parameter Serialization Style: form Explode:true

Request Body

UsersOrganizationInvitationRequest of mimetype application/json Required

Show optional properties

{
	"usernames": [
		"string"
	]
}

{
	"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"
	]
}

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 CustomRoleBindingDto

customRoles Optional

Custom Roles (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).

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

This operation uses the following authentication methods.

Bearer

Response

202 Accepted

Accepted

Operation doesn't return any data structure.

Errors

CspErrorResponse

400

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

CspErrorResponse

401

The user is not authorized to use the API

CspErrorResponse

403

The user is forbidden to use the API

CspErrorResponse

404

Organization with this identifier is not found.

CspErrorResponse

409

The request could not be processed due to a conflict

CspErrorResponse

429

The user has sent too many requests

CspErrorResponse

500

An unexpected error has occurred while processing the request

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_admin,org_owner
x-slo-tier: TIER2

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

csp

Organization Operations

post

Assign Roles To Clients On Organization

post

Create Organization Trust

post

Create Trust Member Organization

delete

Delete Organization IDP Registration

get

Get Groups In Organizations By Organization ID And Group Search Term

get

Get Org Linked IDP Details

get

Get Organization By ID

get

Get Organization Clients By Organization ID

get

Get Organization Invitations By Organization ID

get

Get Organization Roles By Organization ID

get

Get Organization Trusts

get

Get Organization Users By Organization ID

get

Get Sub Organizations By Organization ID

get

Get Trust Member Organizations

get

Get User Invitation By Organization ID And User Invitation ID

get

Get Users In Organization By Organization ID And User Search Term

post

Invite Users

post

Link Org To IDP

delete

Remove Clients From Organization By Organization ID

delete

Remove Users From Organization By Organization ID

delete

Revoke User Invitation By Organization ID And User Invitation ID

post

Search Organization Users By Organization ID And Roles Search Term

patch

Update Organization By Organization ID

patch

Update Organization Trust

Invite Users

Access Policy

Request

URL

Path Parameters

Query Parameters

Request Body

Authentication

Bearer

Response

202 Accepted

Errors

Code Samples

cURL Command

Vendor Extensions

On This Page

Organization Operations

Was this page helpful?