google_api_iam v0.1.0 GoogleApi.IAM.V1.Api.Organizations View Source

API calls for all endpoints tagged Organizations.

Link to this section Summary

Functions

Soft deletes a role. The role is suspended and cannot be used to create new IAM Policy Bindings. The Role will not be included in `ListRoles()` unless `show_deleted` is set in the `ListRolesRequest`. The Role contains the deleted boolean set. Existing Bindings remains, but are inactive. The Role can be undeleted within 7 days. After 7 days the Role is deleted and all Bindings associated with the role are removed

Undelete a Role, bringing it back in its previous state

Link to this section Functions

Link to this function iam_organizations_roles_create(connection, organizations_id, opts \\ []) View Source
iam_organizations_roles_create(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:error, Tesla.Env.t()}

Creates a new Role.

Parameters

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

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

Returns

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

Link to this function iam_organizations_roles_delete(connection, organizations_id, roles_id, opts \\ []) View Source
iam_organizations_roles_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:error, Tesla.Env.t()}

Soft deletes a role. The role is suspended and cannot be used to create new IAM Policy Bindings. The Role will not be included in `ListRoles()` unless `show_deleted` is set in the `ListRolesRequest`. The Role contains the deleted boolean set. Existing Bindings remains, but are inactive. The Role can be undeleted within 7 days. After 7 days the Role is deleted and all Bindings associated with the role are removed.

Parameters

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

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

Returns

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

Link to this function iam_organizations_roles_get(connection, organizations_id, roles_id, opts \\ []) View Source
iam_organizations_roles_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:error, Tesla.Env.t()}

Gets a Role definition.

Parameters

  • connection (GoogleApi.IAM.V1.Connection): Connection to server
  • organizations_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}`
  • roles_id (String.t): Part of `name`. See documentation of `organizationsId`.
  • opts (KeywordList): [optional] Optional parameters

    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :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_organizations_roles_list(connection, organizations_id, opts \\ []) View Source
iam_organizations_roles_list(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, GoogleApi.IAM.V1.Model.ListRolesResponse.t()} | {:error, Tesla.Env.t()}

Lists the Roles defined on a resource.

Parameters

  • connection (GoogleApi.IAM.V1.Connection): Connection to server
  • organizations_id (String.t): Part of `parent`. 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}`
  • opts (KeywordList): [optional] Optional parameters

    • :callback (String.t): JSONP
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :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.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :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.
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :showDeleted (boolean()): Include Roles that have been deleted.
    • :pageToken (String.t): Optional pagination token returned in an earlier ListRolesResponse.
    • :pageSize (integer()): Optional limit on the number of roles to include in the response.
    • :view (String.t): Optional view for the returned Role objects.

Returns

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

Link to this function iam_organizations_roles_patch(connection, organizations_id, roles_id, opts \\ []) View Source
iam_organizations_roles_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:error, Tesla.Env.t()}

Updates a Role definition.

Parameters

  • connection (GoogleApi.IAM.V1.Connection): Connection to server
  • organizations_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}`
  • roles_id (String.t): Part of `name`. See documentation of `organizationsId`.
  • opts (KeywordList): [optional] Optional parameters

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

Returns

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

Link to this function iam_organizations_roles_undelete(connection, organizations_id, roles_id, opts \\ []) View Source
iam_organizations_roles_undelete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, GoogleApi.IAM.V1.Model.Role.t()} | {:error, Tesla.Env.t()}

Undelete a Role, bringing it back in its previous state.

Parameters

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

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

Returns

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