UsersOrganizationInvitationRequest

UsersOrganizationInvitationRequest
UsersOrganizationInvitationRequest

The user organization invitation request.

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

Deprecated: Org role names (use organizationRoles instead)

organizationRoles
Optional

Organization roles (relevant only for invite).

serviceRolesDtos
Optional

Service Roles (relevant only for invite).

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 cloud services.

array of string
customGroupsIds
Optional
Constraints: minItems: 0 maxItems: 15

Custom Groups (relevant only for invite).

boolean
skipNotify
Optional

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

string
invitedBy
Optional

Invited By, specify the actual user who is inviting.

customRoles
Optional

Custom Roles (relevant only for invite).

array of string
usernames
Required

List of Usernames (e-mails) of users.

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.

boolean
skipNotifyRegistration
Optional

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