com.google.api.services.directory

Class Directory.Roles

java.lang.Object

com.google.api.services.directory.Directory.Roles

Enclosing class:

Directory

public class Directory.Roles
extends Object

The "roles" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Directory.Roles.Delete
class	Directory.Roles.Get
class	Directory.Roles.Insert
class	Directory.Roles.List
class	Directory.Roles.Patch
class	Directory.Roles.Update

Constructor Summary

Constructors

Constructor and Description
Roles()

Method Summary

Modifier and Type	Method and Description
Directory.Roles.Delete	delete(String customer, String roleId) Deletes a role.
Directory.Roles.Get	get(String customer, String roleId) Retrieves a role.
Directory.Roles.Insert	insert(String customer, Role content) Creates a role.
Directory.Roles.List	list(String customer) Retrieves a paginated list of all the roles in a domain.
Directory.Roles.Patch	patch(String customer, String roleId, Role content) Patches a role.
Directory.Roles.Update	update(String customer, String roleId, Role content) Updates a role.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Roles

public Roles()

Method Detail

delete

public Directory.Roles.Delete delete(String customer,
                                     String roleId)
                              throws IOException

Deletes a role. Create a request for the method "roles.delete". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

customer - Immutable ID of the Google Workspace account.

roleId - Immutable ID of the role.

Returns:

the request

Throws:

IOException

get

public Directory.Roles.Get get(String customer,
                               String roleId)
                        throws IOException

Retrieves a role. Create a request for the method "roles.get". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.

roleId - Immutable ID of the role.

Returns:

the request

Throws:

IOException

insert

public Directory.Roles.Insert insert(String customer,
                                     Role content)
                              throws IOException

Creates a role. Create a request for the method "roles.insert". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

customer - Immutable ID of the Google Workspace account.

content - the Role

Returns:

the request

Throws:

IOException

list

public Directory.Roles.List list(String customer)
                          throws IOException

Retrieves a paginated list of all the roles in a domain. Create a request for the method "roles.list". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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](/admin-sdk/directory/v1/reference/users) resource. You must provide either the `customer` or the `domain` parameter.

Returns:

the request

Throws:

IOException

patch

public Directory.Roles.Patch patch(String customer,
                                   String roleId,
                                   Role content)
                            throws IOException

Patches a role. Create a request for the method "roles.patch". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

customer - Immutable ID of the Google Workspace account.

roleId - Immutable ID of the role.

content - the Role

Returns:

the request

Throws:

IOException

update

public Directory.Roles.Update update(String customer,
                                     String roleId,
                                     Role content)
                              throws IOException

Updates a role. Create a request for the method "roles.update". This request holds the parameters needed by the admin server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

customer - Immutable ID of the Google Workspace account.

roleId - Immutable ID of the role.

content - the Role

Returns:

the request

Throws:

IOException