Show / Hide Table of Contents

Class RolesResource

The "roles" collection of methods.

Inheritance
object
RolesResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Admin.Directory.directory_v1
Assembly: Google.Apis.Admin.Directory.directory_v1.dll
Syntax
public class RolesResource

Constructors

RolesResource(IClientService)

Constructs a new resource.

Declaration
public RolesResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Delete(string, string)

Deletes a role.

Declaration
public virtual RolesResource.DeleteRequest Delete(string customer, string roleId)
Parameters
Type Name Description
string customer

Immutable ID of the Google Workspace account.

string roleId

Immutable ID of the role.

Returns
Type Description
RolesResource.DeleteRequest

Get(string, string)

Retrieves a role.

Declaration
public virtual RolesResource.GetRequest Get(string customer, string roleId)
Parameters
Type Name Description
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.

Returns
Type Description
RolesResource.GetRequest

Insert(Role, string)

Creates a role.

Declaration
public virtual RolesResource.InsertRequest Insert(Role body, string customer)
Parameters
Type Name Description
Role body

The body of the request.

string customer

Immutable ID of the Google Workspace account.

Returns
Type Description
RolesResource.InsertRequest

List(string)

Retrieves a paginated list of all the roles in a domain.

Declaration
public virtual RolesResource.ListRequest List(string customer)
Parameters
Type Name Description
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.

Returns
Type Description
RolesResource.ListRequest

Patch(Role, string, string)

Patches a role.

Declaration
public virtual RolesResource.PatchRequest Patch(Role body, string customer, string roleId)
Parameters
Type Name Description
Role body

The body of the request.

string customer

Immutable ID of the Google Workspace account.

string roleId

Immutable ID of the role.

Returns
Type Description
RolesResource.PatchRequest

Update(Role, string, string)

Updates a role.

Declaration
public virtual RolesResource.UpdateRequest Update(Role body, string customer, string roleId)
Parameters
Type Name Description
Role body

The body of the request.

string customer

Immutable ID of the Google Workspace account.

string roleId

Immutable ID of the role.

Returns
Type Description
RolesResource.UpdateRequest
In this article
Back to top Generated by DocFX