2022-07-21
▼ ▲ cloudidentity.customers.userinvitations.get
HTTP Method: GET
Parameter Order: name
Parameters:
name
Type: string
Description: Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}`
Pattern: ^customers/[^/]+/userinvitations/[^/]+$
Required: Yes
Location: path
Path: v1/{+name}
Scopes:
Flat Path: v1/customers/{customersId}/userinvitations/{userinvitationsId}
Description: Retrieves a UserInvitation resource. **Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.
▼ ▲ cloudidentity.customers.userinvitations.send
Scopes:
Flat Path: v1/customers/{customersId}/userinvitations/{userinvitationsId}:send
HTTP Method: POST
Description: Sends a UserInvitation to email. If the `UserInvitation` does not exist for this request and it is a valid request, the request creates a `UserInvitation`. **Note:** The `get` and `list` methods have a 48-hour delay where newly-created consumer accounts will not appear in the results. You can still send a `UserInvitation` to those accounts if you know the unmanaged email address and IsInvitableUser==True.
Parameter Order: name
Path: v1/{+name}:send
Parameters:
name
Type: string
Pattern: ^customers/[^/]+/userinvitations/[^/]+$
Required: Yes
Description: Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}`
Location: path
▼ ▲ cloudidentity.customers.userinvitations.cancel
HTTP Method: POST
Path: v1/{+name}:cancel
Scopes:
Parameter Order: name
Parameters:
name
Description: Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}`
Location: path
Required: Yes
Type: string
Pattern: ^customers/[^/]+/userinvitations/[^/]+$
Description: Cancels a UserInvitation that was already sent.
Flat Path: v1/customers/{customersId}/userinvitations/{userinvitationsId}:cancel
▼ ▲ cloudidentity.customers.userinvitations.isInvitableUser
Flat Path: v1/customers/{customersId}/userinvitations/{userinvitationsId}:isInvitableUser
Parameters:
name
Pattern: ^customers/[^/]+/userinvitations/[^/]+$
Required: Yes
Description: Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}`
Type: string
Location: path
Parameter Order: name
Path: v1/{+name}:isInvitableUser
Description: 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.
Scopes:
HTTP Method: GET
▼ ▲ cloudidentity.customers.userinvitations.list
Description: Retrieves a list of UserInvitation resources. **Note:** New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.
Scopes:
Path: v1/{+parent}/userinvitations
Flat Path: v1/customers/{customersId}/userinvitations
Parameter Order: parent
HTTP Method: GET
Parameters:
pageToken
Location: query
Type: string
Description: Optional. A page token, received from a previous `ListUserInvitations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBooks` must match the call that provided the page token.
orderBy
Type: string
Description: Optional. The sort order of the list results. You can sort the results in descending order based on either email or last update timestamp but not both, using `order_by="email desc"`. Currently, sorting is supported for `update_time asc`, `update_time desc`, `email asc`, and `email desc`. If not specified, results will be returned based on `email asc` order.
Location: query
parent
Pattern: ^customers/[^/]+$
Required: Yes
Location: path
Type: string
Description: Required. The customer ID of the Google Workspace or Cloud Identity account the UserInvitation resources are associated with.
pageSize
Type: integer
Location: query
Description: Optional. The maximum number of UserInvitation resources to return. If unspecified, at most 100 resources will be returned. The maximum value is 200; values above 200 will be set to 200.
Format: int32
filter
Description: Optional. A query string for filtering `UserInvitation` results by their current state, in the format: `"state=='invited'"`.
Location: query
Type: string