GoogleApi.AccessContextManager.V1.Api.Organizations (google_api_access_context_manager v0.28.0)

View Source

API calls for all endpoints tagged Organizations.

Summary

Functions

accesscontextmanager_organizations_gcp_user_access_bindings_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a GcpUserAccessBinding. If the client specifies a name, the server ignores it. Fails if a resource already exists with the same group_key. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time.

accesscontextmanager_organizations_gcp_user_access_bindings_delete(connection, name, optional_params \\ [], opts \\ [])

Deletes a GcpUserAccessBinding. Completion of this long-running operation does not necessarily signify that the binding deletion is deployed onto all affected users, which may take more time.

accesscontextmanager_organizations_gcp_user_access_bindings_get(connection, name, optional_params \\ [], opts \\ [])

Gets the GcpUserAccessBinding with the given name.

accesscontextmanager_organizations_gcp_user_access_bindings_list(connection, parent, optional_params \\ [], opts \\ [])

Lists all GcpUserAccessBindings for a Google Cloud organization.

accesscontextmanager_organizations_gcp_user_access_bindings_patch(connection, name, optional_params \\ [], opts \\ [])

Updates a GcpUserAccessBinding. Completion of this long-running operation does not necessarily signify that the changed binding is deployed onto all affected users, which may take more time.

Functions

accesscontextmanager_organizations_gcp_user_access_bindings_create(connection, parent, optional_params \\ [], opts \\ [])

@spec accesscontextmanager_organizations_gcp_user_access_bindings_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a GcpUserAccessBinding. If the client specifies a name, the server ignores it. Fails if a resource already exists with the same group_key. Completion of this long-running operation does not necessarily signify that the new binding is deployed onto all affected users, which may take more time.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Example: "organizations/256"
  • 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.AccessContextManager.V1.Model.GcpUserAccessBinding.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.Operation{}} on success
  • {:error, info} on failure

accesscontextmanager_organizations_gcp_user_access_bindings_delete(connection, name, optional_params \\ [], opts \\ [])

@spec accesscontextmanager_organizations_gcp_user_access_bindings_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a GcpUserAccessBinding. Completion of this long-running operation does not necessarily signify that the binding deletion is deployed onto all affected users, which may take more time.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Example: "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N"
  • 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.AccessContextManager.V1.Model.Operation{}} on success
  • {:error, info} on failure

accesscontextmanager_organizations_gcp_user_access_bindings_get(connection, name, optional_params \\ [], opts \\ [])

@spec accesscontextmanager_organizations_gcp_user_access_bindings_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.GcpUserAccessBinding.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the GcpUserAccessBinding with the given name.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Example: "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N"
  • 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.AccessContextManager.V1.Model.GcpUserAccessBinding{}} on success
  • {:error, info} on failure

accesscontextmanager_organizations_gcp_user_access_bindings_list(connection, parent, optional_params \\ [], opts \\ [])

@spec accesscontextmanager_organizations_gcp_user_access_bindings_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AccessContextManager.V1.Model.ListGcpUserAccessBindingsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all GcpUserAccessBindings for a Google Cloud organization.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Example: "organizations/256"
  • 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. Maximum number of items to return. The server may return fewer items. If left blank, the server may return any number of items.
    • :pageToken (type: String.t) - Optional. If left blank, returns the first page. To enumerate all items, use the next_page_token from your previous list operation.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.ListGcpUserAccessBindingsResponse{}} on success
  • {:error, info} on failure

accesscontextmanager_organizations_gcp_user_access_bindings_patch(connection, name, optional_params \\ [], opts \\ [])

@spec accesscontextmanager_organizations_gcp_user_access_bindings_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AccessContextManager.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a GcpUserAccessBinding. Completion of this long-running operation does not necessarily signify that the changed binding is deployed onto all affected users, which may take more time.

Parameters

  • connection (type: GoogleApi.AccessContextManager.V1.Connection.t) - Connection to server
  • name (type: String.t) - Immutable. Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by RFC 3986 Section 2.3). Should not be specified by the client during creation. Example: "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N"
  • 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").
    • :append (type: boolean()) - Optional. This field controls whether or not certain repeated settings in the update request overwrite or append to existing settings on the binding. If true, then append. Otherwise overwrite. So far, only scoped_access_settings with reauth_settings supports appending. Global access_levels, access_levels in scoped_access_settings, dry_run_access_levels, reauth_settings, and session_settings are not compatible with append functionality, and the request will return an error if append=true when these settings are in the update_mask. The request will also return an error if append=true when "scoped_access_settings" is not set in the update_mask.
    • :updateMask (type: String.t) - Required. Only the fields specified in this mask are updated. Because name and group_key cannot be changed, update_mask is required and may only contain the following fields: access_levels, dry_run_access_levels, reauth_settings session_settings, scoped_access_settings. update_mask { paths: "access_levels" }
    • :body (type: GoogleApi.AccessContextManager.V1.Model.GcpUserAccessBinding.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AccessContextManager.V1.Model.Operation{}} on success
  • {:error, info} on failure