memberships

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

Overview

Name	memberships
Type	Resource
Id	google.cloudidentity.memberships

Fields

Name	Datatype	Description
name	string	Output only. The resource name of the Membership. Shall be of the form groups/{group}/memberships/{membership}.
createTime	string	Output only. The time when the Membership was created.
deliverySetting	string	Output only. Delivery setting associated with the membership.
preferredMemberKey	object	A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional namespace or a user without a namespace. The combination of id and namespace must be unique; however, the same id can be used with different namespaces.
roles	array	The MembershipRoles that apply to the Membership. If unspecified, defaults to a single MembershipRole with name MEMBER. Must not contain duplicate MembershipRoles with the same name.
type	string	Output only. The type of the membership.
updateTime	string	Output only. The time when the Membership was last updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	groupsId, membershipsId	Retrieves a Membership.
list	SELECT	groupsId	Lists the Memberships within a Group.
create	INSERT	groupsId	Creates a Membership.
delete	DELETE	groupsId, membershipsId	Deletes a Membership.
check_transitive_membership	EXEC	groupsId	Check a potential member for membership in a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A member has membership to a group as long as there is a single viewable transitive membership between the group and the member. The actor must have view permissions to at least one transitive membership between the member and group.
lookup	EXEC	groupsId	Looks up the resource name of a Membership by its EntityKey.
modify_membership_roles	EXEC	groupsId, membershipsId	Modifies the MembershipRoles of a Membership.
search_direct_groups	EXEC	groupsId	Searches direct groups of a member.
search_transitive_groups	EXEC	groupsId	Search transitive groups of a member. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the member is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive group is any group that has a direct or indirect membership to the member. Actor must have view permissions all transitive groups.
search_transitive_memberships	EXEC	groupsId	Search transitive memberships of a group. Note: This feature is only available to Google Workspace Enterprise Standard, Enterprise Plus, and Enterprise for Education; and Cloud Identity Premium accounts. If the account of the group is not one of these, a 403 (PERMISSION_DENIED) HTTP status code will be returned. A transitive membership is any direct or indirect membership of a group. Actor must have view permissions to all transitive memberships.

SELECT examples

Lists the Memberships within a Group.

SELECT
name,
createTime,
deliverySetting,
preferredMemberKey,
roles,
type,
updateTime
FROM google.cloudidentity.memberships
WHERE groupsId = '{{ groupsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new memberships resource.

All Properties

/*+ create */
INSERT INTO google.cloudidentity.memberships (
groupsId,
preferredMemberKey,
roles
)
SELECT 
'{{ groupsId }}',
'{{ preferredMemberKey }}',
'{{ roles }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: preferredMemberKey
      value:
        - name: id
          value: string
        - name: namespace
          value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: roles
      value:
        - - name: name
            value: string
          - name: expiryDetail
            value:
              - name: expireTime
                value: string
          - name: restrictionEvaluations
            value:
              - name: memberRestrictionEvaluation
                value:
                  - name: state
                    value: string
    - name: type
      value: string
    - name: deliverySetting
      value: string

DELETE example

Deletes the specified memberships resource.

/*+ delete */
DELETE FROM google.cloudidentity.memberships
WHERE groupsId = '{{ groupsId }}'
AND membershipsId = '{{ membershipsId }}';