public sealed class ListRolesRequest : IMessage<ListRolesRequest>, IEquatable<ListRolesRequest>, IDeepCloneable<ListRolesRequest>, IBufferMessage, IMessage, IPageRequest
Reference documentation and code samples for the Identity and Access Management (IAM) v1 API class ListRolesRequest.
The request to get all roles defined under a resource.
Implements
IMessage<ListRolesRequest>, IEquatable<ListRolesRequest>, IDeepCloneable<ListRolesRequest>, IBufferMessage, IMessage, IPageRequestNamespace
Google.Cloud.Iam.Admin.V1Assembly
Google.Cloud.Iam.Admin.V1.dll
Constructors
ListRolesRequest()
public ListRolesRequest()
ListRolesRequest(ListRolesRequest)
public ListRolesRequest(ListRolesRequest other)
Parameter | |
---|---|
Name | Description |
other | ListRolesRequest |
Properties
PageSize
public int PageSize { get; set; }
Optional limit on the number of roles to include in the response.
The default is 300, and the maximum is 1,000.
Property Value | |
---|---|
Type | Description |
Int32 |
PageToken
public string PageToken { get; set; }
Optional pagination token returned in an earlier ListRolesResponse.
Property Value | |
---|---|
Type | Description |
String |
Parent
public string Parent { get; set; }
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 Cloud 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.
Property Value | |
---|---|
Type | Description |
String |
ParentAsResourceName
public IResourceName ParentAsResourceName { get; set; }
IResourceName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
IResourceName |
ShowDeleted
public bool ShowDeleted { get; set; }
Include Roles that have been deleted.
Property Value | |
---|---|
Type | Description |
Boolean |
View
public RoleView View { get; set; }
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.
Property Value | |
---|---|
Type | Description |
RoleView |