google_api_iam v0.5.0 GoogleApi.IAM.V1.Api.Roles View Source

API calls for all endpoints tagged Roles.

Link to this section Summary

Functions

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

Link to this function

iam_roles_get(connection, roles_id, optional_params \\ [], opts \\ []) View Source

Gets a Role definition.

Parameters

  • connection (GoogleApi.IAM.V1.Connection): Connection to server
  • roles_id (String.t): Part of `name`. The resource name of the role in one of the following formats: `roles/{ROLE_NAME}` `organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}` `projects/{PROJECT_ID}/roles/{ROLE_NAME}`
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").

Returns

{:ok, %GoogleApi.IAM.V1.Model.Role{}} on success {:error, info} on failure

Link to this function

iam_roles_list(connection, optional_params \\ [], opts \\ []) View Source

Lists the Roles defined on a resource.

Parameters

  • connection (GoogleApi.IAM.V1.Connection): Connection to server
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :pageSize (integer()): Optional limit on the number of roles to include in the response.
    • :pageToken (String.t): Optional pagination token returned in an earlier ListRolesResponse.
    • :parent (String.t): The resource name of the parent resource in one of the following formats: `` (empty string) -- this refers to curated roles. `organizations/{ORGANIZATION_ID}` `projects/{PROJECT_ID}`
    • :showDeleted (boolean()): Include Roles that have been deleted.
    • :view (String.t): 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.

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

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 (GoogleApi.IAM.V1.Connection): Connection to server
  • optional_params (KeywordList): [optional] Optional parameters

    • :$.xgafv (String.t): V1 error format.
    • :access_token (String.t): OAuth access token.
    • :alt (String.t): Data format for response.
    • :callback (String.t): JSONP
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :key (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 (String.t): OAuth 2.0 token for the current user.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :quotaUser (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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :body (QueryGrantableRolesRequest):

Returns

{:ok, %GoogleApi.IAM.V1.Model.QueryGrantableRolesResponse{}} on success {:error, info} on failure