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

Roles

class Roles extends Resource (View source)

The "roles" collection of methods.

Typical usage is:

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

Methods

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

Deletes a role. (roles.delete)

Role
get(string $customer, string $roleId, array $optParams = [])

Retrieves a role. (roles.get)

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

Creates a role. (roles.insert)

Roles
listRoles(string $customer, array $optParams = [])

Retrieves a paginated list of all the roles in a domain. (roles.listRoles)

Role
patch(string $customer, string $roleId, Role $postBody, array $optParams = [])

Patches a role. (roles.patch)

Role
update(string $customer, string $roleId, Role $postBody, array $optParams = [])

Updates a role. (roles.update)

Details

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

Deletes a role. (roles.delete)

Parameters

string $customer

Immutable ID of the Google Workspace account.
string $roleId

Immutable ID of the role.
array $optParams

Optional parameters.

Exceptions

Exception

at line 62
Role get(string $customer, string $roleId, array $optParams = [])

Retrieves a role. (roles.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 $roleId

Immutable ID of the role.
array $optParams

Optional parameters.

Return Value

Role

Exceptions

Exception

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

Creates a role. (roles.insert)

Parameters

string $customer

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

Optional parameters.

Return Value

Role

Exceptions

Exception

at line 100
Roles listRoles(string $customer, array $optParams = [])

Retrieves a paginated list of all the roles in a domain. (roles.listRoles)

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

Roles

Exceptions

Exception

at line 116
Role patch(string $customer, string $roleId, Role $postBody, array $optParams = [])

Patches a role. (roles.patch)

Parameters

string $customer

Immutable ID of the Google Workspace account.
string $roleId

Immutable ID of the role.
Role $postBody
array $optParams

Optional parameters.

Return Value

Role

Exceptions

Exception

at line 132
Role update(string $customer, string $roleId, Role $postBody, array $optParams = [])

Updates a role. (roles.update)

Parameters

string $customer

Immutable ID of the Google Workspace account.
string $roleId

Immutable ID of the role.
Role $postBody
array $optParams

Optional parameters.

Return Value

Role

Exceptions

Exception