View Source GoogleApi.IAM.V1.Api.Roles (google_api_iam v0.42.0)
API calls for all endpoints tagged Roles
.
Summary
Functions
Gets the definition of a Role.
Lists every predefined Role that IAM supports, or every custom role that is defined for an organization or project.
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.
Functions
Link to this function
iam_roles_get(connection, roles_id, optional_params \\ [], opts \\ [])
View Source@spec iam_roles_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the definition of a Role.
Parameters
-
connection
(type:GoogleApi.IAM.V1.Connection.t
) - Connection to server -
roles_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
@spec iam_roles_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.IAM.V1.Model.ListRolesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists every predefined Role that IAM supports, or every custom role that is defined for an organization or project.
Parameters
-
connection
(type:GoogleApi.IAM.V1.Connection.t
) - Connection to server -
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"). -
:pageSize
(type:integer()
) - Optional limit on the number of roles to include in the response. The default is 300, and the maximum is 1,000. -
: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
Link to this function
iam_roles_query_grantable_roles(connection, optional_params \\ [], opts \\ [])
View Source@spec iam_roles_query_grantable_roles(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.IAM.V1.Model.QueryGrantableRolesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
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.
Parameters
-
connection
(type:GoogleApi.IAM.V1.Connection.t
) - Connection to server -
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"). -
: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