Method: customers.userinvitations.isInvitableUser

Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account).

Eligibility is based on the following criteria:

  • the email address is a consumer account and it's the primary email address of the account, and
  • the domain of the email address matches an existing verified Google Workspace or Cloud Identity domain

If both conditions are met, the user is eligible.

Note: This method is not supported for Workspace Essentials customers.

HTTP request

GET https://cloudidentity.googleapis.com/v1beta1/{name=customers/*/userinvitations/*}:isInvitableUser

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. UserInvitation name in the format customers/{customer}/userinvitations/{user_email_address}

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response for userinvitations.isInvitableUser RPC.

JSON representation
{
  "isInvitableUser": boolean
}
Fields
isInvitableUser

boolean

Returns true if the email address is invitable.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-identity.userinvitations.readonly
  • https://www.googleapis.com/auth/cloud-identity.userinvitations
  • https://www.googleapis.com/auth/cloud-identity

For more information, see the Authentication Overview.