members

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

Overview

Name	members
Type	Resource
Id	googleadmin.directory.members

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
id	string	The unique ID of the group member. A member id can be used as a member request URI's memberKey.
delivery_settings	string	Defines mail delivery preferences of member. This field is only supported by insert, update, and get methods.
email	string	The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The email must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
etag	string	ETag of the resource.
kind	string	The type of the API resource. For Members resources, the value is admin#directory#member. (default: admin#directory#member)
role	string	The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. For more information about a member's role, see the administration help center.
status	string	Status of member (Immutable)
type	string	The type of group member.

list

Successful response

Name	Datatype	Description
id	string	The unique ID of the group member. A member id can be used as a member request URI's memberKey.
delivery_settings	string	Defines mail delivery preferences of member. This field is only supported by insert, update, and get methods.
email	string	The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The email must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
etag	string	ETag of the resource.
kind	string	The type of the API resource. For Members resources, the value is admin#directory#member. (default: admin#directory#member)
role	string	The member's role in a group. The API returns an error for cycles in group memberships. For example, if group1 is a member of group2, group2 cannot be a member of group1. For more information about a member's role, see the administration help center.
status	string	Status of member (Immutable)
type	string	The type of group member.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	groupKey, memberKey		Retrieves a group member's properties.
list	select	groupKey	includeDerivedMembership, maxResults, pageToken, roles	Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see Troubleshoot error codes.
insert	insert	groupKey		Adds a user to the specified group.
patch	update	groupKey, memberKey		Updates the membership properties of a user in the specified group. This method supports patch semantics.
update	replace	groupKey, memberKey		Updates the membership of a user in the specified group.
delete	delete	groupKey, memberKey		Removes a member from a group.
has_member	exec	groupKey, memberKey		Checks whether the given user is a member of the group. Membership can be direct or nested, but if nested, the memberKey and groupKey must be entities in the same domain or an Invalid input error is returned. To check for nested memberships that include entities outside of the group's domain, use the checkTransitiveMembership() method in the Cloud Identity Groups API.

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.

Name	Datatype	Description
groupKey	string
memberKey	string
includeDerivedMembership	boolean
maxResults	integer (int32)
pageToken	string
roles	string

SELECT examples

get

Retrieves a group member's properties.

SELECT
id,
delivery_settings,
email,
etag,
kind,
role,
status,
type
FROM googleadmin.directory.members
WHERE groupKey = '{{ groupKey }}' -- required
AND memberKey = '{{ memberKey }}' -- required;

list

Retrieves a paginated list of all members in a group. This method times out after 60 minutes. For more information, see Troubleshoot error codes.

SELECT
id,
delivery_settings,
email,
etag,
kind,
role,
status,
type
FROM googleadmin.directory.members
WHERE groupKey = '{{ groupKey }}' -- required
AND includeDerivedMembership = '{{ includeDerivedMembership }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND roles = '{{ roles }}';

INSERT examples

insert

Adds a user to the specified group.

INSERT INTO googleadmin.directory.members (
data__kind,
data__email,
data__role,
data__etag,
data__type,
data__status,
data__delivery_settings,
data__id,
groupKey
)
SELECT 
'{{ kind }}',
'{{ email }}',
'{{ role }}',
'{{ etag }}',
'{{ type }}',
'{{ status }}',
'{{ delivery_settings }}',
'{{ id }}',
'{{ groupKey }}'
RETURNING
id,
delivery_settings,
email,
etag,
kind,
role,
status,
type
;

Manifest

# Description fields are for documentation purposes
- name: members
  props:
    - name: groupKey
      value: string
      description: Required parameter for the members resource.
    - name: kind
      value: string
      description: >
        The type of the API resource. For Members resources, the value is `admin#directory#member`.
        
      default: admin#directory#member
    - name: email
      value: string
      description: >
        The member's email address. A member can be a user or another group. This property is required when adding a member to a group. The `email` must be unique and cannot be an alias of another group. If the email address is changed, the API automatically reflects the email address changes.
        
    - name: role
      value: string
      description: >
        The member's role in a group. The API returns an error for cycles in group memberships. For example, if `group1` is a member of `group2`, `group2` cannot be a member of `group1`. For more information about a member's role, see the [administration help center](https://support.google.com/a/answer/167094).
        
    - name: etag
      value: string
      description: >
        ETag of the resource.
        
    - name: type
      value: string
      description: >
        The type of group member.
        
    - name: status
      value: string
      description: >
        Status of member (Immutable)
        
    - name: delivery_settings
      value: string
      description: >
        Defines mail delivery preferences of member. This field is only supported by `insert`, `update`, and `get` methods.
        
    - name: id
      value: string
      description: >
        The unique ID of the group member. A member `id` can be used as a member request URI's `memberKey`.
        

UPDATE examples

patch

Updates the membership properties of a user in the specified group. This method supports patch semantics.

UPDATE googleadmin.directory.members
SET 
data__kind = '{{ kind }}',
data__email = '{{ email }}',
data__role = '{{ role }}',
data__etag = '{{ etag }}',
data__type = '{{ type }}',
data__status = '{{ status }}',
data__delivery_settings = '{{ delivery_settings }}',
data__id = '{{ id }}'
WHERE 
groupKey = '{{ groupKey }}' --required
AND memberKey = '{{ memberKey }}' --required
RETURNING
id,
delivery_settings,
email,
etag,
kind,
role,
status,
type;

REPLACE examples

update

Updates the membership of a user in the specified group.

REPLACE googleadmin.directory.members
SET 
data__kind = '{{ kind }}',
data__email = '{{ email }}',
data__role = '{{ role }}',
data__etag = '{{ etag }}',
data__type = '{{ type }}',
data__status = '{{ status }}',
data__delivery_settings = '{{ delivery_settings }}',
data__id = '{{ id }}'
WHERE 
groupKey = '{{ groupKey }}' --required
AND memberKey = '{{ memberKey }}' --required
RETURNING
id,
delivery_settings,
email,
etag,
kind,
role,
status,
type;

DELETE examples

delete

Removes a member from a group.

DELETE FROM googleadmin.directory.members
WHERE groupKey = '{{ groupKey }}' --required
AND memberKey = '{{ memberKey }}' --required;

Lifecycle Methods

has_member

Checks whether the given user is a member of the group. Membership can be direct or nested, but if nested, the memberKey and groupKey must be entities in the same domain or an Invalid input error is returned. To check for nested memberships that include entities outside of the group's domain, use the checkTransitiveMembership() method in the Cloud Identity Groups API.

EXEC googleadmin.directory.members.has_member 
@groupKey='{{ groupKey }}' --required, 
@memberKey='{{ memberKey }}' --required;