Admin SDK API . roleAssignments

close()

Close httplib2 connections.

delete(customer, roleAssignmentId, x__xgafv=None)

Deletes a role assignment.

Args:
  customer: string, Immutable ID of the Google Workspace 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)

Retrieves a role assignment.

Args:
  customer: string, Immutable ID of the Google Workspace 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:

    { # Defines an assignment of a role.
  "assignedTo": "A String", # The unique ID of the user this role is assigned to.
  "etag": "A String", # ETag of the resource.
  "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always `admin#directory#roleAssignment`.
  "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.
  "roleAssignmentId": "A String", # ID of this roleAssignment.
  "roleId": "A String", # The ID of the role that is assigned.
  "scopeType": "A String", # The scope in which this role is assigned.
}

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

Creates a role assignment.

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

{ # Defines an assignment of a role.
  "assignedTo": "A String", # The unique ID of the user this role is assigned to.
  "etag": "A String", # ETag of the resource.
  "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always `admin#directory#roleAssignment`.
  "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.
  "roleAssignmentId": "A String", # ID of this roleAssignment.
  "roleId": "A String", # The ID of the role that is assigned.
  "scopeType": "A String", # The scope in which this role is assigned.
}

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

Returns:
  An object of the form:

    { # Defines an assignment of a role.
  "assignedTo": "A String", # The unique ID of the user this role is assigned to.
  "etag": "A String", # ETag of the resource.
  "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always `admin#directory#roleAssignment`.
  "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.
  "roleAssignmentId": "A String", # ID of this roleAssignment.
  "roleId": "A String", # The ID of the role that is assigned.
  "scopeType": "A String", # The scope in which this role is assigned.
}

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

Retrieves a paginated list of all roleAssignments.

Args:
  customer: string, Immutable ID of the Google Workspace account. (required)
  maxResults: integer, Maximum number of results to return.
  pageToken: string, Token to specify the next page in the list.
  roleId: string, Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.
  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:

    {
  "etag": "A String", # ETag of the resource.
  "items": [ # A list of RoleAssignment resources.
    { # Defines an assignment of a role.
      "assignedTo": "A String", # The unique ID of the user this role is assigned to.
      "etag": "A String", # ETag of the resource.
      "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always `admin#directory#roleAssignment`.
      "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.
      "roleAssignmentId": "A String", # ID of this roleAssignment.
      "roleId": "A String", # The ID of the role that is assigned.
      "scopeType": "A String", # The scope in which this role is assigned.
    },
  ],
  "kind": "admin#directory#roleAssignments", # The type of the API resource. This is always `admin#directory#roleAssignments`.
  "nextPageToken": "A String",
}

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.