| <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="managedidentities_v1alpha1.html">Managed Service for Microsoft Active Directory API</a> . <a href="managedidentities_v1alpha1.projects.html">projects</a> . <a href="managedidentities_v1alpha1.projects.locations.html">locations</a> . <a href="managedidentities_v1alpha1.projects.locations.global_.html">global_</a> . <a href="managedidentities_v1alpha1.projects.locations.global_.domains.html">domains</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#attachTrust">attachTrust(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Adds AD trust in a given domain.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, domainName=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a Microsoft AD Domain in a given project.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes identified domain.</p> |
| <p class="toc_element"> |
| <code><a href="#detachTrust">detachTrust(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Removes identified trust.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets details of a single Domain.</p> |
| <p class="toc_element"> |
| <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the access control policy for a resource.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, orderBy=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists Domains in a given project.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the metadata and configuration of a specified domain.</p> |
| <p class="toc_element"> |
| <code><a href="#reconfigureTrust">reconfigureTrust(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates the dns conditional forwarder.</p> |
| <p class="toc_element"> |
| <code><a href="#resetAdminPassword">resetAdminPassword(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Resets managed identities admin password identified by</p> |
| <p class="toc_element"> |
| <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Sets the access control policy on the specified resource. Replaces any</p> |
| <p class="toc_element"> |
| <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Returns permissions that a caller has on the specified resource.</p> |
| <p class="toc_element"> |
| <code><a href="#validateTrust">validateTrust(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Validate the trust state</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="attachTrust">attachTrust(name, body=None, x__xgafv=None)</code> |
| <pre>Adds AD trust in a given domain. |
| Operation<response: google.protobuf.Empty> |
| |
| Args: |
| name: string, The resource domain name, project name and location using the form: |
| `projects/{project_id}/locations/global/domains/{domain_name}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "trust": { # Represents a relationship between two domains which makes it possible # The domain trust resource. |
| # for users in one domain to be authenticated by a dc in another domain. |
| # Refer |
| # https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc731335(v%3dws.10) |
| "selectiveAuthentication": True or False, # The trust authentication type which decides whether the trusted side has |
| # forest/domain wide access or selective access to approved set of resources. |
| "stateDescription": "A String", # Output only. Additional information about the current state of this |
| # trust, if available. |
| "targetDnsIpAddresses": [ # The target dns server ip addresses which can resolve the remote domain |
| # involved in trust. |
| "A String", |
| ], |
| "trustHandshakeSecret": "A String", # Input only, and will not be stored. The trust secret used for handshake |
| # with target domain. |
| "trustType": "A String", # The type of trust represented by the trust resource. |
| "trustDirection": "A String", # The trust direction decides the current domain is trusted, trusting or |
| # both. |
| "state": "A String", # Output only. The current state of this trust. |
| "lastKnownTrustConnectedHeartbeatTime": "A String", # Output only. The last heartbeat time when the trust was known to be |
| # connected. |
| "createTime": "A String", # Output only. The time the instance was created. |
| "updateTime": "A String", # Output only. Last update time. |
| "targetDomainName": "A String", # The fully qualified target domain name which will be in trust with current |
| # domain. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a |
| # network API call. |
| "name": "A String", # The server-assigned name, which is only unique within the same service that |
| # originally returns it. If you use the default HTTP mapping, the |
| # `name` should be a resource name ending with `operations/{unique_id}`. |
| "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically |
| # contains progress information and common metadata such as create time. |
| # Some services might not provide such metadata. Any method that returns a |
| # long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| # If `true`, the operation is completed, and either `error` or `response` is |
| # available. |
| "response": { # The normal response of the operation in case of success. If the original |
| # method returns no data on success, such as `Delete`, the response is |
| # `google.protobuf.Empty`. If the original method is standard |
| # `Get`/`Create`/`Update`, the response should be the resource. For other |
| # methods, the response should have the type `XxxResponse`, where `Xxx` |
| # is the original method name. For example, if the original method name |
| # is `TakeSnapshot()`, the inferred response type is |
| # `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, domainName=None, x__xgafv=None)</code> |
| <pre>Creates a Microsoft AD Domain in a given project. |
| Operation<response: google.protobuf.Empty> |
| |
| Args: |
| parent: string, Resource project name and location using the form: |
| `projects/{project_id}/locations/global` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "createTime": "A String", # Output only. The time the instance was created. Synthetic field is |
| # populated automatically by CCFE. go/ccfe-synthetic-field-user-guide |
| "statusMessage": "A String", # Output only. Additional information about the current status of this |
| # domain, if available. |
| "updateTime": "A String", # Output only. Last update time. Synthetic field is populated automatically |
| # by CCFE. |
| "locations": [ # Required. Locations where domain needs to be provisioned. |
| # regions |
| # e.g. us-west1 or us-east4 |
| # Service supports up to 4 locations at once. Each location will use a /26 |
| # block. |
| "A String", |
| ], |
| "managedIdentitiesAdminName": "A String", # Optional. Name of customer-visible admin used to perform Active Directory |
| # operations. If not specified `setupadmin` would be used. |
| "reservedIpRange": "A String", # Required. The CIDR range of internal addresses that are reserved for this |
| # domain. Reserved networks must be /24 or larger. Ranges must be |
| # unique and non-overlapping with existing subnets in |
| # [Domain].[authorized_networks]. |
| "labels": { # Optional. Resource labels to represent user provided metadata |
| "a_key": "A String", |
| }, |
| "authorizedNetworks": [ # Optional. The full names of the Google Compute Engine |
| # [networks](/compute/docs/networks-and-firewalls#networks) to which the |
| # instance is connected. Network can be added using UpdateDomain later. |
| # Domain is only available on network part of authorized_networks. |
| # Caller needs to make sure that CIDR subnets do not overlap between |
| # networks, else domain creation will fail. |
| "A String", |
| ], |
| "name": "A String", # Output only. Unique name of the domain in this scope including projects and |
| # location using the form: |
| # `projects/{project_id}/locations/global/domains/{domain_name}`. |
| "fqdn": "A String", # Output only. Fully-qualified domain name of the exposed domain used by |
| # clients to connect to the service. Similar to what would be chosen for an |
| # Active Directory that is set up on an internal network. |
| "trusts": [ # Output only. The current trusts associated with the domain. |
| { # Represents a relationship between two domains which makes it possible |
| # for users in one domain to be authenticated by a dc in another domain. |
| # Refer |
| # https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc731335(v%3dws.10) |
| "selectiveAuthentication": True or False, # The trust authentication type which decides whether the trusted side has |
| # forest/domain wide access or selective access to approved set of resources. |
| "stateDescription": "A String", # Output only. Additional information about the current state of this |
| # trust, if available. |
| "targetDnsIpAddresses": [ # The target dns server ip addresses which can resolve the remote domain |
| # involved in trust. |
| "A String", |
| ], |
| "trustHandshakeSecret": "A String", # Input only, and will not be stored. The trust secret used for handshake |
| # with target domain. |
| "trustType": "A String", # The type of trust represented by the trust resource. |
| "trustDirection": "A String", # The trust direction decides the current domain is trusted, trusting or |
| # both. |
| "state": "A String", # Output only. The current state of this trust. |
| "lastKnownTrustConnectedHeartbeatTime": "A String", # Output only. The last heartbeat time when the trust was known to be |
| # connected. |
| "createTime": "A String", # Output only. The time the instance was created. |
| "updateTime": "A String", # Output only. Last update time. |
| "targetDomainName": "A String", # The fully qualified target domain name which will be in trust with current |
| # domain. |
| }, |
| ], |
| "state": "A String", # Output only. The current state of this domain. |
| } |
| |
| domainName: string, The fully qualified domain name. |
| e.g. mydomain.myorganization.com, with the following restrictions: |
| |
| * Must contain only lowercase letters, numbers, periods and hyphens. |
| * Must start with a letter. |
| * Must contain between 2-64 characters. |
| * Must end with a number or a letter. |
| * Must not start with period. |
| * Must be unique within the project. |
| * First segement length (mydomain form example above) shouldn't exceed |
| 15 chars. |
| * The last segment cannot be fully numeric. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a |
| # network API call. |
| "name": "A String", # The server-assigned name, which is only unique within the same service that |
| # originally returns it. If you use the default HTTP mapping, the |
| # `name` should be a resource name ending with `operations/{unique_id}`. |
| "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically |
| # contains progress information and common metadata such as create time. |
| # Some services might not provide such metadata. Any method that returns a |
| # long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| # If `true`, the operation is completed, and either `error` or `response` is |
| # available. |
| "response": { # The normal response of the operation in case of success. If the original |
| # method returns no data on success, such as `Delete`, the response is |
| # `google.protobuf.Empty`. If the original method is standard |
| # `Get`/`Create`/`Update`, the response should be the resource. For other |
| # methods, the response should have the type `XxxResponse`, where `Xxx` |
| # is the original method name. For example, if the original method name |
| # is `TakeSnapshot()`, the inferred response type is |
| # `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes identified domain. |
| Operation<response: google.protobuf.Empty> |
| |
| Args: |
| name: string, Domain resource name using the form: |
| `projects/{project_id}/locations/global/domains/{domain_name}` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a |
| # network API call. |
| "name": "A String", # The server-assigned name, which is only unique within the same service that |
| # originally returns it. If you use the default HTTP mapping, the |
| # `name` should be a resource name ending with `operations/{unique_id}`. |
| "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically |
| # contains progress information and common metadata such as create time. |
| # Some services might not provide such metadata. Any method that returns a |
| # long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| # If `true`, the operation is completed, and either `error` or `response` is |
| # available. |
| "response": { # The normal response of the operation in case of success. If the original |
| # method returns no data on success, such as `Delete`, the response is |
| # `google.protobuf.Empty`. If the original method is standard |
| # `Get`/`Create`/`Update`, the response should be the resource. For other |
| # methods, the response should have the type `XxxResponse`, where `Xxx` |
| # is the original method name. For example, if the original method name |
| # is `TakeSnapshot()`, the inferred response type is |
| # `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="detachTrust">detachTrust(name, body=None, x__xgafv=None)</code> |
| <pre>Removes identified trust. |
| Operation<response: google.protobuf.Empty> |
| |
| Args: |
| name: string, The resource domain name, project name, and location using the form: |
| `projects/{project_id}/locations/global/domains/{domain_name}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "trust": { # Represents a relationship between two domains which makes it possible # The domain trust resource to removed. |
| # for users in one domain to be authenticated by a dc in another domain. |
| # Refer |
| # https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc731335(v%3dws.10) |
| "selectiveAuthentication": True or False, # The trust authentication type which decides whether the trusted side has |
| # forest/domain wide access or selective access to approved set of resources. |
| "stateDescription": "A String", # Output only. Additional information about the current state of this |
| # trust, if available. |
| "targetDnsIpAddresses": [ # The target dns server ip addresses which can resolve the remote domain |
| # involved in trust. |
| "A String", |
| ], |
| "trustHandshakeSecret": "A String", # Input only, and will not be stored. The trust secret used for handshake |
| # with target domain. |
| "trustType": "A String", # The type of trust represented by the trust resource. |
| "trustDirection": "A String", # The trust direction decides the current domain is trusted, trusting or |
| # both. |
| "state": "A String", # Output only. The current state of this trust. |
| "lastKnownTrustConnectedHeartbeatTime": "A String", # Output only. The last heartbeat time when the trust was known to be |
| # connected. |
| "createTime": "A String", # Output only. The time the instance was created. |
| "updateTime": "A String", # Output only. Last update time. |
| "targetDomainName": "A String", # The fully qualified target domain name which will be in trust with current |
| # domain. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a |
| # network API call. |
| "name": "A String", # The server-assigned name, which is only unique within the same service that |
| # originally returns it. If you use the default HTTP mapping, the |
| # `name` should be a resource name ending with `operations/{unique_id}`. |
| "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically |
| # contains progress information and common metadata such as create time. |
| # Some services might not provide such metadata. Any method that returns a |
| # long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| # If `true`, the operation is completed, and either `error` or `response` is |
| # available. |
| "response": { # The normal response of the operation in case of success. If the original |
| # method returns no data on success, such as `Delete`, the response is |
| # `google.protobuf.Empty`. If the original method is standard |
| # `Get`/`Create`/`Update`, the response should be the resource. For other |
| # methods, the response should have the type `XxxResponse`, where `Xxx` |
| # is the original method name. For example, if the original method name |
| # is `TakeSnapshot()`, the inferred response type is |
| # `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets details of a single Domain. |
| |
| Args: |
| name: string, Domain resource name using the form: |
| `projects/{project_id}/locations/global/domains/{domain_name}` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "createTime": "A String", # Output only. The time the instance was created. Synthetic field is |
| # populated automatically by CCFE. go/ccfe-synthetic-field-user-guide |
| "statusMessage": "A String", # Output only. Additional information about the current status of this |
| # domain, if available. |
| "updateTime": "A String", # Output only. Last update time. Synthetic field is populated automatically |
| # by CCFE. |
| "locations": [ # Required. Locations where domain needs to be provisioned. |
| # regions |
| # e.g. us-west1 or us-east4 |
| # Service supports up to 4 locations at once. Each location will use a /26 |
| # block. |
| "A String", |
| ], |
| "managedIdentitiesAdminName": "A String", # Optional. Name of customer-visible admin used to perform Active Directory |
| # operations. If not specified `setupadmin` would be used. |
| "reservedIpRange": "A String", # Required. The CIDR range of internal addresses that are reserved for this |
| # domain. Reserved networks must be /24 or larger. Ranges must be |
| # unique and non-overlapping with existing subnets in |
| # [Domain].[authorized_networks]. |
| "labels": { # Optional. Resource labels to represent user provided metadata |
| "a_key": "A String", |
| }, |
| "authorizedNetworks": [ # Optional. The full names of the Google Compute Engine |
| # [networks](/compute/docs/networks-and-firewalls#networks) to which the |
| # instance is connected. Network can be added using UpdateDomain later. |
| # Domain is only available on network part of authorized_networks. |
| # Caller needs to make sure that CIDR subnets do not overlap between |
| # networks, else domain creation will fail. |
| "A String", |
| ], |
| "name": "A String", # Output only. Unique name of the domain in this scope including projects and |
| # location using the form: |
| # `projects/{project_id}/locations/global/domains/{domain_name}`. |
| "fqdn": "A String", # Output only. Fully-qualified domain name of the exposed domain used by |
| # clients to connect to the service. Similar to what would be chosen for an |
| # Active Directory that is set up on an internal network. |
| "trusts": [ # Output only. The current trusts associated with the domain. |
| { # Represents a relationship between two domains which makes it possible |
| # for users in one domain to be authenticated by a dc in another domain. |
| # Refer |
| # https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc731335(v%3dws.10) |
| "selectiveAuthentication": True or False, # The trust authentication type which decides whether the trusted side has |
| # forest/domain wide access or selective access to approved set of resources. |
| "stateDescription": "A String", # Output only. Additional information about the current state of this |
| # trust, if available. |
| "targetDnsIpAddresses": [ # The target dns server ip addresses which can resolve the remote domain |
| # involved in trust. |
| "A String", |
| ], |
| "trustHandshakeSecret": "A String", # Input only, and will not be stored. The trust secret used for handshake |
| # with target domain. |
| "trustType": "A String", # The type of trust represented by the trust resource. |
| "trustDirection": "A String", # The trust direction decides the current domain is trusted, trusting or |
| # both. |
| "state": "A String", # Output only. The current state of this trust. |
| "lastKnownTrustConnectedHeartbeatTime": "A String", # Output only. The last heartbeat time when the trust was known to be |
| # connected. |
| "createTime": "A String", # Output only. The time the instance was created. |
| "updateTime": "A String", # Output only. Last update time. |
| "targetDomainName": "A String", # The fully qualified target domain name which will be in trust with current |
| # domain. |
| }, |
| ], |
| "state": "A String", # Output only. The current state of this domain. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code> |
| <pre>Gets the access control policy for a resource. |
| Returns an empty policy if the resource exists and does not have a policy |
| set. |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy is being requested. |
| See the operation documentation for the appropriate value for this field. (required) |
| options_requestedPolicyVersion: integer, Optional. The policy format version to be returned. |
| |
| Valid values are 0, 1, and 3. Requests specifying an invalid value will be |
| rejected. |
| |
| Requests for policies with any conditional bindings must specify version 3. |
| Policies without any conditional bindings may specify any valid value or |
| leave the field unset. |
| |
| To learn which resources support conditions in their IAM policies, see the |
| [IAM |
| documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An Identity and Access Management (IAM) policy, which specifies access |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # For some types of Google Cloud resources, a `binding` can also specify a |
| # `condition`, which is a logical expression that allows access to a resource |
| # only if the expression evaluates to `true`. A condition can add constraints |
| # based on attributes of the request, the resource, or both. To learn which |
| # resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # |
| # **JSON example:** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:eve@example.com" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "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. |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| # `condition` that determines how and when the `bindings` are applied. Each |
| # of the `bindings` must contain at least one member. |
| { # Associates `members` with a `role`. |
| "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@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`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| # |
| # If the condition evaluates to `true`, then this binding applies to the |
| # current request. |
| # |
| # If the condition evaluates to `false`, then this binding does not apply to |
| # the current request. However, a different role binding might grant the same |
| # role to one or more of the members in this binding. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM |
| # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| }, |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| }, |
| ], |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, orderBy=None, filter=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists Domains in a given project. |
| |
| Args: |
| parent: string, Required. The resource name of the domain location using the form: |
| `projects/{project_id}/locations/global` (required) |
| pageSize: integer, If not specified, a default value of 1000 will be used by the service. |
| Regardless of the page_size value, the response may include a partial list |
| and a caller should only rely on response's |
| next_page_token |
| to determine if there are more instances left to be queried. |
| orderBy: string, Optional. Specifies the ordering of results following syntax at |
| https://cloud.google.com/apis/design/design_patterns#sorting_order. |
| filter: string, Optional. Filter specifying constraints of a list operation. |
| For example, `Domain.fqdn="mydomain.myorginization"`. |
| pageToken: string, The next_page_token value returned from a previous List request, if any. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more |
| # results in the list. |
| "domains": [ # A list of Managed Identities Service domains in the project. |
| { |
| "createTime": "A String", # Output only. The time the instance was created. Synthetic field is |
| # populated automatically by CCFE. go/ccfe-synthetic-field-user-guide |
| "statusMessage": "A String", # Output only. Additional information about the current status of this |
| # domain, if available. |
| "updateTime": "A String", # Output only. Last update time. Synthetic field is populated automatically |
| # by CCFE. |
| "locations": [ # Required. Locations where domain needs to be provisioned. |
| # regions |
| # e.g. us-west1 or us-east4 |
| # Service supports up to 4 locations at once. Each location will use a /26 |
| # block. |
| "A String", |
| ], |
| "managedIdentitiesAdminName": "A String", # Optional. Name of customer-visible admin used to perform Active Directory |
| # operations. If not specified `setupadmin` would be used. |
| "reservedIpRange": "A String", # Required. The CIDR range of internal addresses that are reserved for this |
| # domain. Reserved networks must be /24 or larger. Ranges must be |
| # unique and non-overlapping with existing subnets in |
| # [Domain].[authorized_networks]. |
| "labels": { # Optional. Resource labels to represent user provided metadata |
| "a_key": "A String", |
| }, |
| "authorizedNetworks": [ # Optional. The full names of the Google Compute Engine |
| # [networks](/compute/docs/networks-and-firewalls#networks) to which the |
| # instance is connected. Network can be added using UpdateDomain later. |
| # Domain is only available on network part of authorized_networks. |
| # Caller needs to make sure that CIDR subnets do not overlap between |
| # networks, else domain creation will fail. |
| "A String", |
| ], |
| "name": "A String", # Output only. Unique name of the domain in this scope including projects and |
| # location using the form: |
| # `projects/{project_id}/locations/global/domains/{domain_name}`. |
| "fqdn": "A String", # Output only. Fully-qualified domain name of the exposed domain used by |
| # clients to connect to the service. Similar to what would be chosen for an |
| # Active Directory that is set up on an internal network. |
| "trusts": [ # Output only. The current trusts associated with the domain. |
| { # Represents a relationship between two domains which makes it possible |
| # for users in one domain to be authenticated by a dc in another domain. |
| # Refer |
| # https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc731335(v%3dws.10) |
| "selectiveAuthentication": True or False, # The trust authentication type which decides whether the trusted side has |
| # forest/domain wide access or selective access to approved set of resources. |
| "stateDescription": "A String", # Output only. Additional information about the current state of this |
| # trust, if available. |
| "targetDnsIpAddresses": [ # The target dns server ip addresses which can resolve the remote domain |
| # involved in trust. |
| "A String", |
| ], |
| "trustHandshakeSecret": "A String", # Input only, and will not be stored. The trust secret used for handshake |
| # with target domain. |
| "trustType": "A String", # The type of trust represented by the trust resource. |
| "trustDirection": "A String", # The trust direction decides the current domain is trusted, trusting or |
| # both. |
| "state": "A String", # Output only. The current state of this trust. |
| "lastKnownTrustConnectedHeartbeatTime": "A String", # Output only. The last heartbeat time when the trust was known to be |
| # connected. |
| "createTime": "A String", # Output only. The time the instance was created. |
| "updateTime": "A String", # Output only. Last update time. |
| "targetDomainName": "A String", # The fully qualified target domain name which will be in trust with current |
| # domain. |
| }, |
| ], |
| "state": "A String", # Output only. The current state of this domain. |
| }, |
| ], |
| "unreachable": [ # Locations that could not be reached. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates the metadata and configuration of a specified domain. |
| Operation<response: google.protobuf.Empty> |
| |
| Args: |
| name: string, Output only. Unique name of the domain in this scope including projects and |
| location using the form: |
| `projects/{project_id}/locations/global/domains/{domain_name}`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "createTime": "A String", # Output only. The time the instance was created. Synthetic field is |
| # populated automatically by CCFE. go/ccfe-synthetic-field-user-guide |
| "statusMessage": "A String", # Output only. Additional information about the current status of this |
| # domain, if available. |
| "updateTime": "A String", # Output only. Last update time. Synthetic field is populated automatically |
| # by CCFE. |
| "locations": [ # Required. Locations where domain needs to be provisioned. |
| # regions |
| # e.g. us-west1 or us-east4 |
| # Service supports up to 4 locations at once. Each location will use a /26 |
| # block. |
| "A String", |
| ], |
| "managedIdentitiesAdminName": "A String", # Optional. Name of customer-visible admin used to perform Active Directory |
| # operations. If not specified `setupadmin` would be used. |
| "reservedIpRange": "A String", # Required. The CIDR range of internal addresses that are reserved for this |
| # domain. Reserved networks must be /24 or larger. Ranges must be |
| # unique and non-overlapping with existing subnets in |
| # [Domain].[authorized_networks]. |
| "labels": { # Optional. Resource labels to represent user provided metadata |
| "a_key": "A String", |
| }, |
| "authorizedNetworks": [ # Optional. The full names of the Google Compute Engine |
| # [networks](/compute/docs/networks-and-firewalls#networks) to which the |
| # instance is connected. Network can be added using UpdateDomain later. |
| # Domain is only available on network part of authorized_networks. |
| # Caller needs to make sure that CIDR subnets do not overlap between |
| # networks, else domain creation will fail. |
| "A String", |
| ], |
| "name": "A String", # Output only. Unique name of the domain in this scope including projects and |
| # location using the form: |
| # `projects/{project_id}/locations/global/domains/{domain_name}`. |
| "fqdn": "A String", # Output only. Fully-qualified domain name of the exposed domain used by |
| # clients to connect to the service. Similar to what would be chosen for an |
| # Active Directory that is set up on an internal network. |
| "trusts": [ # Output only. The current trusts associated with the domain. |
| { # Represents a relationship between two domains which makes it possible |
| # for users in one domain to be authenticated by a dc in another domain. |
| # Refer |
| # https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc731335(v%3dws.10) |
| "selectiveAuthentication": True or False, # The trust authentication type which decides whether the trusted side has |
| # forest/domain wide access or selective access to approved set of resources. |
| "stateDescription": "A String", # Output only. Additional information about the current state of this |
| # trust, if available. |
| "targetDnsIpAddresses": [ # The target dns server ip addresses which can resolve the remote domain |
| # involved in trust. |
| "A String", |
| ], |
| "trustHandshakeSecret": "A String", # Input only, and will not be stored. The trust secret used for handshake |
| # with target domain. |
| "trustType": "A String", # The type of trust represented by the trust resource. |
| "trustDirection": "A String", # The trust direction decides the current domain is trusted, trusting or |
| # both. |
| "state": "A String", # Output only. The current state of this trust. |
| "lastKnownTrustConnectedHeartbeatTime": "A String", # Output only. The last heartbeat time when the trust was known to be |
| # connected. |
| "createTime": "A String", # Output only. The time the instance was created. |
| "updateTime": "A String", # Output only. Last update time. |
| "targetDomainName": "A String", # The fully qualified target domain name which will be in trust with current |
| # domain. |
| }, |
| ], |
| "state": "A String", # Output only. The current state of this domain. |
| } |
| |
| updateMask: string, Mask of fields to update. At least one path must be supplied in this |
| field. The elements of the repeated paths field may only include these |
| fields from Domain: |
| * `labels` |
| * `locations` |
| * `authorized_networks` |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a |
| # network API call. |
| "name": "A String", # The server-assigned name, which is only unique within the same service that |
| # originally returns it. If you use the default HTTP mapping, the |
| # `name` should be a resource name ending with `operations/{unique_id}`. |
| "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically |
| # contains progress information and common metadata such as create time. |
| # Some services might not provide such metadata. Any method that returns a |
| # long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| # If `true`, the operation is completed, and either `error` or `response` is |
| # available. |
| "response": { # The normal response of the operation in case of success. If the original |
| # method returns no data on success, such as `Delete`, the response is |
| # `google.protobuf.Empty`. If the original method is standard |
| # `Get`/`Create`/`Update`, the response should be the resource. For other |
| # methods, the response should have the type `XxxResponse`, where `Xxx` |
| # is the original method name. For example, if the original method name |
| # is `TakeSnapshot()`, the inferred response type is |
| # `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="reconfigureTrust">reconfigureTrust(name, body=None, x__xgafv=None)</code> |
| <pre>Updates the dns conditional forwarder. |
| Operation<response: google.protobuf.Empty> |
| |
| Args: |
| name: string, The resource domain name, project name and location using the form: |
| `projects/{project_id}/locations/global/domains/{domain_name}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "trust": { # Represents a relationship between two domains which makes it possible # The domain trust resource with updated dns conditional forwarder. |
| # for users in one domain to be authenticated by a dc in another domain. |
| # Refer |
| # https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc731335(v%3dws.10) |
| "selectiveAuthentication": True or False, # The trust authentication type which decides whether the trusted side has |
| # forest/domain wide access or selective access to approved set of resources. |
| "stateDescription": "A String", # Output only. Additional information about the current state of this |
| # trust, if available. |
| "targetDnsIpAddresses": [ # The target dns server ip addresses which can resolve the remote domain |
| # involved in trust. |
| "A String", |
| ], |
| "trustHandshakeSecret": "A String", # Input only, and will not be stored. The trust secret used for handshake |
| # with target domain. |
| "trustType": "A String", # The type of trust represented by the trust resource. |
| "trustDirection": "A String", # The trust direction decides the current domain is trusted, trusting or |
| # both. |
| "state": "A String", # Output only. The current state of this trust. |
| "lastKnownTrustConnectedHeartbeatTime": "A String", # Output only. The last heartbeat time when the trust was known to be |
| # connected. |
| "createTime": "A String", # Output only. The time the instance was created. |
| "updateTime": "A String", # Output only. Last update time. |
| "targetDomainName": "A String", # The fully qualified target domain name which will be in trust with current |
| # domain. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a |
| # network API call. |
| "name": "A String", # The server-assigned name, which is only unique within the same service that |
| # originally returns it. If you use the default HTTP mapping, the |
| # `name` should be a resource name ending with `operations/{unique_id}`. |
| "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically |
| # contains progress information and common metadata such as create time. |
| # Some services might not provide such metadata. Any method that returns a |
| # long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| # If `true`, the operation is completed, and either `error` or `response` is |
| # available. |
| "response": { # The normal response of the operation in case of success. If the original |
| # method returns no data on success, such as `Delete`, the response is |
| # `google.protobuf.Empty`. If the original method is standard |
| # `Get`/`Create`/`Update`, the response should be the resource. For other |
| # methods, the response should have the type `XxxResponse`, where `Xxx` |
| # is the original method name. For example, if the original method name |
| # is `TakeSnapshot()`, the inferred response type is |
| # `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="resetAdminPassword">resetAdminPassword(name, body=None, x__xgafv=None)</code> |
| <pre>Resets managed identities admin password identified by |
| managed_identities_admin_name |
| |
| Args: |
| name: string, The domain resource name using the form: |
| `projects/{project_id}/locations/global/domains/{domain_name}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { |
| "password": "A String", # A random password. See admin for more information. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code> |
| <pre>Sets the access control policy on the specified resource. Replaces any |
| existing policy. |
| |
| Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy is being specified. |
| See the operation documentation for the appropriate value for this field. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for `SetIamPolicy` method. |
| "policy": { # An Identity and Access Management (IAM) policy, which specifies access # 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. |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # For some types of Google Cloud resources, a `binding` can also specify a |
| # `condition`, which is a logical expression that allows access to a resource |
| # only if the expression evaluates to `true`. A condition can add constraints |
| # based on attributes of the request, the resource, or both. To learn which |
| # resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # |
| # **JSON example:** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:eve@example.com" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "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. |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| # `condition` that determines how and when the `bindings` are applied. Each |
| # of the `bindings` must contain at least one member. |
| { # Associates `members` with a `role`. |
| "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@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`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| # |
| # If the condition evaluates to `true`, then this binding applies to the |
| # current request. |
| # |
| # If the condition evaluates to `false`, then this binding does not apply to |
| # the current request. However, a different role binding might grant the same |
| # role to one or more of the members in this binding. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM |
| # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| }, |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| }, |
| ], |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # An Identity and Access Management (IAM) policy, which specifies access |
| # controls for Google Cloud resources. |
| # |
| # |
| # A `Policy` is a collection of `bindings`. A `binding` binds one or more |
| # `members` to a single `role`. Members can be user accounts, service accounts, |
| # Google groups, and domains (such as G Suite). A `role` is a named list of |
| # permissions; each `role` can be an IAM predefined role or a user-created |
| # custom role. |
| # |
| # For some types of Google Cloud resources, a `binding` can also specify a |
| # `condition`, which is a logical expression that allows access to a resource |
| # only if the expression evaluates to `true`. A condition can add constraints |
| # based on attributes of the request, the resource, or both. To learn which |
| # resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # |
| # **JSON example:** |
| # |
| # { |
| # "bindings": [ |
| # { |
| # "role": "roles/resourcemanager.organizationAdmin", |
| # "members": [ |
| # "user:mike@example.com", |
| # "group:admins@example.com", |
| # "domain:google.com", |
| # "serviceAccount:my-project-id@appspot.gserviceaccount.com" |
| # ] |
| # }, |
| # { |
| # "role": "roles/resourcemanager.organizationViewer", |
| # "members": [ |
| # "user:eve@example.com" |
| # ], |
| # "condition": { |
| # "title": "expirable access", |
| # "description": "Does not grant access after Sep 2020", |
| # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", |
| # } |
| # } |
| # ], |
| # "etag": "BwWWja0YfJA=", |
| # "version": 3 |
| # } |
| # |
| # **YAML example:** |
| # |
| # bindings: |
| # - members: |
| # - user:mike@example.com |
| # - group:admins@example.com |
| # - domain:google.com |
| # - serviceAccount:my-project-id@appspot.gserviceaccount.com |
| # role: roles/resourcemanager.organizationAdmin |
| # - members: |
| # - user:eve@example.com |
| # role: roles/resourcemanager.organizationViewer |
| # condition: |
| # title: expirable access |
| # description: Does not grant access after Sep 2020 |
| # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') |
| # - etag: BwWWja0YfJA= |
| # - version: 3 |
| # |
| # For a description of IAM and its features, see the |
| # [IAM documentation](https://cloud.google.com/iam/docs/). |
| "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. |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a |
| # `condition` that determines how and when the `bindings` are applied. Each |
| # of the `bindings` must contain at least one member. |
| { # Associates `members` with a `role`. |
| "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@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`. |
| # |
| # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a user that has been recently deleted. For |
| # example, `alice@example.com?uid=123456789012345678901`. If the user is |
| # recovered, this value reverts to `user:{emailid}` and the recovered user |
| # retains the role in the binding. |
| # |
| # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus |
| # unique identifier) representing a service account that has been recently |
| # deleted. For example, |
| # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. |
| # If the service account is undeleted, this value reverts to |
| # `serviceAccount:{emailid}` and the undeleted service account retains the |
| # role in the binding. |
| # |
| # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique |
| # identifier) representing a Google group that has been recently |
| # deleted. For example, `admins@example.com?uid=123456789012345678901`. If |
| # the group is recovered, this value reverts to `group:{emailid}` and the |
| # recovered group retains the role in the binding. |
| # |
| # |
| # * `domain:{domain}`: The G Suite domain (primary) that represents all the |
| # users of that domain. For example, `google.com` or `example.com`. |
| # |
| "A String", |
| ], |
| "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding. |
| # |
| # If the condition evaluates to `true`, then this binding applies to the |
| # current request. |
| # |
| # If the condition evaluates to `false`, then this binding does not apply to |
| # the current request. However, a different role binding might grant the same |
| # role to one or more of the members in this binding. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM |
| # documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| # syntax. CEL is a C-like expression language. The syntax and semantics of CEL |
| # are documented at https://github.com/google/cel-spec. |
| # |
| # Example (Comparison): |
| # |
| # title: "Summary size limit" |
| # description: "Determines if a summary is less than 100 chars" |
| # expression: "document.summary.size() < 100" |
| # |
| # Example (Equality): |
| # |
| # title: "Requestor is owner" |
| # description: "Determines if requestor is the document owner" |
| # expression: "document.owner == request.auth.claims.email" |
| # |
| # Example (Logic): |
| # |
| # title: "Public documents" |
| # description: "Determine whether the document should be publicly visible" |
| # expression: "document.type != 'private' && document.type != 'internal'" |
| # |
| # Example (Data Manipulation): |
| # |
| # title: "Notification string" |
| # description: "Create a notification string with a timestamp." |
| # expression: "'New message received at ' + string(document.create_time)" |
| # |
| # The exact variables and functions that may be referenced within an expression |
| # are determined by the service that evaluates it. See the service |
| # documentation for additional information. |
| "description": "A String", # Optional. Description of the expression. This is a longer text which |
| # describes the expression, e.g. when hovered over it in a UI. |
| "expression": "A String", # Textual representation of an expression in Common Expression Language |
| # syntax. |
| "location": "A String", # Optional. String indicating the location of the expression for error |
| # reporting, e.g. a file name and a position in the file. |
| "title": "A String", # Optional. Title for the expression, i.e. a short string describing |
| # its purpose. This can be used e.g. in UIs which allow to enter the |
| # expression. |
| }, |
| "role": "A String", # Role that is assigned to `members`. |
| # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. |
| }, |
| ], |
| "version": 42, # Specifies the format of the policy. |
| # |
| # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value |
| # are rejected. |
| # |
| # Any operation that affects conditional role bindings must specify version |
| # `3`. This requirement applies to the following operations: |
| # |
| # * Getting a policy that includes a conditional role binding |
| # * Adding a conditional role binding to a policy |
| # * Changing a conditional role binding in a policy |
| # * Removing any role binding, with or without a condition, from a policy |
| # that includes conditions |
| # |
| # **Important:** If you use IAM Conditions, you must include the `etag` field |
| # whenever you call `setIamPolicy`. If you omit this field, then IAM allows |
| # you to overwrite a version `3` policy with a version `1` policy, and all of |
| # the conditions in the version `3` policy are lost. |
| # |
| # If a policy does not include any conditions, operations on that policy may |
| # specify any valid version or leave the field unset. |
| # |
| # To learn which resources support conditions in their IAM policies, see the |
| # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code> |
| <pre>Returns permissions that a caller has on the specified resource. |
| If the resource does not exist, this will return an empty set of |
| permissions, not a `NOT_FOUND` error. |
| |
| Note: This operation is designed to be used for building permission-aware |
| UIs and command-line tools, not for authorization checking. This operation |
| may "fail open" without warning. |
| |
| Args: |
| resource: string, REQUIRED: The resource for which the policy detail is being requested. |
| See the operation documentation for the appropriate value for this field. (required) |
| body: object, The request body. |
| 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> |
| |
| <div class="method"> |
| <code class="details" id="validateTrust">validateTrust(name, body=None, x__xgafv=None)</code> |
| <pre>Validate the trust state |
| Operation<response: google.protobuf.Empty> |
| |
| Args: |
| name: string, The resource domain name, project name, and location using the form: |
| `projects/{project_id}/locations/global/domains/{domain_name}` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { |
| "trust": { # Represents a relationship between two domains which makes it possible # The domain trust to validate trust state for. |
| # for users in one domain to be authenticated by a dc in another domain. |
| # Refer |
| # https://docs.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc731335(v%3dws.10) |
| "selectiveAuthentication": True or False, # The trust authentication type which decides whether the trusted side has |
| # forest/domain wide access or selective access to approved set of resources. |
| "stateDescription": "A String", # Output only. Additional information about the current state of this |
| # trust, if available. |
| "targetDnsIpAddresses": [ # The target dns server ip addresses which can resolve the remote domain |
| # involved in trust. |
| "A String", |
| ], |
| "trustHandshakeSecret": "A String", # Input only, and will not be stored. The trust secret used for handshake |
| # with target domain. |
| "trustType": "A String", # The type of trust represented by the trust resource. |
| "trustDirection": "A String", # The trust direction decides the current domain is trusted, trusting or |
| # both. |
| "state": "A String", # Output only. The current state of this trust. |
| "lastKnownTrustConnectedHeartbeatTime": "A String", # Output only. The last heartbeat time when the trust was known to be |
| # connected. |
| "createTime": "A String", # Output only. The time the instance was created. |
| "updateTime": "A String", # Output only. Last update time. |
| "targetDomainName": "A String", # The fully qualified target domain name which will be in trust with current |
| # domain. |
| }, |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # This resource represents a long-running operation that is the result of a |
| # network API call. |
| "name": "A String", # The server-assigned name, which is only unique within the same service that |
| # originally returns it. If you use the default HTTP mapping, the |
| # `name` should be a resource name ending with `operations/{unique_id}`. |
| "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| # different programming environments, including REST APIs and RPC APIs. It is |
| # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| # three pieces of data: error code, error message, and error details. |
| # |
| # You can find out more about this error model and how to work with it in the |
| # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| "message": "A String", # A developer-facing error message, which should be in English. Any |
| # user-facing error message should be localized and sent in the |
| # google.rpc.Status.details field, or localized by the client. |
| "details": [ # A list of messages that carry the error details. There is a common set of |
| # message types for APIs to use. |
| { |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| ], |
| }, |
| "metadata": { # Service-specific metadata associated with the operation. It typically |
| # contains progress information and common metadata such as create time. |
| # Some services might not provide such metadata. Any method that returns a |
| # long-running operation should document the metadata type, if any. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| # If `true`, the operation is completed, and either `error` or `response` is |
| # available. |
| "response": { # The normal response of the operation in case of success. If the original |
| # method returns no data on success, such as `Delete`, the response is |
| # `google.protobuf.Empty`. If the original method is standard |
| # `Get`/`Create`/`Update`, the response should be the resource. For other |
| # methods, the response should have the type `XxxResponse`, where `Xxx` |
| # is the original method name. For example, if the original method name |
| # is `TakeSnapshot()`, the inferred response type is |
| # `TakeSnapshotResponse`. |
| "a_key": "", # Properties of the object. Contains field @type with type URL. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
