Blame - docs/dyn/managedidentities_v1alpha1.projects.locations.global_.domains.html - platform/external/python/google-api-python-client

blob: 11708afec2ebd75579709c31ac88c8cec1158cf6 [file] [log] [blame]

Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, h1, h2, h3, div, span, p, pre, a {
				5	margin: 0;
				6	padding: 0;
				7	border: 0;
				8	font-weight: inherit;
				9	font-style: inherit;
				10	font-size: 100%;
				11	font-family: inherit;
				12	vertical-align: baseline;
				13	}
				14
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, h2, h3 {
				50	border-bottom: solid #CCC 1px;
				51	}
				52
				53	.toc_element {
				54	margin-top: 0.5em;
				55	}
				56
				57	.firstline {
				58	margin-left: 2 em;
				59	}
				60
				61	.method {
				62	margin-top: 1em;
				63	border: solid 1px #CCC;
				64	padding: 1em;
				65	background: #EEE;
				66	}
				67
				68	.details {
				69	font-weight: bold;
				70	font-size: 14px;
				71	}
				72
				73	</style>
				74
				75	<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>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	78	<code><a href="managedidentities_v1alpha1.projects.locations.global_.domains.sqlIntegrations.html">sqlIntegrations()</a></code>
				79	</p>
				80	<p class="firstline">Returns the sqlIntegrations Resource.</p>
				81
				82	<p class="toc_element">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	83	<code><a href="#attachTrust">attachTrust(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	84	<p class="firstline">Adds AD trust in a given domain. Operation</p>
				85	<p class="toc_element">
				86	<code><a href="#close">close()</a></code></p>
				87	<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	88	<p class="toc_element">
				89	<code><a href="#create">create(parent, body=None, domainName=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	90	<p class="firstline">Creates a Microsoft AD Domain in a given project. Operation</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	91	<p class="toc_element">
				92	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	93	<p class="firstline">Deletes identified domain. Operation</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	94	<p class="toc_element">
				95	<code><a href="#detachTrust">detachTrust(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	96	<p class="firstline">Removes identified trust. Operation</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	97	<p class="toc_element">
				98	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				99	<p class="firstline">Gets details of a single Domain.</p>
				100	<p class="toc_element">
				101	<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	102	<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	103	<p class="toc_element">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	104	<code><a href="#list">list(parent, pageSize=None, pageToken=None, filter=None, orderBy=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	105	<p class="firstline">Lists Domains in a given project.</p>
				106	<p class="toc_element">
				107	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				108	<p class="firstline">Retrieves the next page of results.</p>
				109	<p class="toc_element">
				110	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	111	<p class="firstline">Updates the metadata and configuration of a specified domain. Operation</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	112	<p class="toc_element">
				113	<code><a href="#reconfigureTrust">reconfigureTrust(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	114	<p class="firstline">Updates the dns conditional forwarder. Operation</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	115	<p class="toc_element">
				116	<code><a href="#resetAdminPassword">resetAdminPassword(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	117	<p class="firstline">Resets managed identities admin password identified by managed_identities_admin_name</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	118	<p class="toc_element">
				119	<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	120	<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	121	<p class="toc_element">
				122	<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	123	<p class="firstline">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.</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	124	<p class="toc_element">
				125	<code><a href="#validateTrust">validateTrust(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	126	<p class="firstline">Validate the trust state Operation</p>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	127	<h3>Method Details</h3>
				128	<div class="method">
				129	<code class="details" id="attachTrust">attachTrust(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	130	<pre>Adds AD trust in a given domain. Operation
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	131
				132	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	133	name: string, The resource domain name, project name and location using the form: `projects/{project_id}/locations/global/domains/{domain_name}` (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	134	body: object, The request body.
				135	The object takes the form of:
				136
				137	{
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	138	"trust": { # 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) # The domain trust resource.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	139	"lastKnownTrustConnectedHeartbeatTime": "A String", # Output only. The last heartbeat time when the trust was known to be connected.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	140	"targetDnsIpAddresses": [ # The target dns server ip addresses which can resolve the remote domain involved in trust.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	141	"A String",
				142	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	143	"stateDescription": "A String", # Output only. Additional information about the current state of this trust, if available.
				144	"trustType": "A String", # The type of trust represented by the trust resource.
				145	"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.
				146	"createTime": "A String", # Output only. The time the instance was created.
				147	"trustHandshakeSecret": "A String", # Input only, and will not be stored. The trust secret used for handshake with target domain.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	148	"targetDomainName": "A String", # The fully qualified target domain name which will be in trust with current domain.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	149	"state": "A String", # Output only. The current state of this trust.
				150	"trustDirection": "A String", # The trust direction decides the current domain is trusted, trusting or both.
				151	"updateTime": "A String", # Output only. Last update time.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	152	},
				153	}
				154
				155	x__xgafv: string, V1 error format.
				156	Allowed values
				157	1 - v1 error format
				158	2 - v2 error format
				159
				160	Returns:
				161	An object of the form:
				162
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	163	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	164	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	165	"a_key": "", # Properties of the object. Contains field @type with type URL.
				166	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	167	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	168	"error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
				169	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	170	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	171	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	172	{
				173	"a_key": "", # Properties of the object. Contains field @type with type URL.
				174	},
				175	],
				176	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	177	"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.
				178	"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`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	179	"a_key": "", # Properties of the object. Contains field @type with type URL.
				180	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	181	}</pre>
				182	</div>
				183
				184	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	185	<code class="details" id="close">close()</code>
				186	<pre>Close httplib2 connections.</pre>
				187	</div>
				188
				189	<div class="method">
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	190	<code class="details" id="create">create(parent, body=None, domainName=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	191	<pre>Creates a Microsoft AD Domain in a given project. Operation
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	192
				193	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	194	parent: string, Resource project name and location using the form: `projects/{project_id}/locations/global` (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	195	body: object, The request body.
				196	The object takes the form of:
				197
				198	{
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	199	"statusMessage": "A String", # Output only. Additional information about the current status of this domain, if available.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	200	"state": "A String", # Output only. The current state of this domain.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	201	"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.
				202	"A String",
				203	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	204	"updateTime": "A String", # Output only. Last update time. Synthetic field is populated automatically by CCFE.
				205	"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].
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	206	"createTime": "A String", # Output only. The time the instance was created. Synthetic field is populated automatically by CCFE. go/ccfe-synthetic-field-user-guide
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	207	"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.
				208	"A String",
				209	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	210	"labels": { # Optional. Resource labels to represent user provided metadata
				211	"a_key": "A String",
				212	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	213	"trusts": [ # Output only. The current trusts associated with the domain.
				214	{ # 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)
				215	"lastKnownTrustConnectedHeartbeatTime": "A String", # Output only. The last heartbeat time when the trust was known to be connected.
				216	"targetDnsIpAddresses": [ # The target dns server ip addresses which can resolve the remote domain involved in trust.
				217	"A String",
				218	],
				219	"stateDescription": "A String", # Output only. Additional information about the current state of this trust, if available.
				220	"trustType": "A String", # The type of trust represented by the trust resource.
				221	"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.
				222	"createTime": "A String", # Output only. The time the instance was created.
				223	"trustHandshakeSecret": "A String", # Input only, and will not be stored. The trust secret used for handshake with target domain.
				224	"targetDomainName": "A String", # The fully qualified target domain name which will be in trust with current domain.
				225	"state": "A String", # Output only. The current state of this trust.
				226	"trustDirection": "A String", # The trust direction decides the current domain is trusted, trusting or both.
				227	"updateTime": "A String", # Output only. Last update time.
				228	},
				229	],
				230	"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.
				231	"managedIdentitiesAdminName": "A String", # Optional. Name of customer-visible admin used to perform Active Directory operations. If not specified `setupadmin` would be used.
				232	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	233	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	234
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	235	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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	236	x__xgafv: string, V1 error format.
				237	Allowed values
				238	1 - v1 error format
				239	2 - v2 error format
				240
				241	Returns:
				242	An object of the form:
				243
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	244	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	245	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	246	"a_key": "", # Properties of the object. Contains field @type with type URL.
				247	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	248	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	249	"error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
				250	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	251	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	252	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	253	{
				254	"a_key": "", # Properties of the object. Contains field @type with type URL.
				255	},
				256	],
				257	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	258	"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.
				259	"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`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	260	"a_key": "", # Properties of the object. Contains field @type with type URL.
				261	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	262	}</pre>
				263	</div>
				264
				265	<div class="method">
				266	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	267	<pre>Deletes identified domain. Operation
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	268
				269	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	270	name: string, Domain resource name using the form: `projects/{project_id}/locations/global/domains/{domain_name}` (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	271	x__xgafv: string, V1 error format.
				272	Allowed values
				273	1 - v1 error format
				274	2 - v2 error format
				275
				276	Returns:
				277	An object of the form:
				278
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	279	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	280	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	281	"a_key": "", # Properties of the object. Contains field @type with type URL.
				282	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	283	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	284	"error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
				285	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	286	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	287	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	288	{
				289	"a_key": "", # Properties of the object. Contains field @type with type URL.
				290	},
				291	],
				292	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	293	"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.
				294	"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`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	295	"a_key": "", # Properties of the object. Contains field @type with type URL.
				296	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	297	}</pre>
				298	</div>
				299
				300	<div class="method">
				301	<code class="details" id="detachTrust">detachTrust(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	302	<pre>Removes identified trust. Operation
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	303
				304	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	305	name: string, The resource domain name, project name, and location using the form: `projects/{project_id}/locations/global/domains/{domain_name}` (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	306	body: object, The request body.
				307	The object takes the form of:
				308
				309	{
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	310	"trust": { # 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) # The domain trust resource to removed.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	311	"lastKnownTrustConnectedHeartbeatTime": "A String", # Output only. The last heartbeat time when the trust was known to be connected.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	312	"targetDnsIpAddresses": [ # The target dns server ip addresses which can resolve the remote domain involved in trust.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	313	"A String",
				314	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	315	"stateDescription": "A String", # Output only. Additional information about the current state of this trust, if available.
				316	"trustType": "A String", # The type of trust represented by the trust resource.
				317	"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.
				318	"createTime": "A String", # Output only. The time the instance was created.
				319	"trustHandshakeSecret": "A String", # Input only, and will not be stored. The trust secret used for handshake with target domain.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	320	"targetDomainName": "A String", # The fully qualified target domain name which will be in trust with current domain.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	321	"state": "A String", # Output only. The current state of this trust.
				322	"trustDirection": "A String", # The trust direction decides the current domain is trusted, trusting or both.
				323	"updateTime": "A String", # Output only. Last update time.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	324	},
				325	}
				326
				327	x__xgafv: string, V1 error format.
				328	Allowed values
				329	1 - v1 error format
				330	2 - v2 error format
				331
				332	Returns:
				333	An object of the form:
				334
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	335	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	336	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	337	"a_key": "", # Properties of the object. Contains field @type with type URL.
				338	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	339	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	340	"error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
				341	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	342	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	343	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	344	{
				345	"a_key": "", # Properties of the object. Contains field @type with type URL.
				346	},
				347	],
				348	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	349	"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.
				350	"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`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	351	"a_key": "", # Properties of the object. Contains field @type with type URL.
				352	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	353	}</pre>
				354	</div>
				355
				356	<div class="method">
				357	<code class="details" id="get">get(name, x__xgafv=None)</code>
				358	<pre>Gets details of a single Domain.
				359
				360	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	361	name: string, Domain resource name using the form: `projects/{project_id}/locations/global/domains/{domain_name}` (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	362	x__xgafv: string, V1 error format.
				363	Allowed values
				364	1 - v1 error format
				365	2 - v2 error format
				366
				367	Returns:
				368	An object of the form:
				369
				370	{
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	371	"statusMessage": "A String", # Output only. Additional information about the current status of this domain, if available.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	372	"state": "A String", # Output only. The current state of this domain.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	373	"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.
				374	"A String",
				375	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	376	"updateTime": "A String", # Output only. Last update time. Synthetic field is populated automatically by CCFE.
				377	"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].
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	378	"createTime": "A String", # Output only. The time the instance was created. Synthetic field is populated automatically by CCFE. go/ccfe-synthetic-field-user-guide
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	379	"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.
				380	"A String",
				381	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	382	"labels": { # Optional. Resource labels to represent user provided metadata
				383	"a_key": "A String",
				384	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	385	"trusts": [ # Output only. The current trusts associated with the domain.
				386	{ # 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)
				387	"lastKnownTrustConnectedHeartbeatTime": "A String", # Output only. The last heartbeat time when the trust was known to be connected.
				388	"targetDnsIpAddresses": [ # The target dns server ip addresses which can resolve the remote domain involved in trust.
				389	"A String",
				390	],
				391	"stateDescription": "A String", # Output only. Additional information about the current state of this trust, if available.
				392	"trustType": "A String", # The type of trust represented by the trust resource.
				393	"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.
				394	"createTime": "A String", # Output only. The time the instance was created.
				395	"trustHandshakeSecret": "A String", # Input only, and will not be stored. The trust secret used for handshake with target domain.
				396	"targetDomainName": "A String", # The fully qualified target domain name which will be in trust with current domain.
				397	"state": "A String", # Output only. The current state of this trust.
				398	"trustDirection": "A String", # The trust direction decides the current domain is trusted, trusting or both.
				399	"updateTime": "A String", # Output only. Last update time.
				400	},
				401	],
				402	"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.
				403	"managedIdentitiesAdminName": "A String", # Optional. Name of customer-visible admin used to perform Active Directory operations. If not specified `setupadmin` would be used.
				404	"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}`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	405	}</pre>
				406	</div>
				407
				408	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	409	<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
				410	<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
				411
				412	Args:
				413	resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
				414	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).
				415	x__xgafv: string, V1 error format.
				416	Allowed values
				417	1 - v1 error format
				418	2 - v2 error format
				419
				420	Returns:
				421	An object of the form:
				422
				423	{ # 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/).
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	424	"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).
				425	"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.
				426	{ # Associates `members` with a `role`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	427	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	428	"condition": { # Represents a textual expression in the Common Expression Language (CEL) 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. # 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).
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	429	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	430	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	431	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				432	"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.
				433	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	434	"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`.
				435	"A String",
				436	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	437	"bindingId": "A String",
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	438	},
				439	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	440	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	441	}</pre>
				442	</div>
				443
				444	<div class="method">
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	445	<code class="details" id="list">list(parent, pageSize=None, pageToken=None, filter=None, orderBy=None, x__xgafv=None)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	446	<pre>Lists Domains in a given project.
				447
				448	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	449	parent: string, Required. The resource name of the domain location using the form: `projects/{project_id}/locations/global` (required)
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	450	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.
				451	pageToken: string, The next_page_token value returned from a previous List request, if any.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	452	filter: string, Optional. Filter specifying constraints of a list operation. For example, `Domain.fqdn="mydomain.myorginization"`.
				453	orderBy: string, Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	454	x__xgafv: string, V1 error format.
				455	Allowed values
				456	1 - v1 error format
				457	2 - v2 error format
				458
				459	Returns:
				460	An object of the form:
				461
				462	{
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	463	"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	464	"unreachable": [ # Locations that could not be reached.
				465	"A String",
				466	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	467	"domains": [ # A list of Managed Identities Service domains in the project.
				468	{
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	469	"statusMessage": "A String", # Output only. Additional information about the current status of this domain, if available.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	470	"state": "A String", # Output only. The current state of this domain.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	471	"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.
				472	"A String",
				473	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	474	"updateTime": "A String", # Output only. Last update time. Synthetic field is populated automatically by CCFE.
				475	"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].
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	476	"createTime": "A String", # Output only. The time the instance was created. Synthetic field is populated automatically by CCFE. go/ccfe-synthetic-field-user-guide
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	477	"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.
				478	"A String",
				479	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	480	"labels": { # Optional. Resource labels to represent user provided metadata
				481	"a_key": "A String",
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	482	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	483	"trusts": [ # Output only. The current trusts associated with the domain.
				484	{ # 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)
				485	"lastKnownTrustConnectedHeartbeatTime": "A String", # Output only. The last heartbeat time when the trust was known to be connected.
				486	"targetDnsIpAddresses": [ # The target dns server ip addresses which can resolve the remote domain involved in trust.
				487	"A String",
				488	],
				489	"stateDescription": "A String", # Output only. Additional information about the current state of this trust, if available.
				490	"trustType": "A String", # The type of trust represented by the trust resource.
				491	"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.
				492	"createTime": "A String", # Output only. The time the instance was created.
				493	"trustHandshakeSecret": "A String", # Input only, and will not be stored. The trust secret used for handshake with target domain.
				494	"targetDomainName": "A String", # The fully qualified target domain name which will be in trust with current domain.
				495	"state": "A String", # Output only. The current state of this trust.
				496	"trustDirection": "A String", # The trust direction decides the current domain is trusted, trusting or both.
				497	"updateTime": "A String", # Output only. Last update time.
				498	},
				499	],
				500	"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.
				501	"managedIdentitiesAdminName": "A String", # Optional. Name of customer-visible admin used to perform Active Directory operations. If not specified `setupadmin` would be used.
				502	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	503	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	504	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	505	}</pre>
				506	</div>
				507
				508	<div class="method">
				509	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				510	<pre>Retrieves the next page of results.
				511
				512	Args:
				513	previous_request: The request for the previous page. (required)
				514	previous_response: The response from the request for the previous page. (required)
				515
				516	Returns:
				517	A request object that you can call 'execute()' on to request the next
				518	page. Returns None if there are no more items in the collection.
				519	</pre>
				520	</div>
				521
				522	<div class="method">
				523	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	524	<pre>Updates the metadata and configuration of a specified domain. Operation
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	525
				526	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	527	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)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	528	body: object, The request body.
				529	The object takes the form of:
				530
				531	{
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	532	"statusMessage": "A String", # Output only. Additional information about the current status of this domain, if available.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	533	"state": "A String", # Output only. The current state of this domain.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	534	"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.
				535	"A String",
				536	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	537	"updateTime": "A String", # Output only. Last update time. Synthetic field is populated automatically by CCFE.
				538	"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].
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	539	"createTime": "A String", # Output only. The time the instance was created. Synthetic field is populated automatically by CCFE. go/ccfe-synthetic-field-user-guide
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	540	"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.
				541	"A String",
				542	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	543	"labels": { # Optional. Resource labels to represent user provided metadata
				544	"a_key": "A String",
				545	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	546	"trusts": [ # Output only. The current trusts associated with the domain.
				547	{ # 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)
				548	"lastKnownTrustConnectedHeartbeatTime": "A String", # Output only. The last heartbeat time when the trust was known to be connected.
				549	"targetDnsIpAddresses": [ # The target dns server ip addresses which can resolve the remote domain involved in trust.
				550	"A String",
				551	],
				552	"stateDescription": "A String", # Output only. Additional information about the current state of this trust, if available.
				553	"trustType": "A String", # The type of trust represented by the trust resource.
				554	"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.
				555	"createTime": "A String", # Output only. The time the instance was created.
				556	"trustHandshakeSecret": "A String", # Input only, and will not be stored. The trust secret used for handshake with target domain.
				557	"targetDomainName": "A String", # The fully qualified target domain name which will be in trust with current domain.
				558	"state": "A String", # Output only. The current state of this trust.
				559	"trustDirection": "A String", # The trust direction decides the current domain is trusted, trusting or both.
				560	"updateTime": "A String", # Output only. Last update time.
				561	},
				562	],
				563	"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.
				564	"managedIdentitiesAdminName": "A String", # Optional. Name of customer-visible admin used to perform Active Directory operations. If not specified `setupadmin` would be used.
				565	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	566	}
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	567
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	568	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` * `audit_logs_enabled`
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	569	x__xgafv: string, V1 error format.
				570	Allowed values
				571	1 - v1 error format
				572	2 - v2 error format
				573
				574	Returns:
				575	An object of the form:
				576
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	577	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	578	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	579	"a_key": "", # Properties of the object. Contains field @type with type URL.
				580	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	581	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	582	"error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
				583	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	584	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	585	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	586	{
				587	"a_key": "", # Properties of the object. Contains field @type with type URL.
				588	},
				589	],
				590	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	591	"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.
				592	"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`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	593	"a_key": "", # Properties of the object. Contains field @type with type URL.
				594	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	595	}</pre>
				596	</div>
				597
				598	<div class="method">
				599	<code class="details" id="reconfigureTrust">reconfigureTrust(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	600	<pre>Updates the dns conditional forwarder. Operation
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	601
				602	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	603	name: string, The resource domain name, project name and location using the form: `projects/{project_id}/locations/global/domains/{domain_name}` (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	604	body: object, The request body.
				605	The object takes the form of:
				606
				607	{
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	608	"trust": { # 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) # The domain trust resource with updated dns conditional forwarder.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	609	"lastKnownTrustConnectedHeartbeatTime": "A String", # Output only. The last heartbeat time when the trust was known to be connected.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	610	"targetDnsIpAddresses": [ # The target dns server ip addresses which can resolve the remote domain involved in trust.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	611	"A String",
				612	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	613	"stateDescription": "A String", # Output only. Additional information about the current state of this trust, if available.
				614	"trustType": "A String", # The type of trust represented by the trust resource.
				615	"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.
				616	"createTime": "A String", # Output only. The time the instance was created.
				617	"trustHandshakeSecret": "A String", # Input only, and will not be stored. The trust secret used for handshake with target domain.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	618	"targetDomainName": "A String", # The fully qualified target domain name which will be in trust with current domain.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	619	"state": "A String", # Output only. The current state of this trust.
				620	"trustDirection": "A String", # The trust direction decides the current domain is trusted, trusting or both.
				621	"updateTime": "A String", # Output only. Last update time.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	622	},
				623	}
				624
				625	x__xgafv: string, V1 error format.
				626	Allowed values
				627	1 - v1 error format
				628	2 - v2 error format
				629
				630	Returns:
				631	An object of the form:
				632
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	633	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	634	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	635	"a_key": "", # Properties of the object. Contains field @type with type URL.
				636	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	637	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	638	"error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
				639	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	640	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	641	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	642	{
				643	"a_key": "", # Properties of the object. Contains field @type with type URL.
				644	},
				645	],
				646	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	647	"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.
				648	"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`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	649	"a_key": "", # Properties of the object. Contains field @type with type URL.
				650	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	651	}</pre>
				652	</div>
				653
				654	<div class="method">
				655	<code class="details" id="resetAdminPassword">resetAdminPassword(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	656	<pre>Resets managed identities admin password identified by managed_identities_admin_name
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	657
				658	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	659	name: string, The domain resource name using the form: `projects/{project_id}/locations/global/domains/{domain_name}` (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	660	body: object, The request body.
				661	The object takes the form of:
				662
				663	{
				664	}
				665
				666	x__xgafv: string, V1 error format.
				667	Allowed values
				668	1 - v1 error format
				669	2 - v2 error format
				670
				671	Returns:
				672	An object of the form:
				673
				674	{
				675	"password": "A String", # A random password. See admin for more information.
				676	}</pre>
				677	</div>
				678
				679	<div class="method">
				680	<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	681	<pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	682
				683	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	684	resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	685	body: object, The request body.
				686	The object takes the form of:
				687
				688	{ # Request message for `SetIamPolicy` method.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	689	"policy": { # 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/). # 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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	690	"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).
				691	"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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	692	{ # Associates `members` with a `role`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	693	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	694	"condition": { # Represents a textual expression in the Common Expression Language (CEL) 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. # 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).
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	695	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	696	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	697	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				698	"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.
				699	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	700	"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`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	701	"A String",
				702	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	703	"bindingId": "A String",
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	704	},
				705	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	706	"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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	707	},
				708	}
				709
				710	x__xgafv: string, V1 error format.
				711	Allowed values
				712	1 - v1 error format
				713	2 - v2 error format
				714
				715	Returns:
				716	An object of the form:
				717
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	718	{ # 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/).
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	719	"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).
				720	"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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	721	{ # Associates `members` with a `role`.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	722	"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	723	"condition": { # Represents a textual expression in the Common Expression Language (CEL) 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. # 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).
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	724	"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.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	725	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	726	"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
				727	"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.
				728	},
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	729	"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`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	730	"A String",
				731	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	732	"bindingId": "A String",
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	733	},
				734	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	735	"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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	736	}</pre>
				737	</div>
				738
				739	<div class="method">
				740	<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	741	<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.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	742
				743	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	744	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)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	745	body: object, The request body.
				746	The object takes the form of:
				747
				748	{ # Request message for `TestIamPermissions` method.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	749	"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).
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	750	"A String",
				751	],
				752	}
				753
				754	x__xgafv: string, V1 error format.
				755	Allowed values
				756	1 - v1 error format
				757	2 - v2 error format
				758
				759	Returns:
				760	An object of the form:
				761
				762	{ # Response message for `TestIamPermissions` method.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	763	"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	764	"A String",
				765	],
				766	}</pre>
				767	</div>
				768
				769	<div class="method">
				770	<code class="details" id="validateTrust">validateTrust(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	771	<pre>Validate the trust state Operation
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	772
				773	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	774	name: string, The resource domain name, project name, and location using the form: `projects/{project_id}/locations/global/domains/{domain_name}` (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	775	body: object, The request body.
				776	The object takes the form of:
				777
				778	{
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	779	"trust": { # 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) # The domain trust to validate trust state for.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	780	"lastKnownTrustConnectedHeartbeatTime": "A String", # Output only. The last heartbeat time when the trust was known to be connected.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	781	"targetDnsIpAddresses": [ # The target dns server ip addresses which can resolve the remote domain involved in trust.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	782	"A String",
				783	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	784	"stateDescription": "A String", # Output only. Additional information about the current state of this trust, if available.
				785	"trustType": "A String", # The type of trust represented by the trust resource.
				786	"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.
				787	"createTime": "A String", # Output only. The time the instance was created.
				788	"trustHandshakeSecret": "A String", # Input only, and will not be stored. The trust secret used for handshake with target domain.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	789	"targetDomainName": "A String", # The fully qualified target domain name which will be in trust with current domain.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	790	"state": "A String", # Output only. The current state of this trust.
				791	"trustDirection": "A String", # The trust direction decides the current domain is trusted, trusting or both.
				792	"updateTime": "A String", # Output only. Last update time.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	793	},
				794	}
				795
				796	x__xgafv: string, V1 error format.
				797	Allowed values
				798	1 - v1 error format
				799	2 - v2 error format
				800
				801	Returns:
				802	An object of the form:
				803
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	804	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	805	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	806	"a_key": "", # Properties of the object. Contains field @type with type URL.
				807	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	808	"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}`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	809	"error": { # The `Status` type defines a logical error model that is suitable for 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). # The error result of the operation in case of failure or cancellation.
				810	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	811	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	812	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	813	{
				814	"a_key": "", # Properties of the object. Contains field @type with type URL.
				815	},
				816	],
				817	},
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	818	"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.
				819	"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`.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	820	"a_key": "", # Properties of the object. Contains field @type with type URL.
				821	},
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	822	}</pre>
				823	</div>
				824
				825	</body></html>