Blame - docs/dyn/cloudidentity_v1beta1.customers.userinvitations.html - platform/external/python/google-api-python-client

blob: 1e26f6b83027b73c6a8e5599bd2d87661b1047c0 [file] [log] [blame]

yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -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="cloudidentity_v1beta1.html">Cloud Identity API</a> . <a href="cloudidentity_v1beta1.customers.html">customers</a> . <a href="cloudidentity_v1beta1.customers.userinvitations.html">userinvitations</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="#cancel">cancel(name, body=None, x__xgafv=None)</a></code></p>
				79	<p class="firstline">Cancels a UserInvitation that was already sent.</p>
				80	<p class="toc_element">
				81	<code><a href="#close">close()</a></code></p>
				82	<p class="firstline">Close httplib2 connections.</p>
				83	<p class="toc_element">
				84	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	85	<p class="firstline">Retrieves a UserInvitation resource. Note: New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.</p>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	86	<p class="toc_element">
				87	<code><a href="#isInvitableUser">isInvitableUser(name, x__xgafv=None)</a></code></p>
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	88	<p class="firstline">Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account). Eligibility is based on the following criteria: * the email address is a consumer account and it's the primary email address of the account, and * the domain of the email address matches an existing verified Google Workspace or Cloud Identity domain If both conditions are met, the user is eligible. Note: This method is not supported for Workspace Essentials customers.</p>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	89	<p class="toc_element">
				90	<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	91	<p class="firstline">Retrieves a list of UserInvitation resources. Note: New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.</p>
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	92	<p class="toc_element">
				93	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				94	<p class="firstline">Retrieves the next page of results.</p>
				95	<p class="toc_element">
				96	<code><a href="#send">send(name, body=None, x__xgafv=None)</a></code></p>
				97	<p class="firstline">Sends a UserInvitation to email. If the `UserInvitation` does not exist for this request and it is a valid request, the request creates a `UserInvitation`. Note: The `get` and `list` methods have a 48-hour delay where newly-created consumer accounts will not appear in the results. You can still send a `UserInvitation` to those accounts if you know the unmanaged email address and IsInvitableUser==True.</p>
				98	<h3>Method Details</h3>
				99	<div class="method">
				100	<code class="details" id="cancel">cancel(name, body=None, x__xgafv=None)</code>
				101	<pre>Cancels a UserInvitation that was already sent.
				102
				103	Args:
				104	name: string, Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}` (required)
				105	body: object, The request body.
				106	The object takes the form of:
				107
				108	{ # Request to cancel sent invitation for target email in UserInvitation.
				109	}
				110
				111	x__xgafv: string, V1 error format.
				112	Allowed values
				113	1 - v1 error format
				114	2 - v2 error format
				115
				116	Returns:
				117	An object of the form:
				118
				119	{ # This resource represents a long-running operation that is the result of a network API call.
				120	"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.
				121	"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.
				122	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				123	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				124	{
				125	"a_key": "", # Properties of the object. Contains field @type with type URL.
				126	},
				127	],
				128	"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.
				129	},
				130	"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.
				131	"a_key": "", # Properties of the object. Contains field @type with type URL.
				132	},
				133	"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}`.
				134	"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`.
				135	"a_key": "", # Properties of the object. Contains field @type with type URL.
				136	},
				137	}</pre>
				138	</div>
				139
				140	<div class="method">
				141	<code class="details" id="close">close()</code>
				142	<pre>Close httplib2 connections.</pre>
				143	</div>
				144
				145	<div class="method">
				146	<code class="details" id="get">get(name, x__xgafv=None)</code>
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	147	<pre>Retrieves a UserInvitation resource. Note: New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	148
				149	Args:
				150	name: string, Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}` (required)
				151	x__xgafv: string, V1 error format.
				152	Allowed values
				153	1 - v1 error format
				154	2 - v2 error format
				155
				156	Returns:
				157	An object of the form:
				158
				159	{ # The `UserInvitation` resource represents an email that can be sent to an unmanaged user account inviting them to join the customer’s Google Workspace or Cloud Identity account. An unmanaged account shares an email address domain with the Google Workspace or Cloud Identity account but is not managed by it yet. If the user accepts the `UserInvitation`, the user account will become managed.
				160	"mailsSentCount": "A String", # Number of invitation emails sent to the user.
				161	"name": "A String", # Shall be of the form `customers/{customer}/userinvitations/{user_email_address}`.
				162	"state": "A String", # State of the `UserInvitation`.
				163	"updateTime": "A String", # Time when the `UserInvitation` was last updated.
				164	}</pre>
				165	</div>
				166
				167	<div class="method">
				168	<code class="details" id="isInvitableUser">isInvitableUser(name, x__xgafv=None)</code>
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	169	<pre>Verifies whether a user account is eligible to receive a UserInvitation (is an unmanaged account). Eligibility is based on the following criteria: * the email address is a consumer account and it's the primary email address of the account, and * the domain of the email address matches an existing verified Google Workspace or Cloud Identity domain If both conditions are met, the user is eligible. Note: This method is not supported for Workspace Essentials customers.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	170
				171	Args:
				172	name: string, Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}` (required)
				173	x__xgafv: string, V1 error format.
				174	Allowed values
				175	1 - v1 error format
				176	2 - v2 error format
				177
				178	Returns:
				179	An object of the form:
				180
				181	{ # Response for IsInvitableUser RPC.
				182	"isInvitableUser": True or False, # Returns true if the email address is invitable.
				183	}</pre>
				184	</div>
				185
				186	<div class="method">
				187	<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	188	<pre>Retrieves a list of UserInvitation resources. Note: New consumer accounts with the customer's verified domain created within the previous 48 hours will not appear in the result. This delay also applies to newly-verified domains.
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	189
				190	Args:
				191	parent: string, Required. The customer ID of the Google Workspace or Cloud Identity account the UserInvitation resources are associated with. (required)
				192	filter: string, Optional. A query string for filtering `UserInvitation` results by their current state, in the format: `"state=='invited'"`.
				193	orderBy: string, Optional. The sort order of the list results. You can sort the results in descending order based on either email or last update timestamp but not both, using `order_by="email desc"`. Currently, sorting is supported for `update_time asc`, `update_time desc`, `email asc`, and `email desc`. If not specified, results will be returned based on `email asc` order.
				194	pageSize: integer, Optional. The maximum number of UserInvitation resources to return. If unspecified, at most 100 resources will be returned. The maximum value is 200; values above 200 will be set to 200.
				195	pageToken: string, Optional. A page token, received from a previous `ListUserInvitations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBooks` must match the call that provided the page token.
				196	x__xgafv: string, V1 error format.
				197	Allowed values
				198	1 - v1 error format
				199	2 - v2 error format
				200
				201	Returns:
				202	An object of the form:
				203
				204	{ # Response message for UserInvitation listing request.
				205	"nextPageToken": "A String", # The token for the next page. If not empty, indicates that there may be more `UserInvitation` resources that match the listing request; this value can be used in a subsequent ListUserInvitationsRequest to get continued results with the current list call.
				206	"userInvitations": [ # The list of UserInvitation resources.
				207	{ # The `UserInvitation` resource represents an email that can be sent to an unmanaged user account inviting them to join the customer’s Google Workspace or Cloud Identity account. An unmanaged account shares an email address domain with the Google Workspace or Cloud Identity account but is not managed by it yet. If the user accepts the `UserInvitation`, the user account will become managed.
				208	"mailsSentCount": "A String", # Number of invitation emails sent to the user.
				209	"name": "A String", # Shall be of the form `customers/{customer}/userinvitations/{user_email_address}`.
				210	"state": "A String", # State of the `UserInvitation`.
				211	"updateTime": "A String", # Time when the `UserInvitation` was last updated.
				212	},
				213	],
				214	}</pre>
				215	</div>
				216
				217	<div class="method">
				218	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				219	<pre>Retrieves the next page of results.
				220
				221	Args:
				222	previous_request: The request for the previous page. (required)
				223	previous_response: The response from the request for the previous page. (required)
				224
				225	Returns:
				226	A request object that you can call 'execute()' on to request the next
				227	page. Returns None if there are no more items in the collection.
				228	</pre>
				229	</div>
				230
				231	<div class="method">
				232	<code class="details" id="send">send(name, body=None, x__xgafv=None)</code>
				233	<pre>Sends a UserInvitation to email. If the `UserInvitation` does not exist for this request and it is a valid request, the request creates a `UserInvitation`. Note: The `get` and `list` methods have a 48-hour delay where newly-created consumer accounts will not appear in the results. You can still send a `UserInvitation` to those accounts if you know the unmanaged email address and IsInvitableUser==True.
				234
				235	Args:
				236	name: string, Required. `UserInvitation` name in the format `customers/{customer}/userinvitations/{user_email_address}` (required)
				237	body: object, The request body.
				238	The object takes the form of:
				239
				240	{ # A request to send email for inviting target user corresponding to the UserInvitation.
				241	}
				242
				243	x__xgafv: string, V1 error format.
				244	Allowed values
				245	1 - v1 error format
				246	2 - v2 error format
				247
				248	Returns:
				249	An object of the form:
				250
				251	{ # This resource represents a long-running operation that is the result of a network API call.
				252	"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.
				253	"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.
				254	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				255	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				256	{
				257	"a_key": "", # Properties of the object. Contains field @type with type URL.
				258	},
				259	],
				260	"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.
				261	},
				262	"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.
				263	"a_key": "", # Properties of the object. Contains field @type with type URL.
				264	},
				265	"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}`.
				266	"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`.
				267	"a_key": "", # Properties of the object. Contains field @type with type URL.
				268	},
				269	}</pre>
				270	</div>
				271
				272	</body></html>