Blame - docs/dyn/iam_v1.projects.roles.html - platform/external/python/google-api-python-client

blob: 4d28a2522277adee26da6163b85cb3d4591164ad [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -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="iam_v1.html">Identity and Access Management (IAM) API</a> . <a href="iam_v1.projects.html">projects</a> . <a href="iam_v1.projects.roles.html">roles</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	78	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	79	<p class="firstline">Creates a new Role.</p>
				80	<p class="toc_element">
				81	<code><a href="#delete">delete(name, etag=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Soft deletes a role. The role is suspended and cannot be used to create new</p>
				83	<p class="toc_element">
				84	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Gets a Role definition.</p>
				86	<p class="toc_element">
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	87	<code><a href="#list">list(parent, pageToken=None, pageSize=None, view=None, showDeleted=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	88	<p class="firstline">Lists the Roles defined on a resource.</p>
				89	<p class="toc_element">
				90	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				91	<p class="firstline">Retrieves the next page of results.</p>
				92	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	93	<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	94	<p class="firstline">Updates a Role definition.</p>
				95	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	<code><a href="#undelete">undelete(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	97	<p class="firstline">Undelete a Role, bringing it back in its previous state.</p>
				98	<h3>Method Details</h3>
				99	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	100	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	101	<pre>Creates a new Role.
				102
				103	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	104	parent: string, The `parent` parameter's value depends on the target resource for the
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	105	request, namely
				106	[`projects`](/iam/reference/rest/v1/projects.roles) or
				107	[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	108	resource type's `parent` value format is described below:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	109
				110	* [`projects.roles.create()`](/iam/reference/rest/v1/projects.roles/create):
				111	`projects/{PROJECT_ID}`. This method creates project-level
				112	[custom roles](/iam/docs/understanding-custom-roles).
				113	Example request URL:
				114	`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles`
				115
				116	* [`organizations.roles.create()`](/iam/reference/rest/v1/organizations.roles/create):
				117	`organizations/{ORGANIZATION_ID}`. This method creates organization-level
				118	[custom roles](/iam/docs/understanding-custom-roles). Example request
				119	URL:
				120	`https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles`
				121
				122	Note: Wildcard (*) values are invalid; you must specify a complete project
				123	ID or organization ID. (required)
				124	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	125	The object takes the form of:
				126
				127	{ # The request to create a new role.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	128	"roleId": "A String", # The role ID to use for this role.
				129	"role": { # A role in the Identity and Access Management API. # The Role resource to create.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	130	"deleted": True or False, # The current deleted state of the role. This field is read only.
				131	# It will be ignored in calls to CreateRole and UpdateRole.
				132	"title": "A String", # Optional. A human-readable title for the role. Typically this
				133	# is limited to 100 UTF-8 bytes.
				134	"includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
				135	"A String",
				136	],
				137	"description": "A String", # Optional. A human-readable description for the role.
				138	"etag": "A String", # Used to perform a consistent read-modify-write.
				139	"stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
				140	# selected for a role, the `stage` field will not be included in the
				141	# returned definition for the role.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	142	"name": "A String", # The name of the role.
				143	#
				144	# When Role is used in CreateRole, the role name must not be set.
				145	#
				146	# When Role is used in output and other input such as UpdateRole, the role
				147	# name is the complete path, e.g., roles/logging.viewer for predefined roles
				148	# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	149	},
				150	}
				151
				152	x__xgafv: string, V1 error format.
				153	Allowed values
				154	1 - v1 error format
				155	2 - v2 error format
				156
				157	Returns:
				158	An object of the form:
				159
				160	{ # A role in the Identity and Access Management API.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	161	"deleted": True or False, # The current deleted state of the role. This field is read only.
				162	# It will be ignored in calls to CreateRole and UpdateRole.
				163	"title": "A String", # Optional. A human-readable title for the role. Typically this
				164	# is limited to 100 UTF-8 bytes.
				165	"includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
				166	"A String",
				167	],
				168	"description": "A String", # Optional. A human-readable description for the role.
				169	"etag": "A String", # Used to perform a consistent read-modify-write.
				170	"stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
				171	# selected for a role, the `stage` field will not be included in the
				172	# returned definition for the role.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	173	"name": "A String", # The name of the role.
				174	#
				175	# When Role is used in CreateRole, the role name must not be set.
				176	#
				177	# When Role is used in output and other input such as UpdateRole, the role
				178	# name is the complete path, e.g., roles/logging.viewer for predefined roles
				179	# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	180	}</pre>
				181	</div>
				182
				183	<div class="method">
				184	<code class="details" id="delete">delete(name, etag=None, x__xgafv=None)</code>
				185	<pre>Soft deletes a role. The role is suspended and cannot be used to create new
				186	IAM Policy Bindings.
				187	The Role will not be included in `ListRoles()` unless `show_deleted` is set
				188	in the `ListRolesRequest`. The Role contains the deleted boolean set.
				189	Existing Bindings remains, but are inactive. The Role can be undeleted
				190	within 7 days. After 7 days the Role is deleted and all Bindings associated
				191	with the role are removed.
				192
				193	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	194	name: string, The `name` parameter's value depends on the target resource for the
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	195	request, namely
				196	[`projects`](/iam/reference/rest/v1/projects.roles) or
				197	[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	198	resource type's `name` value format is described below:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	199
				200	* [`projects.roles.delete()`](/iam/reference/rest/v1/projects.roles/delete):
				201	`projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only
				202	[custom roles](/iam/docs/understanding-custom-roles) that have been
				203	created at the project level. Example request URL:
				204	`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`
				205
				206	* [`organizations.roles.delete()`](/iam/reference/rest/v1/organizations.roles/delete):
				207	`organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
				208	deletes only [custom roles](/iam/docs/understanding-custom-roles) that
				209	have been created at the organization level. Example request URL:
				210	`https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`
				211
				212	Note: Wildcard (*) values are invalid; you must specify a complete project
				213	ID or organization ID. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	214	etag: string, Used to perform a consistent read-modify-write.
				215	x__xgafv: string, V1 error format.
				216	Allowed values
				217	1 - v1 error format
				218	2 - v2 error format
				219
				220	Returns:
				221	An object of the form:
				222
				223	{ # A role in the Identity and Access Management API.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	224	"deleted": True or False, # The current deleted state of the role. This field is read only.
				225	# It will be ignored in calls to CreateRole and UpdateRole.
				226	"title": "A String", # Optional. A human-readable title for the role. Typically this
				227	# is limited to 100 UTF-8 bytes.
				228	"includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
				229	"A String",
				230	],
				231	"description": "A String", # Optional. A human-readable description for the role.
				232	"etag": "A String", # Used to perform a consistent read-modify-write.
				233	"stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
				234	# selected for a role, the `stage` field will not be included in the
				235	# returned definition for the role.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	236	"name": "A String", # The name of the role.
				237	#
				238	# When Role is used in CreateRole, the role name must not be set.
				239	#
				240	# When Role is used in output and other input such as UpdateRole, the role
				241	# name is the complete path, e.g., roles/logging.viewer for predefined roles
				242	# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	243	}</pre>
				244	</div>
				245
				246	<div class="method">
				247	<code class="details" id="get">get(name, x__xgafv=None)</code>
				248	<pre>Gets a Role definition.
				249
				250	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	251	name: string, The `name` parameter's value depends on the target resource for the
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	252	request, namely
				253	[`roles`](/iam/reference/rest/v1/roles),
				254	[`projects`](/iam/reference/rest/v1/projects.roles), or
				255	[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	256	resource type's `name` value format is described below:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	257
				258	* [`roles.get()`](/iam/reference/rest/v1/roles/get): `roles/{ROLE_NAME}`.
				259	This method returns results from all
				260	[predefined roles](/iam/docs/understanding-roles#predefined_roles) in
				261	Cloud IAM. Example request URL:
				262	`https://iam.googleapis.com/v1/roles/{ROLE_NAME}`
				263
				264	* [`projects.roles.get()`](/iam/reference/rest/v1/projects.roles/get):
				265	`projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method returns only
				266	[custom roles](/iam/docs/understanding-custom-roles) that have been
				267	created at the project level. Example request URL:
				268	`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`
				269
				270	* [`organizations.roles.get()`](/iam/reference/rest/v1/organizations.roles/get):
				271	`organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
				272	returns only [custom roles](/iam/docs/understanding-custom-roles) that
				273	have been created at the organization level. Example request URL:
				274	`https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`
				275
				276	Note: Wildcard (*) values are invalid; you must specify a complete project
				277	ID or organization ID. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	278	x__xgafv: string, V1 error format.
				279	Allowed values
				280	1 - v1 error format
				281	2 - v2 error format
				282
				283	Returns:
				284	An object of the form:
				285
				286	{ # A role in the Identity and Access Management API.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	287	"deleted": True or False, # The current deleted state of the role. This field is read only.
				288	# It will be ignored in calls to CreateRole and UpdateRole.
				289	"title": "A String", # Optional. A human-readable title for the role. Typically this
				290	# is limited to 100 UTF-8 bytes.
				291	"includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
				292	"A String",
				293	],
				294	"description": "A String", # Optional. A human-readable description for the role.
				295	"etag": "A String", # Used to perform a consistent read-modify-write.
				296	"stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
				297	# selected for a role, the `stage` field will not be included in the
				298	# returned definition for the role.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	299	"name": "A String", # The name of the role.
				300	#
				301	# When Role is used in CreateRole, the role name must not be set.
				302	#
				303	# When Role is used in output and other input such as UpdateRole, the role
				304	# name is the complete path, e.g., roles/logging.viewer for predefined roles
				305	# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	306	}</pre>
				307	</div>
				308
				309	<div class="method">
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	310	<code class="details" id="list">list(parent, pageToken=None, pageSize=None, view=None, showDeleted=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	311	<pre>Lists the Roles defined on a resource.
				312
				313	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	314	parent: string, The `parent` parameter's value depends on the target resource for the
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	315	request, namely
				316	[`roles`](/iam/reference/rest/v1/roles),
				317	[`projects`](/iam/reference/rest/v1/projects.roles), or
				318	[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	319	resource type's `parent` value format is described below:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	320
				321	* [`roles.list()`](/iam/reference/rest/v1/roles/list): An empty string.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	322	This method doesn't require a resource; it simply returns all
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	323	[predefined roles](/iam/docs/understanding-roles#predefined_roles) in
				324	Cloud IAM. Example request URL:
				325	`https://iam.googleapis.com/v1/roles`
				326
				327	* [`projects.roles.list()`](/iam/reference/rest/v1/projects.roles/list):
				328	`projects/{PROJECT_ID}`. This method lists all project-level
				329	[custom roles](/iam/docs/understanding-custom-roles).
				330	Example request URL:
				331	`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles`
				332
				333	* [`organizations.roles.list()`](/iam/reference/rest/v1/organizations.roles/list):
				334	`organizations/{ORGANIZATION_ID}`. This method lists all
				335	organization-level [custom roles](/iam/docs/understanding-custom-roles).
				336	Example request URL:
				337	`https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles`
				338
				339	Note: Wildcard (*) values are invalid; you must specify a complete project
				340	ID or organization ID. (required)
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	341	pageToken: string, Optional pagination token returned in an earlier ListRolesResponse.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	342	pageSize: integer, Optional limit on the number of roles to include in the response.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	343	view: string, Optional view for the returned Role objects. When `FULL` is specified,
				344	the `includedPermissions` field is returned, which includes a list of all
				345	permissions in the role. The default value is `BASIC`, which does not
				346	return the `includedPermissions` field.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	347	showDeleted: boolean, Include Roles that have been deleted.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	348	x__xgafv: string, V1 error format.
				349	Allowed values
				350	1 - v1 error format
				351	2 - v2 error format
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	352
				353	Returns:
				354	An object of the form:
				355
				356	{ # The response containing the roles defined under a resource.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	357	"roles": [ # The Roles defined on this resource.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	358	{ # A role in the Identity and Access Management API.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	359	"deleted": True or False, # The current deleted state of the role. This field is read only.
				360	# It will be ignored in calls to CreateRole and UpdateRole.
				361	"title": "A String", # Optional. A human-readable title for the role. Typically this
				362	# is limited to 100 UTF-8 bytes.
				363	"includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
				364	"A String",
				365	],
				366	"description": "A String", # Optional. A human-readable description for the role.
				367	"etag": "A String", # Used to perform a consistent read-modify-write.
				368	"stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
				369	# selected for a role, the `stage` field will not be included in the
				370	# returned definition for the role.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	371	"name": "A String", # The name of the role.
				372	#
				373	# When Role is used in CreateRole, the role name must not be set.
				374	#
				375	# When Role is used in output and other input such as UpdateRole, the role
				376	# name is the complete path, e.g., roles/logging.viewer for predefined roles
				377	# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	378	},
				379	],
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	380	"nextPageToken": "A String", # To retrieve the next page of results, set
				381	# `ListRolesRequest.page_token` to this value.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	382	}</pre>
				383	</div>
				384
				385	<div class="method">
				386	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				387	<pre>Retrieves the next page of results.
				388
				389	Args:
				390	previous_request: The request for the previous page. (required)
				391	previous_response: The response from the request for the previous page. (required)
				392
				393	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	394	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	395	page. Returns None if there are no more items in the collection.
				396	</pre>
				397	</div>
				398
				399	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	400	<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	401	<pre>Updates a Role definition.
				402
				403	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	404	name: string, The `name` parameter's value depends on the target resource for the
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	405	request, namely
				406	[`projects`](/iam/reference/rest/v1/projects.roles) or
				407	[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	408	resource type's `name` value format is described below:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	409
				410	* [`projects.roles.patch()`](/iam/reference/rest/v1/projects.roles/patch):
				411	`projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method updates only
				412	[custom roles](/iam/docs/understanding-custom-roles) that have been
				413	created at the project level. Example request URL:
				414	`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`
				415
				416	* [`organizations.roles.patch()`](/iam/reference/rest/v1/organizations.roles/patch):
				417	`organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
				418	updates only [custom roles](/iam/docs/understanding-custom-roles) that
				419	have been created at the organization level. Example request URL:
				420	`https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`
				421
				422	Note: Wildcard (*) values are invalid; you must specify a complete project
				423	ID or organization ID. (required)
				424	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	425	The object takes the form of:
				426
				427	{ # A role in the Identity and Access Management API.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	428	"deleted": True or False, # The current deleted state of the role. This field is read only.
				429	# It will be ignored in calls to CreateRole and UpdateRole.
				430	"title": "A String", # Optional. A human-readable title for the role. Typically this
				431	# is limited to 100 UTF-8 bytes.
				432	"includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
				433	"A String",
				434	],
				435	"description": "A String", # Optional. A human-readable description for the role.
				436	"etag": "A String", # Used to perform a consistent read-modify-write.
				437	"stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
				438	# selected for a role, the `stage` field will not be included in the
				439	# returned definition for the role.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	440	"name": "A String", # The name of the role.
				441	#
				442	# When Role is used in CreateRole, the role name must not be set.
				443	#
				444	# When Role is used in output and other input such as UpdateRole, the role
				445	# name is the complete path, e.g., roles/logging.viewer for predefined roles
				446	# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	447	}
				448
				449	updateMask: string, A mask describing which fields in the Role have changed.
				450	x__xgafv: string, V1 error format.
				451	Allowed values
				452	1 - v1 error format
				453	2 - v2 error format
				454
				455	Returns:
				456	An object of the form:
				457
				458	{ # A role in the Identity and Access Management API.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	459	"deleted": True or False, # The current deleted state of the role. This field is read only.
				460	# It will be ignored in calls to CreateRole and UpdateRole.
				461	"title": "A String", # Optional. A human-readable title for the role. Typically this
				462	# is limited to 100 UTF-8 bytes.
				463	"includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
				464	"A String",
				465	],
				466	"description": "A String", # Optional. A human-readable description for the role.
				467	"etag": "A String", # Used to perform a consistent read-modify-write.
				468	"stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
				469	# selected for a role, the `stage` field will not be included in the
				470	# returned definition for the role.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	471	"name": "A String", # The name of the role.
				472	#
				473	# When Role is used in CreateRole, the role name must not be set.
				474	#
				475	# When Role is used in output and other input such as UpdateRole, the role
				476	# name is the complete path, e.g., roles/logging.viewer for predefined roles
				477	# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	478	}</pre>
				479	</div>
				480
				481	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	482	<code class="details" id="undelete">undelete(name, body=None, x__xgafv=None)</code>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	483	<pre>Undelete a Role, bringing it back in its previous state.
				484
				485	Args:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	486	name: string, The `name` parameter's value depends on the target resource for the
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	487	request, namely
				488	[`projects`](/iam/reference/rest/v1/projects.roles) or
				489	[`organizations`](/iam/reference/rest/v1/organizations.roles). Each
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	490	resource type's `name` value format is described below:
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	491
				492	* [`projects.roles.undelete()`](/iam/reference/rest/v1/projects.roles/undelete):
				493	`projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method undeletes
				494	only [custom roles](/iam/docs/understanding-custom-roles) that have been
				495	created at the project level. Example request URL:
				496	`https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`
				497
				498	* [`organizations.roles.undelete()`](/iam/reference/rest/v1/organizations.roles/undelete):
				499	`organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method
				500	undeletes only [custom roles](/iam/docs/understanding-custom-roles) that
				501	have been created at the organization level. Example request URL:
				502	`https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`
				503
				504	Note: Wildcard (*) values are invalid; you must specify a complete project
				505	ID or organization ID. (required)
				506	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	507	The object takes the form of:
				508
				509	{ # The request to undelete an existing role.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	510	"etag": "A String", # Used to perform a consistent read-modify-write.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	511	}
				512
				513	x__xgafv: string, V1 error format.
				514	Allowed values
				515	1 - v1 error format
				516	2 - v2 error format
				517
				518	Returns:
				519	An object of the form:
				520
				521	{ # A role in the Identity and Access Management API.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	522	"deleted": True or False, # The current deleted state of the role. This field is read only.
				523	# It will be ignored in calls to CreateRole and UpdateRole.
				524	"title": "A String", # Optional. A human-readable title for the role. Typically this
				525	# is limited to 100 UTF-8 bytes.
				526	"includedPermissions": [ # The names of the permissions this role grants when bound in an IAM policy.
				527	"A String",
				528	],
				529	"description": "A String", # Optional. A human-readable description for the role.
				530	"etag": "A String", # Used to perform a consistent read-modify-write.
				531	"stage": "A String", # The current launch stage of the role. If the `ALPHA` launch stage has been
				532	# selected for a role, the `stage` field will not be included in the
				533	# returned definition for the role.
Bu Sun Kim	4ed7d3f	2020-05-27 12:20:54 -0700	[diff] [blame^]	534	"name": "A String", # The name of the role.
				535	#
				536	# When Role is used in CreateRole, the role name must not be set.
				537	#
				538	# When Role is used in output and other input such as UpdateRole, the role
				539	# name is the complete path, e.g., roles/logging.viewer for predefined roles
				540	# and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	541	}</pre>
				542	</div>
				543
				544	</body></html>