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

Roles

class Roles extends Resource (View source)

The "roles" collection of methods.

Typical usage is:

 $iamService = new Google\Service\Iam(...);
 $roles = $iamService->roles;

Methods

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

Gets the definition of a Role. (roles.get)

ListRolesResponse
listRoles(array $optParams = [])

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

QueryGrantableRolesResponse
queryGrantableRoles(QueryGrantableRolesRequest $postBody, array $optParams = [])

Lists roles that can be granted on a Google Cloud resource. A role is grantable if the IAM policy for the resource can contain bindings to the role. (roles.queryGrantableRoles)

Details

at line 65
Role get(string $name, array $optParams = [])

Gets the definition of a Role. (roles.get)

Parameters

string $name

The name parameter's value depends on the target resource for the request, namely roles, projects, or organizations. Each resource type's name value format is described below: roles.get(): roles/{ROLE_NAME}. This method returns results from all predefined roles in Cloud IAM. Example request URL: https://iam.googleapis.com/v1/roles/{ROLE_NAME} projects.roles.get(): projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}. This method returns only custom roles that have been created at the project level. Example request URL: https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}

  • organizations.roles.get(): organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}. This method returns only custom roles that have been created at the organization level. Example request URL: https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ ROLE_ID} Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID.
array $optParams

Optional parameters.

Return Value

Role

at line 110
ListRolesResponse listRoles(array $optParams = [])

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

Parameters

array $optParams

Optional parameters.

Return Value

ListRolesResponse

at line 125
QueryGrantableRolesResponse queryGrantableRoles(QueryGrantableRolesRequest $postBody, array $optParams = [])

Lists roles that can be granted on a Google Cloud resource. A role is grantable if the IAM policy for the resource can contain bindings to the role. (roles.queryGrantableRoles)

Parameters

QueryGrantableRolesRequest $postBody
array $optParams

Optional parameters.

Return Value

QueryGrantableRolesResponse