Admin SDK API . groups

Instance Methods

aliases()

Returns the aliases Resource.

close()

Close httplib2 connections.

delete(groupKey, x__xgafv=None)

Deletes a group.

get(groupKey, x__xgafv=None)

Retrieves a group's properties.

insert(body=None, x__xgafv=None)

Creates a group.

list(customer=None, domain=None, maxResults=None, orderBy=None, pageToken=None, query=None, sortOrder=None, userKey=None, x__xgafv=None)

Retrieves all groups of a domain or of a user given a userKey (paginated).

list_next()

Retrieves the next page of results.

patch(groupKey, body=None, x__xgafv=None)

Updates a group's properties. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).

update(groupKey, body=None, x__xgafv=None)

Updates a group's properties.

Method Details

close()
Close httplib2 connections.
delete(groupKey, x__xgafv=None)
Deletes a group.

Args:
  groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
get(groupKey, x__xgafv=None)
Retrieves a group's properties.

Args:
  groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).
  "adminCreated": True or False, # Read-only. Value is `true` if this group was created by an administrator rather than a user.
  "aliases": [ # Read-only. A list of a group's alias email addresses.
    "A String",
  ],
  "description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
  "directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.
  "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.
  "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`.
  "name": "A String", # The group's display name.
  "nonEditableAliases": [ # Read-only. A list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.
    "A String",
  ],
}
insert(body=None, x__xgafv=None)
Creates a group.

Args:
  body: object, The request body.
    The object takes the form of:

{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).
  "adminCreated": True or False, # Read-only. Value is `true` if this group was created by an administrator rather than a user.
  "aliases": [ # Read-only. A list of a group's alias email addresses.
    "A String",
  ],
  "description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
  "directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.
  "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.
  "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`.
  "name": "A String", # The group's display name.
  "nonEditableAliases": [ # Read-only. A list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).
  "adminCreated": True or False, # Read-only. Value is `true` if this group was created by an administrator rather than a user.
  "aliases": [ # Read-only. A list of a group's alias email addresses.
    "A String",
  ],
  "description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
  "directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.
  "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.
  "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`.
  "name": "A String", # The group's display name.
  "nonEditableAliases": [ # Read-only. A list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.
    "A String",
  ],
}
list(customer=None, domain=None, maxResults=None, orderBy=None, pageToken=None, query=None, sortOrder=None, userKey=None, x__xgafv=None)
Retrieves all groups of a domain or of a user given a userKey (paginated).

Args:
  customer: string, The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, fill in this field instead of `domain`. You can also use the `my_customer` alias to represent your account's `customerId`. The `customerId` is also returned as part of the [Users](/admin-sdk/directory/v1/reference/users) resource. Either the `customer` or the `domain` parameter must be provided.
  domain: string, The domain name. Use this field to get groups from only one domain. To return all domains for a customer account, use the `customer` query parameter instead.
  maxResults: integer, Maximum number of results to return. Max allowed value is 200.
  orderBy: string, Column to use for sorting results
    Allowed values
      email - Email of the group.
  pageToken: string, Token to specify next page in the list
  query: string, Query string search. Should be of the form "". Complete documentation is at https: //developers.google.com/admin-sdk/directory/v1/guides/search-groups
  sortOrder: string, Whether to return results in ascending or descending order. Only of use when orderBy is also used
    Allowed values
      ASCENDING - Ascending order.
      DESCENDING - Descending order.
  userKey: string, Email or immutable ID of the user if only those groups are to be listed, the given user is a member of. If it's an ID, it should match with the ID of the user object.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  "etag": "A String", # ETag of the resource.
  "groups": [ # List of group objects.
    { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).
      "adminCreated": True or False, # Read-only. Value is `true` if this group was created by an administrator rather than a user.
      "aliases": [ # Read-only. A list of a group's alias email addresses.
        "A String",
      ],
      "description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
      "directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.
      "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.
      "etag": "A String", # ETag of the resource.
      "id": "A String", # Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.
      "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`.
      "name": "A String", # The group's display name.
      "nonEditableAliases": [ # Read-only. A list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.
        "A String",
      ],
    },
  ],
  "kind": "admin#directory#groups", # Kind of resource this is.
  "nextPageToken": "A String", # Token used to access next page of this result.
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        
patch(groupKey, body=None, x__xgafv=None)
Updates a group's properties. This method supports [patch semantics](/admin-sdk/directory/v1/guides/performance#patch).

Args:
  groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).
  "adminCreated": True or False, # Read-only. Value is `true` if this group was created by an administrator rather than a user.
  "aliases": [ # Read-only. A list of a group's alias email addresses.
    "A String",
  ],
  "description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
  "directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.
  "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.
  "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`.
  "name": "A String", # The group's display name.
  "nonEditableAliases": [ # Read-only. A list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).
  "adminCreated": True or False, # Read-only. Value is `true` if this group was created by an administrator rather than a user.
  "aliases": [ # Read-only. A list of a group's alias email addresses.
    "A String",
  ],
  "description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
  "directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.
  "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.
  "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`.
  "name": "A String", # The group's display name.
  "nonEditableAliases": [ # Read-only. A list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.
    "A String",
  ],
}
update(groupKey, body=None, x__xgafv=None)
Updates a group's properties.

Args:
  groupKey: string, Identifies the group in the API request. The value can be the group's email address, group alias, or the unique group ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).
  "adminCreated": True or False, # Read-only. Value is `true` if this group was created by an administrator rather than a user.
  "aliases": [ # Read-only. A list of a group's alias email addresses.
    "A String",
  ],
  "description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
  "directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.
  "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.
  "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`.
  "name": "A String", # The group's display name.
  "nonEditableAliases": [ # Read-only. A list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.
    "A String",
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Google Groups provide your users the ability to send messages to groups of people using the group's email address. For more information about common tasks, see the [Developer's Guide](/admin-sdk/directory/v1/guides/manage-groups).
  "adminCreated": True or False, # Read-only. Value is `true` if this group was created by an administrator rather than a user.
  "aliases": [ # Read-only. A list of a group's alias email addresses.
    "A String",
  ],
  "description": "A String", # An extended description to help users determine the purpose of a group. For example, you can include information about who should join the group, the types of messages to send to the group, links to FAQs about the group, or related groups. Maximum length is `4,096` characters.
  "directMembersCount": "A String", # The number of users that are direct members of the group. If a group is a member (child) of this group (the parent), members of the child group are not counted in the `directMembersCount` property of the parent group.
  "email": "A String", # The group's email address. If your account has multiple domains, select the appropriate domain for the email address. The `email` must be unique. This property is required when creating a group. Group email addresses are subject to the same character usage rules as usernames, see the [help center](https://support.google.com/a/answer/9193374) for details.
  "etag": "A String", # ETag of the resource.
  "id": "A String", # Read-only. The unique ID of a group. A group `id` can be used as a group request URI's `groupKey`.
  "kind": "admin#directory#group", # The type of the API resource. For Groups resources, the value is `admin#directory#group`.
  "name": "A String", # The group's display name.
  "nonEditableAliases": [ # Read-only. A list of the group's non-editable alias email addresses that are outside of the account's primary domain or subdomains. These are functioning email addresses used by the group. This is a read-only property returned in the API's response for a group. If edited in a group's POST or PUT request, the edit is ignored by the API service.
    "A String",
  ],
}