1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Directory
  7. \
  8. Resource
  9. \
  10. RoleAssignments

RoleAssignments

class RoleAssignments extends Resource (View source)

The "roleAssignments" collection of methods.

Typical usage is:

 $adminService = new Google\Service\Directory(...);
 $roleAssignments = $adminService->roleAssignments;

Methods

delete(string $customer, string $roleAssignmentId, array $optParams = [])

Deletes a role assignment. (roleAssignments.delete)

RoleAssignment
get(string $customer, string $roleAssignmentId, array $optParams = [])

Retrieves a role assignment. (roleAssignments.get)

RoleAssignment
insert(string $customer, RoleAssignment $postBody, array $optParams = [])

Creates a role assignment. (roleAssignments.insert)

RoleAssignments
listRoleAssignments(string $customer, array $optParams = [])

Retrieves a paginated list of all roleAssignments.

Details

at line 41
delete(string $customer, string $roleAssignmentId, array $optParams = [])

Deletes a role assignment. (roleAssignments.delete)

Parameters

string $customer

Immutable ID of the Google Workspace account.
string $roleAssignmentId

Immutable ID of the role assignment.
array $optParams

Optional parameters.

Exceptions

Exception

at line 62
RoleAssignment get(string $customer, string $roleAssignmentId, array $optParams = [])

Retrieves a role assignment. (roleAssignments.get)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use 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 resource. You must provide either the customer or the domain parameter.
string $roleAssignmentId

Immutable ID of the role assignment.
array $optParams

Optional parameters.

Return Value

RoleAssignment

Exceptions

Exception

at line 77
RoleAssignment insert(string $customer, RoleAssignment $postBody, array $optParams = [])

Creates a role assignment. (roleAssignments.insert)

Parameters

string $customer

Immutable ID of the Google Workspace account.
RoleAssignment $postBody
array $optParams

Optional parameters.

Return Value

RoleAssignment

Exceptions

Exception

at line 110
RoleAssignments listRoleAssignments(string $customer, array $optParams = [])

Retrieves a paginated list of all roleAssignments.

(roleAssignments.listRoleAssignments)

Parameters

string $customer

The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use 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 resource. You must provide either the customer or the domain parameter.
array $optParams

Optional parameters.

Return Value

RoleAssignments

Exceptions

Exception