Admin SDK . groups

Instance Methods

aliases()

Returns the aliases Resource.

close()

Close httplib2 connections.

delete(groupKey, x__xgafv=None)

Delete Group

get(groupKey, x__xgafv=None)

Retrieve Group

insert(body=None, x__xgafv=None)

Create Group

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

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

list_next(previous_request, previous_response)

Retrieves the next page of results.

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

Patch Groups via Apiary Patch Orchestration

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

Update Group

Method Details

close()
Close httplib2 connections.
delete(groupKey, x__xgafv=None)
Delete Group

Args:
  groupKey: string, Email or immutable ID of the group (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
get(groupKey, x__xgafv=None)
Retrieve Group

Args:
  groupKey: string, Email or immutable ID of the group (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
      "nonEditableAliases": [ # List of non editable aliases (Read-only)
        "A String",
      ],
      "name": "A String", # Group name
      "aliases": [ # List of aliases (Read-only)
        "A String",
      ],
      "kind": "admin#directory#group", # Kind of resource this is.
      "id": "A String", # Unique identifier of Group (Read-only)
      "email": "A String", # Email of Group
      "description": "A String", # Description of the group
      "directMembersCount": "A String", # Group direct members count
      "adminCreated": True or False, # Is the group created by admin (Read-only) *
      "etag": "A String", # ETag of the resource.
    }
insert(body=None, x__xgafv=None)
Create Group

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

{ # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
    "nonEditableAliases": [ # List of non editable aliases (Read-only)
      "A String",
    ],
    "name": "A String", # Group name
    "aliases": [ # List of aliases (Read-only)
      "A String",
    ],
    "kind": "admin#directory#group", # Kind of resource this is.
    "id": "A String", # Unique identifier of Group (Read-only)
    "email": "A String", # Email of Group
    "description": "A String", # Description of the group
    "directMembersCount": "A String", # Group direct members count
    "adminCreated": True or False, # Is the group created by admin (Read-only) *
    "etag": "A String", # ETag of the resource.
  }

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

Returns:
  An object of the form:

    { # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
      "nonEditableAliases": [ # List of non editable aliases (Read-only)
        "A String",
      ],
      "name": "A String", # Group name
      "aliases": [ # List of aliases (Read-only)
        "A String",
      ],
      "kind": "admin#directory#group", # Kind of resource this is.
      "id": "A String", # Unique identifier of Group (Read-only)
      "email": "A String", # Email of Group
      "description": "A String", # Description of the group
      "directMembersCount": "A String", # Group direct members count
      "adminCreated": True or False, # Is the group created by admin (Read-only) *
      "etag": "A String", # ETag of the resource.
    }
list(query=None, domain=None, orderBy=None, sortOrder=None, maxResults=None, customer=None, pageToken=None, userKey=None, x__xgafv=None)
Retrieve all groups of a domain or of a user given a userKey (paginated)

Args:
  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
  domain: string, Name of the domain. Fill this field to get groups from only this domain. To return all groups in a multi-domain fill customer field instead.
  orderBy: string, Column to use for sorting results
    Allowed values
      orderByUndefined - 
      email - Email of the group.
  sortOrder: string, Whether to return results in ascending or descending order. Only of use when orderBy is also used
    Allowed values
      SORT_ORDER_UNDEFINED - 
      ASCENDING - Ascending order.
      DESCENDING - Descending order.
  maxResults: integer, Maximum number of results to return. Max allowed value is 200.
  customer: string, Immutable ID of the G Suite account. In case of multi-domain, to fetch all groups for a customer, fill this field instead of domain.
  pageToken: string, Token to specify next page in the list
  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:

    { # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
    "groups": [ # List of group objects.
      { # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
          "nonEditableAliases": [ # List of non editable aliases (Read-only)
            "A String",
          ],
          "name": "A String", # Group name
          "aliases": [ # List of aliases (Read-only)
            "A String",
          ],
          "kind": "admin#directory#group", # Kind of resource this is.
          "id": "A String", # Unique identifier of Group (Read-only)
          "email": "A String", # Email of Group
          "description": "A String", # Description of the group
          "directMembersCount": "A String", # Group direct members count
          "adminCreated": True or False, # Is the group created by admin (Read-only) *
          "etag": "A String", # ETag of the resource.
        },
    ],
    "etag": "A String", # ETag of the resource.
    "kind": "admin#directory#groups", # Kind of resource this is.
    "nextPageToken": "A String", # Token used to access next page of this result.
  }
list_next(previous_request, previous_response)
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)
Patch Groups via Apiary Patch Orchestration

Args:
  groupKey: string, Email or immutable ID of the group. If ID, it should match with id of group object (required)
  body: object, The request body.
    The object takes the form of:

{ # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
    "nonEditableAliases": [ # List of non editable aliases (Read-only)
      "A String",
    ],
    "name": "A String", # Group name
    "aliases": [ # List of aliases (Read-only)
      "A String",
    ],
    "kind": "admin#directory#group", # Kind of resource this is.
    "id": "A String", # Unique identifier of Group (Read-only)
    "email": "A String", # Email of Group
    "description": "A String", # Description of the group
    "directMembersCount": "A String", # Group direct members count
    "adminCreated": True or False, # Is the group created by admin (Read-only) *
    "etag": "A String", # ETag of the resource.
  }

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

Returns:
  An object of the form:

    { # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
      "nonEditableAliases": [ # List of non editable aliases (Read-only)
        "A String",
      ],
      "name": "A String", # Group name
      "aliases": [ # List of aliases (Read-only)
        "A String",
      ],
      "kind": "admin#directory#group", # Kind of resource this is.
      "id": "A String", # Unique identifier of Group (Read-only)
      "email": "A String", # Email of Group
      "description": "A String", # Description of the group
      "directMembersCount": "A String", # Group direct members count
      "adminCreated": True or False, # Is the group created by admin (Read-only) *
      "etag": "A String", # ETag of the resource.
    }
update(groupKey, body=None, x__xgafv=None)
Update Group

Args:
  groupKey: string, Email or immutable ID of the group. If ID, it should match with id of group object (required)
  body: object, The request body.
    The object takes the form of:

{ # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
    "nonEditableAliases": [ # List of non editable aliases (Read-only)
      "A String",
    ],
    "name": "A String", # Group name
    "aliases": [ # List of aliases (Read-only)
      "A String",
    ],
    "kind": "admin#directory#group", # Kind of resource this is.
    "id": "A String", # Unique identifier of Group (Read-only)
    "email": "A String", # Email of Group
    "description": "A String", # Description of the group
    "directMembersCount": "A String", # Group direct members count
    "adminCreated": True or False, # Is the group created by admin (Read-only) *
    "etag": "A String", # ETag of the resource.
  }

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

Returns:
  An object of the form:

    { # STEPLADDER: Generated unstable field number for field 'kind'. (See http://go/stepladder-help#fieldNumber) STEPLADDER: Generated unstable field number for field 'etag'. (See http://go/stepladder-help#fieldNumber)
      "nonEditableAliases": [ # List of non editable aliases (Read-only)
        "A String",
      ],
      "name": "A String", # Group name
      "aliases": [ # List of aliases (Read-only)
        "A String",
      ],
      "kind": "admin#directory#group", # Kind of resource this is.
      "id": "A String", # Unique identifier of Group (Read-only)
      "email": "A String", # Email of Group
      "description": "A String", # Description of the group
      "directMembersCount": "A String", # Group direct members count
      "adminCreated": True or False, # Is the group created by admin (Read-only) *
      "etag": "A String", # ETag of the resource.
    }