google_api_cloud_resource_manager v0.7.1 GoogleApi.CloudResourceManager.V1.Api.Organizations View Source
API calls for all endpoints tagged Organizations
.
Link to this section Summary
Functions
Clears a Policy
from a resource.
Fetches an Organization resource identified by the specified resource name.
Gets the effective Policy
on a resource. This is the result of merging
Policies
in the resource hierarchy. The returned Policy
will not have
an etag
set because it is a computed Policy
across multiple resources.
Subtrees of Resource Manager resource hierarchy with 'under:' prefix will
not be expanded.
Gets the access control policy for an Organization resource. May be empty
if no such policy or resource exists. The resource
field should be the
organization's resource name, e.g. "organizations/123".
Gets a Policy
on a resource.
Lists Constraints
that could be applied on the specified resource.
Lists all the Policies
set for a particular resource.
Searches Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the results.
Sets the access control policy on an Organization resource. Replaces any
existing policy. The resource
field should be the organization's resource
name, e.g. "organizations/123".
Updates the specified Policy
on the resource. Creates a new Policy
for
that Constraint
on the resource if one does not exist.
Returns permissions that a caller has on the specified Organization.
The resource
field should be the organization's resource name,
e.g. "organizations/123".
Link to this section Functions
cloudresourcemanager_organizations_clear_org_policy(connection, organizations_id, optional_params \\ [], opts \\ []) View Source
Clears a Policy
from a resource.
Parameters
- connection (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
- organizations_id (String.t): Part of
resource
. Name of the resource for thePolicy
to clear. optional_params (keyword()): [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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudResourceManager.V1.Model.ClearOrgPolicyRequest.t):
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.Empty{}} on success {:error, info} on failure
cloudresourcemanager_organizations_get(connection, organizations_id, optional_params \\ [], opts \\ []) View Source
Fetches an Organization resource identified by the specified resource name.
Parameters
- connection (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
- organizations_id (String.t): Part of
name
. The resource name of the Organization to fetch. This is the organization's relative path in the API, formatted as "organizations/[organizationId]". For example, "organizations/1234". optional_params (keyword()): [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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.Organization{}} on success {:error, info} on failure
cloudresourcemanager_organizations_get_effective_org_policy(connection, organizations_id, optional_params \\ [], opts \\ []) View Source
Gets the effective Policy
on a resource. This is the result of merging
Policies
in the resource hierarchy. The returned Policy
will not have
an etag
set because it is a computed Policy
across multiple resources.
Subtrees of Resource Manager resource hierarchy with 'under:' prefix will
not be expanded.
Parameters
- connection (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
- organizations_id (String.t): Part of
resource
. The name of the resource to start computing the effectivePolicy
. optional_params (keyword()): [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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudResourceManager.V1.Model.GetEffectiveOrgPolicyRequest.t):
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.OrgPolicy{}} on success {:error, info} on failure
cloudresourcemanager_organizations_get_iam_policy(connection, organizations_id, optional_params \\ [], opts \\ []) View Source
Gets the access control policy for an Organization resource. May be empty
if no such policy or resource exists. The resource
field should be the
organization's resource name, e.g. "organizations/123".
Authorization requires the Google IAM permission
resourcemanager.organizations.getIamPolicy
on the specified organization
Parameters
- connection (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
- organizations_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. optional_params (keyword()): [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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudResourceManager.V1.Model.GetIamPolicyRequest.t):
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.Policy{}} on success {:error, info} on failure
cloudresourcemanager_organizations_get_org_policy(connection, organizations_id, optional_params \\ [], opts \\ []) View Source
Gets a Policy
on a resource.
If no Policy
is set on the resource, a Policy
is returned with default
values including POLICY_TYPE_NOT_SET
for the policy_type oneof
. The
etag
value can be used with SetOrgPolicy()
to create or update a
Policy
during read-modify-write.
Parameters
- connection (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
- organizations_id (String.t): Part of
resource
. Name of the resource thePolicy
is set on. optional_params (keyword()): [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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudResourceManager.V1.Model.GetOrgPolicyRequest.t):
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.OrgPolicy{}} on success {:error, info} on failure
cloudresourcemanager_organizations_list_available_org_policy_constraints(connection, organizations_id, optional_params \\ [], opts \\ []) View Source
Lists Constraints
that could be applied on the specified resource.
Parameters
- connection (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
- organizations_id (String.t): Part of
resource
. Name of the resource to listConstraints
for. optional_params (keyword()): [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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudResourceManager.V1.Model.ListAvailableOrgPolicyConstraintsRequest.t):
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.ListAvailableOrgPolicyConstraintsResponse{}} on success {:error, info} on failure
cloudresourcemanager_organizations_list_org_policies(connection, organizations_id, optional_params \\ [], opts \\ []) View Source
Lists all the Policies
set for a particular resource.
Parameters
- connection (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
- organizations_id (String.t): Part of
resource
. Name of the resource to list Policies for. optional_params (keyword()): [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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudResourceManager.V1.Model.ListOrgPoliciesRequest.t):
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.ListOrgPoliciesResponse{}} on success {:error, info} on failure
cloudresourcemanager_organizations_search(connection, optional_params \\ [], opts \\ []) View Source
Searches Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the results.
Search will only return organizations on which the user has the permission
resourcemanager.organizations.get
Parameters
- connection (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
optional_params (keyword()): [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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudResourceManager.V1.Model.SearchOrganizationsRequest.t):
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.SearchOrganizationsResponse{}} on success {:error, info} on failure
cloudresourcemanager_organizations_set_iam_policy(connection, organizations_id, optional_params \\ [], opts \\ []) View Source
Sets the access control policy on an Organization resource. Replaces any
existing policy. The resource
field should be the organization's resource
name, e.g. "organizations/123".
Authorization requires the Google IAM permission
resourcemanager.organizations.setIamPolicy
on the specified organization
Parameters
- connection (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
- organizations_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. optional_params (keyword()): [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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudResourceManager.V1.Model.SetIamPolicyRequest.t):
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.Policy{}} on success {:error, info} on failure
cloudresourcemanager_organizations_set_org_policy(connection, organizations_id, optional_params \\ [], opts \\ []) View Source
Updates the specified Policy
on the resource. Creates a new Policy
for
that Constraint
on the resource if one does not exist.
Not supplying an etag
on the request Policy
results in an unconditional
write of the Policy
.
Parameters
- connection (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
- organizations_id (String.t): Part of
resource
. Resource name of the resource to attach thePolicy
. optional_params (keyword()): [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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudResourceManager.V1.Model.SetOrgPolicyRequest.t):
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.OrgPolicy{}} on success {:error, info} on failure
cloudresourcemanager_organizations_test_iam_permissions(connection, organizations_id, optional_params \\ [], opts \\ []) View Source
Returns permissions that a caller has on the specified Organization.
The resource
field should be the organization's resource name,
e.g. "organizations/123".
There are no permissions required for making this API call.
Parameters
- connection (GoogleApi.CloudResourceManager.V1.Connection): Connection to server
- organizations_id (String.t): Part of
resource
. REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. optional_params (keyword()): [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.
- :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
- :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
- :body (GoogleApi.CloudResourceManager.V1.Model.TestIamPermissionsRequest.t):
Returns
{:ok, %GoogleApi.CloudResourceManager.V1.Model.TestIamPermissionsResponse{}} on success {:error, info} on failure