Admin SDK . roleAssignments

Instance Methods

close()

Close httplib2 connections.

delete(customer, roleAssignmentId, x__xgafv=None)

Deletes a role assignment.

get(customer, roleAssignmentId, x__xgafv=None)

Retrieve a role assignment.

insert(customer, body=None, x__xgafv=None)

Creates a role assignment.

list(customer, roleId=None, pageToken=None, maxResults=None, userKey=None, x__xgafv=None)

Retrieves a paginated list of all roleAssignments.

list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
delete(customer, roleAssignmentId, x__xgafv=None)
Deletes a role assignment.

Args:
  customer: string, Immutable ID of the G Suite account. (required)
  roleAssignmentId: string, Immutable ID of the role assignment. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
get(customer, roleAssignmentId, x__xgafv=None)
Retrieve a role assignment.

Args:
  customer: string, Immutable ID of the G Suite account. (required)
  roleAssignmentId: string, Immutable ID of the role assignment. (required)
  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.
    "roleId": "A String", # The ID of the role that is assigned.
    "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
    "assignedTo": "A String", # The unique ID of the user this role is assigned to.
    "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
    "roleAssignmentId": "A String", # ID of this roleAssignment.
    "scopeType": "A String", # The scope in which this role is assigned. Possible values are: - CUSTOMER - ORG_UNIT
  }
insert(customer, body=None, x__xgafv=None)
Creates a role assignment.

Args:
  customer: string, Immutable ID of the G Suite account. (required)
  body: object, The request body.
    The object takes the form of:

{
  "etag": "A String", # ETag of the resource.
  "roleId": "A String", # The ID of the role that is assigned.
  "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
  "assignedTo": "A String", # The unique ID of the user this role is assigned to.
  "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
  "roleAssignmentId": "A String", # ID of this roleAssignment.
  "scopeType": "A String", # The scope in which this role is assigned. Possible values are: - CUSTOMER - ORG_UNIT
}

  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.
    "roleId": "A String", # The ID of the role that is assigned.
    "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
    "assignedTo": "A String", # The unique ID of the user this role is assigned to.
    "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
    "roleAssignmentId": "A String", # ID of this roleAssignment.
    "scopeType": "A String", # The scope in which this role is assigned. Possible values are: - CUSTOMER - ORG_UNIT
  }
list(customer, roleId=None, pageToken=None, maxResults=None, userKey=None, x__xgafv=None)
Retrieves a paginated list of all roleAssignments.

Args:
  customer: string, Immutable ID of the G Suite account. (required)
  roleId: string, Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.
  pageToken: string, Token to specify the next page in the list.
  maxResults: integer, Maximum number of results to return.
  userKey: string, The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "items": [ # A list of RoleAssignment resources.
      {
        "etag": "A String", # ETag of the resource.
        "roleId": "A String", # The ID of the role that is assigned.
        "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
        "assignedTo": "A String", # The unique ID of the user this role is assigned to.
        "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
        "roleAssignmentId": "A String", # ID of this roleAssignment.
        "scopeType": "A String", # The scope in which this role is assigned. Possible values are: - CUSTOMER - ORG_UNIT
      },
    ],
    "nextPageToken": "A String",
    "etag": "A String", # ETag of the resource.
    "kind": "admin#directory#roleAssignments", # The type of the API resource. This is always admin#directory#roleAssignments .
  }
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.