Invite Users Using POST

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

URI

POST

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

COPY

Path Parameters

string

orgId

Required

Unique identifier (GUID) of the organization.

Query Parameters

string

action

Optional

Action option, should be used for revoke

Request Body

UsersOrganizationInvitationRequest of type(s) application/json

Required

Show optional properties

{
    "usernames": [
        {}
    ]
}

{
    "customGroupsIds": [
        "string"
    ],
    "customRoles": [
        {
            "createdBy": "string",
            "createdDate": "string",
            "expiresAt": 3609941597,
            "lastUpdatedBy": "string",
            "lastUpdatedDate": "string",
            "membershipType": "string",
            "name": "string",
            "resource": "string"
        }
    ],
    "invitationExpirationInDays": 0,
    "invitedBy": "string",
    "notifyUsersOfOrgAccess": false,
    "notifyUsersOfRegistration": false,
    "orgRoleNames": [
        "string"
    ],
    "organizationRoles": [
        {
            "createdBy": "string",
            "createdDate": "string",
            "expiresAt": 3609941597,
            "lastUpdatedBy": "string",
            "lastUpdatedDate": "string",
            "membershipType": "string",
            "name": "string",
            "resource": "string"
        }
    ],
    "serviceRolesDtos": [
        {
            "serviceDefinitionLink": "string",
            "serviceRoleNames": [
                "string"
            ],
            "serviceRoles": [
                {
                    "createdBy": "string",
                    "createdDate": "string",
                    "expiresAt": 3609941597,
                    "lastUpdatedBy": "string",
                    "lastUpdatedDate": "string",
                    "membershipType": "string",
                    "name": "string",
                    "resource": "string"
                }
            ]
        }
    ],
    "skipNotify": false,
    "skipNotifyRegistration": false,
    "usernames": [
        "string"
    ]
}

array of string

customGroupsIds

Optional

Constraints: minItems: 0 maxItems: 15

Custom Groups (relevant only for invite).

array of object

customRoles

Optional

Custom Roles (relevant only for invite).

integer As int32 As int32

invitationExpirationInDays

Optional

Constraints: minimum: 1 maximum: 90

The expiration time of the invitation in days. Default value is 7 days.

string

invitedBy

Optional

Invited By, specify the actual user who is inviting.

boolean

notifyUsersOfOrgAccess

Optional

Constraints: default: true

Send e-mail notification to existing user(s) informing about org access that is granted.

boolean

notifyUsersOfRegistration

Optional

Constraints: default: true

Send e-mail notification to new user(s) inviting them to VMware Tanzu.

array of string

orgRoleNames

Optional

Deprecated: Org role names (use organizationRoles instead)

array of object

organizationRoles

Optional

Organization roles (relevant only for invite).

array of object

serviceRolesDtos

Optional

Service Roles (relevant only for invite).

boolean

skipNotify

Optional

Deprecated: Indicates if the notification have to be skipped (Use notifyUsers instead)

boolean

skipNotifyRegistration

Optional

Deprecated: Prevent sending mails to users that do not yet have a CSP profile (Use notifyUsersOfRegistration instead)

array of string

usernames

Required

List of Usernames (e-mails) of users.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

202

Accepted

Operation doesn't return any data structure

400

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

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

404

Organization with this identifier is not found.

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

409

The request could not be processed due to a conflict

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json

"CspErrorResponse Object"

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"usernames":["string"]}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/invitations

On This Page

Description

Request

Path Parameters

Query Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Organization Operations

GET