Skip to main content

memberships

Creates, updates, deletes, gets or lists a memberships resource.

Overview

Namememberships
TypeResource
Idgoogle.recaptchaenterprise.memberships

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringRequired. Identifier. The resource name for this membership in the format projects/{project}/relatedaccountgroups/{relatedaccountgroup}/memberships/{membership}.
accountIdstringThe unique stable account identifier of the member. The identifier corresponds to an account_id provided in a previous CreateAssessment or AnnotateAssessment call.
hashedAccountIdstring (byte)Deprecated: use account_id instead. The unique stable hashed account identifier of the member. The identifier corresponds to a hashed_account_id provided in a previous CreateAssessment or AnnotateAssessment call.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectprojectsId, relatedaccountgroupsIdpageSize, pageTokenGet memberships in a group of related accounts.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
projectsIdstring
relatedaccountgroupsIdstring
pageSizeinteger (int32)
pageTokenstring

SELECT examples

Get memberships in a group of related accounts.

SELECT
name,
accountId,
hashedAccountId
FROM google.recaptchaenterprise.memberships
WHERE projectsId = '{{ projectsId }}' -- required
AND relatedaccountgroupsId = '{{ relatedaccountgroupsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';