Class RolesResource.ListRequest

Lists every predefined Role that IAM supports, or every custom role that is defined for an organization or project.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ListRolesResponse>
IamBaseServiceRequest<ListRolesResponse>
RolesResource.ListRequest
Implements
Inherited Members
Namespace: Google.Apis.Iam.v1
Assembly: Google.Apis.Iam.v1.dll
Syntax
public class RolesResource.ListRequest : IamBaseServiceRequest<ListRolesResponse>, IClientServiceRequest<ListRolesResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService)

Constructs a new List request.

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

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

PageSize

Optional limit on the number of roles to include in the response. The default is 300, and the maximum is 1,000.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

Optional pagination token returned in an earlier ListRolesResponse.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Parent

The parent parameter's value depends on the target resource for the request, namely roles, projects, or organizations. Each resource type's parent value format is described below: * roles.list: An empty string. This method doesn't require a resource; it simply returns all predefined roles in IAM. Example request URL: https://iam.googleapis.com/v1/roles * projects.roles.list: projects/{PROJECT_ID}. This method lists all project-level custom roles. Example request URL: https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles * organizations.roles.list: organizations/{ORGANIZATION_ID}. This method lists all organization-level custom roles. Example request URL: https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.

Declaration
[RequestParameter("parent", RequestParameterType.Query)]
public virtual string Parent { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

ShowDeleted

Include Roles that have been deleted.

Declaration
[RequestParameter("showDeleted", RequestParameterType.Query)]
public virtual bool? ShowDeleted { get; set; }
Property Value
Type Description
bool?

View

Optional view for the returned Role objects. When FULL is specified, the includedPermissions field is returned, which includes a list of all permissions in the role. The default value is BASIC, which does not return the includedPermissions field.

Declaration
[RequestParameter("view", RequestParameterType.Query)]
public virtual RolesResource.ListRequest.ViewEnum? View { get; set; }
Property Value
Type Description
RolesResource.ListRequest.ViewEnum?

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements