UsersOrganizationInvitationRequest

UsersOrganizationInvitationRequest
UsersOrganizationInvitationRequest

The user organization invitation request.

JSON Example
{
    "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).

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)

organizationRoles
Optional

Organization roles (relevant only for invite).

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.