google_api_iam v0.15.0 GoogleApi.IAM.V1.Api.Roles View Source
API calls for all endpoints tagged Roles
.
Link to this section Summary
Functions
Gets a Role definition.
Lists the Roles defined on a resource.
Queries roles that can be granted on a particular resource. A role is grantable if it can be used as the role in a binding for a policy for that resource.
Link to this section Functions
iam_roles_get(connection, roles_id, optional_params \\ [], opts \\ [])
View Sourceiam_roles_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:error, Tesla.Env.t()}
Gets a Role definition.
Parameters
connection
(type:GoogleApi.IAM.V1.Connection.t
) - Connection to serverroles_id
(type:String.t
) - Part ofname
. Thename
parameter's value depends on the target resource for the request, namelyroles
,projects
, ororganizations
. Each resource type'sname
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.
optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAM.V1.Model.Role{}}
on success{:error, info}
on failure
iam_roles_list(connection, optional_params \\ [], opts \\ [])
View Sourceiam_roles_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.IAM.V1.Model.ListRolesResponse.t()} | {:error, Tesla.Env.t()}
Lists the Roles defined on a resource.
Parameters
connection
(type:GoogleApi.IAM.V1.Connection.t
) - Connection to serveroptional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:pageSize
(type:integer()
) - Optional limit on the number of roles to include in the response.:pageToken
(type:String.t
) - Optional pagination token returned in an earlier ListRolesResponse.:parent
(type:String.t
) - Theparent
parameter's value depends on the target resource for the request, namelyroles
,projects
, ororganizations
. Each resource type'sparent
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.
:showDeleted
(type:boolean()
) - Include Roles that have been deleted.:view
(type:String.t
) - Optional view for the returned Role objects. WhenFULL
is specified, theincludedPermissions
field is returned, which includes a list of all permissions in the role. The default value isBASIC
, which does not return theincludedPermissions
field.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAM.V1.Model.ListRolesResponse{}}
on success{:error, info}
on failure
iam_roles_query_grantable_roles(connection, optional_params \\ [], opts \\ [])
View Sourceiam_roles_query_grantable_roles(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.IAM.V1.Model.QueryGrantableRolesResponse.t()} | {:error, Tesla.Env.t()}
Queries roles that can be granted on a particular resource. A role is grantable if it can be used as the role in a binding for a policy for that resource.
Parameters
connection
(type:GoogleApi.IAM.V1.Connection.t
) - Connection to serveroptional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.IAM.V1.Model.QueryGrantableRolesRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAM.V1.Model.QueryGrantableRolesResponse{}}
on success{:error, info}
on failure