| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="cloudresourcemanager_v1.html">Google Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v1.organizations.html">organizations</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Fetches an Organization resource identified by the specified resource name.</p> |
| <p class="toc_element"> |
| <code><a href="#getIamPolicy">getIamPolicy(resource=None, body, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the access control policy for an Organization resource. May be empty</p> |
| <p class="toc_element"> |
| <code><a href="#search">search(body, x__xgafv=None)</a></code></p> |
| <p class="firstline">Searches Organization resources that are visible to the user and satisfy</p> |
| <p class="toc_element"> |
| <code><a href="#setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</a></code></p> |
| <p class="firstline">Sets the access control policy on an Organization resource. Replaces any</p> |
| <p class="toc_element"> |
| <code><a href="#testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns permissions that a caller has on the specified Organization.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Fetches an Organization resource identified by the specified resource name. |
| |
| Args: |
| name: string, The resource name of the Organization to fetch, e.g. "organizations/1234". (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The root node in the resource hierarchy to which a particular entity's |
| # (e.g., company) resources belong. |
| "owner": { # The entity that owns an Organization. The lifetime of the Organization and # The owner of this Organization. The owner should be specified on |
| # creation. Once set, it cannot be changed. |
| # This field is required. |
| # all of its descendants are bound to the `OrganizationOwner`. If the |
| # `OrganizationOwner` is deleted, the Organization and all its descendants will |
| # be deleted. |
| "directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API. |
| }, |
| "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. |
| # @OutputOnly |
| "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. |
| # Assigned by the server, set to the firm name of the Google For Work |
| # customer that owns this organization. |
| # @OutputOnly |
| "lifecycleState": "A String", # The organization's current lifecycle state. Assigned by the server. |
| # @OutputOnly |
| "name": "A String", # Output Only. The resource name of the organization. This is the |
| # organization's relative path in the API. Its format is |
| # "organizations/[organization_id]". For example, "organizations/1234". |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getIamPolicy">getIamPolicy(resource=None, body, x__xgafv=None)</code> |
| <pre>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". |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy is being requested. |
| `resource` is usually specified as a path. For example, a Project |
| resource is specified as `projects/{project}`. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # Request message for `GetIamPolicy` method. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Defines an Identity and Access Management (IAM) policy. It is used to |
| # specify access control policies for Cloud Platform resources. |
| # |
| # |
| # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of |
| # `members` to a `role`, where the members can be user accounts, Google groups, |
| # Google domains, and service accounts. A `role` is a named list of permissions |
| # defined by IAM. |
| # |
| # **Example** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/owner", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-other-app@appspot.gserviceaccount.com", |
| # ] |
| # }, |
| # { |
| # "role": "roles/viewer", |
| # "members": ["user:sean@example.com"] |
| # } |
| # ] |
| # } |
| # |
| # For a description of IAM and its features, see the |
| # [IAM developer's guide](https://cloud.google.com/iam). |
| "bindings": [ # Associates a list of `members` to a `role`. |
| # Multiple `bindings` must not be specified for the same `role`. |
| # `bindings` with no members will result in an error. |
| { # Associates `members` with a `role`. |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| # Required |
| "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| # `members` can have the following values: |
| # |
| # * `allUsers`: A special identifier that represents anyone who is |
| # on the internet; with or without a Google account. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `alice@gmail.com` or `joe@example.com`. |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `domain:{domain}`: A Google Apps domain name that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| }, |
| ], |
| "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| # prevent simultaneous updates of a policy from overwriting each other. |
| # It is strongly suggested that systems make use of the `etag` in the |
| # read-modify-write cycle to perform policy updates in order to avoid race |
| # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| # systems are expected to put that etag in the request to `setIamPolicy` to |
| # ensure that their change will be applied to the same version of the policy. |
| # |
| # If no `etag` is provided in the call to `setIamPolicy`, then the existing |
| # policy is overwritten blindly. |
| "version": 42, # Version of the `Policy`. The default version is 0. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="search">search(body, x__xgafv=None)</code> |
| <pre>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. |
| |
| Args: |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # The request sent to the `SearchOrganizations` method. |
| "filter": "A String", # An optional query string used to filter the Organizations to return in |
| # the response. Filter rules are case-insensitive. |
| # |
| # |
| # Organizations may be filtered by `owner.directoryCustomerId` or by |
| # `domain`, where the domain is a Google for Work domain, for example: |
| # |
| # |Filter|Description| |
| # |------|-----------| |
| # |owner.directorycustomerid:123456789|Organizations with |
| # `owner.directory_customer_id` equal to `123456789`.| |
| # |domain:google.com|Organizations corresponding to the domain `google.com`.| |
| # |
| # This field is optional. |
| "pageToken": "A String", # A pagination token returned from a previous call to `SearchOrganizations` |
| # that indicates from where listing should continue. |
| # This field is optional. |
| "pageSize": 42, # The maximum number of Organizations to return in the response. |
| # This field is optional. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # The response returned from the `SearchOrganizations` method. |
| "nextPageToken": "A String", # A pagination token to be used to retrieve the next page of results. If the |
| # result is too large to fit within the page size specified in the request, |
| # this field will be set with a token that can be used to fetch the next page |
| # of results. If this field is empty, it indicates that this response |
| # contains the last page of results. |
| "organizations": [ # The list of Organizations that matched the search query, possibly |
| # paginated. |
| { # The root node in the resource hierarchy to which a particular entity's |
| # (e.g., company) resources belong. |
| "owner": { # The entity that owns an Organization. The lifetime of the Organization and # The owner of this Organization. The owner should be specified on |
| # creation. Once set, it cannot be changed. |
| # This field is required. |
| # all of its descendants are bound to the `OrganizationOwner`. If the |
| # `OrganizationOwner` is deleted, the Organization and all its descendants will |
| # be deleted. |
| "directoryCustomerId": "A String", # The Google for Work customer id used in the Directory API. |
| }, |
| "creationTime": "A String", # Timestamp when the Organization was created. Assigned by the server. |
| # @OutputOnly |
| "displayName": "A String", # A friendly string to be used to refer to the Organization in the UI. |
| # Assigned by the server, set to the firm name of the Google For Work |
| # customer that owns this organization. |
| # @OutputOnly |
| "lifecycleState": "A String", # The organization's current lifecycle state. Assigned by the server. |
| # @OutputOnly |
| "name": "A String", # Output Only. The resource name of the organization. This is the |
| # organization's relative path in the API. Its format is |
| # "organizations/[organization_id]". For example, "organizations/1234". |
| }, |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="setIamPolicy">setIamPolicy(resource=None, body, x__xgafv=None)</code> |
| <pre>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". |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy is being specified. |
| `resource` is usually specified as a path. For example, a Project |
| resource is specified as `projects/{project}`. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # Request message for `SetIamPolicy` method. |
| "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to # REQUIRED: The complete policy to be applied to the `resource`. The size of |
| # the policy is limited to a few 10s of KB. An empty policy is a |
| # valid policy but certain Cloud Platform services (such as Projects) |
| # might reject them. |
| # specify access control policies for Cloud Platform resources. |
| # |
| # |
| # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of |
| # `members` to a `role`, where the members can be user accounts, Google groups, |
| # Google domains, and service accounts. A `role` is a named list of permissions |
| # defined by IAM. |
| # |
| # **Example** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/owner", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-other-app@appspot.gserviceaccount.com", |
| # ] |
| # }, |
| # { |
| # "role": "roles/viewer", |
| # "members": ["user:sean@example.com"] |
| # } |
| # ] |
| # } |
| # |
| # For a description of IAM and its features, see the |
| # [IAM developer's guide](https://cloud.google.com/iam). |
| "bindings": [ # Associates a list of `members` to a `role`. |
| # Multiple `bindings` must not be specified for the same `role`. |
| # `bindings` with no members will result in an error. |
| { # Associates `members` with a `role`. |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| # Required |
| "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| # `members` can have the following values: |
| # |
| # * `allUsers`: A special identifier that represents anyone who is |
| # on the internet; with or without a Google account. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `alice@gmail.com` or `joe@example.com`. |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `domain:{domain}`: A Google Apps domain name that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| }, |
| ], |
| "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| # prevent simultaneous updates of a policy from overwriting each other. |
| # It is strongly suggested that systems make use of the `etag` in the |
| # read-modify-write cycle to perform policy updates in order to avoid race |
| # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| # systems are expected to put that etag in the request to `setIamPolicy` to |
| # ensure that their change will be applied to the same version of the policy. |
| # |
| # If no `etag` is provided in the call to `setIamPolicy`, then the existing |
| # policy is overwritten blindly. |
| "version": 42, # Version of the `Policy`. The default version is 0. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Defines an Identity and Access Management (IAM) policy. It is used to |
| # specify access control policies for Cloud Platform resources. |
| # |
| # |
| # A `Policy` consists of a list of `bindings`. A `Binding` binds a list of |
| # `members` to a `role`, where the members can be user accounts, Google groups, |
| # Google domains, and service accounts. A `role` is a named list of permissions |
| # defined by IAM. |
| # |
| # **Example** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/owner", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-other-app@appspot.gserviceaccount.com", |
| # ] |
| # }, |
| # { |
| # "role": "roles/viewer", |
| # "members": ["user:sean@example.com"] |
| # } |
| # ] |
| # } |
| # |
| # For a description of IAM and its features, see the |
| # [IAM developer's guide](https://cloud.google.com/iam). |
| "bindings": [ # Associates a list of `members` to a `role`. |
| # Multiple `bindings` must not be specified for the same `role`. |
| # `bindings` with no members will result in an error. |
| { # Associates `members` with a `role`. |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| # Required |
| "members": [ # Specifies the identities requesting access for a Cloud Platform resource. |
| # `members` can have the following values: |
| # |
| # * `allUsers`: A special identifier that represents anyone who is |
| # on the internet; with or without a Google account. |
| # |
| # * `allAuthenticatedUsers`: A special identifier that represents anyone |
| # who is authenticated with a Google account or a service account. |
| # |
| # * `user:{emailid}`: An email address that represents a specific Google |
| # account. For example, `alice@gmail.com` or `joe@example.com`. |
| # |
| # |
| # * `serviceAccount:{emailid}`: An email address that represents a service |
| # account. For example, `my-other-app@appspot.gserviceaccount.com`. |
| # |
| # * `group:{emailid}`: An email address that represents a Google group. |
| # For example, `admins@example.com`. |
| # |
| # * `domain:{domain}`: A Google Apps domain name that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| }, |
| ], |
| "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help |
| # prevent simultaneous updates of a policy from overwriting each other. |
| # It is strongly suggested that systems make use of the `etag` in the |
| # read-modify-write cycle to perform policy updates in order to avoid race |
| # conditions: An `etag` is returned in the response to `getIamPolicy`, and |
| # systems are expected to put that etag in the request to `setIamPolicy` to |
| # ensure that their change will be applied to the same version of the policy. |
| # |
| # If no `etag` is provided in the call to `setIamPolicy`, then the existing |
| # policy is overwritten blindly. |
| "version": 42, # Version of the `Policy`. The default version is 0. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="testIamPermissions">testIamPermissions(resource=None, body, x__xgafv=None)</code> |
| <pre>Returns permissions that a caller has on the specified Organization. |
| The `resource` field should be the organization's resource name, |
| e.g. "organizations/123". |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy detail is being requested. |
| `resource` is usually specified as a path. For example, a Project |
| resource is specified as `projects/{project}`. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # Request message for `TestIamPermissions` method. |
| "permissions": [ # The set of permissions to check for the `resource`. Permissions with |
| # wildcards (such as '*' or 'storage.*') are not allowed. For more |
| # information see |
| # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). |
| "A String", |
| ], |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for `TestIamPermissions` method. |
| "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is |
| # allowed. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |