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

blob: 89b9e64425d916333ac2136704ccd7f56195d0a1 [file] [log] [blame]

Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[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
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	75	<h1><a href="iam_v1.html">Google Identity and Access Management (IAM) API</a> . <a href="iam_v1.projects.html">projects</a> . <a href="iam_v1.projects.serviceAccounts.html">serviceAccounts</a> . <a href="iam_v1.projects.serviceAccounts.keys.html">keys</a></h1>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	78	<code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	79	<p class="firstline">Creates a ServiceAccountKey</p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	80	<p class="toc_element">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	81	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	82	<p class="firstline">Deletes a ServiceAccountKey.</p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	83	<p class="toc_element">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	84	<code><a href="#get">get(name, publicKeyType=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	85	<p class="firstline">Gets the ServiceAccountKey</p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	86	<p class="toc_element">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	87	<code><a href="#list">list(name, keyTypes=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	88	<p class="firstline">Lists ServiceAccountKeys.</p>
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	89	<h3>Method Details</h3>
				90	<div class="method">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	91	<code class="details" id="create">create(name, body, x__xgafv=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	92	<pre>Creates a ServiceAccountKey
				93	and returns it.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	94
				95	Args:
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	96	name: string, The resource name of the service account in the following format:
				97	`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.
				98	Using `-` as a wildcard for the project will infer the project from
				99	the account. The `account` value can be the `email` address or the
				100	`unique_id` of the service account. (required)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	101	body: object, The request body. (required)
				102	The object takes the form of:
				103
				104	{ # The service account key create request.
Sai Cheemalapati	4ba8c23	2017-06-06 18:46:08 -0400	[diff] [blame]	105	"includePublicKeyData": True or False,
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	106	"keyAlgorithm": "A String", # Which type of key and algorithm to use for the key.
				107	# The default is currently a 2K RSA key. However this may change in the
				108	# future.
				109	"privateKeyType": "A String", # The output format of the private key. `GOOGLE_CREDENTIALS_FILE` is the
				110	# default output format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	111	}
				112
				113	x__xgafv: string, V1 error format.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	114	Allowed values
				115	1 - v1 error format
				116	2 - v2 error format
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	117
				118	Returns:
				119	An object of the form:
				120
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	121	{ # Represents a service account key.
				122	#
				123	# A service account has two sets of key-pairs: user-managed, and
				124	# system-managed.
				125	#
				126	# User-managed key-pairs can be created and deleted by users. Users are
				127	# responsible for rotating these keys periodically to ensure security of
				128	# their service accounts. Users retain the private key of these key-pairs,
				129	# and Google retains ONLY the public key.
				130	#
				131	# System-managed key-pairs are managed automatically by Google, and rotated
				132	# daily without user intervention. The private key never leaves Google's
				133	# servers to maximize security.
				134	#
				135	# Public keys for all service accounts are also published at the OAuth2
				136	# Service Account API.
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	137	"name": "A String", # The resource name of the service account key in the following format
				138	# `projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.
				139	"validBeforeTime": "A String", # The key can be used before this timestamp.
				140	"keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	141	"privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey`
				142	# responses.
				143	"privateKeyType": "A String", # The output format for the private key.
				144	# Only provided in `CreateServiceAccountKey` responses, not
				145	# in `GetServiceAccountKey` or `ListServiceAccountKey` responses.
				146	#
				147	# Google never exposes system-managed private keys, and never retains
				148	# user-managed private keys.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	149	"publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	150	"validAfterTime": "A String", # The key can be used after this timestamp.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	151	}</pre>
				152	</div>
				153
				154	<div class="method">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	155	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	156	<pre>Deletes a ServiceAccountKey.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	157
				158	Args:
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	159	name: string, The resource name of the service account key in the following format:
				160	`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.
				161	Using `-` as a wildcard for the project will infer the project from
				162	the account. The `account` value can be the `email` address or the
				163	`unique_id` of the service account. (required)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	164	x__xgafv: string, V1 error format.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	165	Allowed values
				166	1 - v1 error format
				167	2 - v2 error format
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	168
				169	Returns:
				170	An object of the form:
				171
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	172	{ # A generic empty message that you can re-use to avoid defining duplicated
				173	# empty messages in your APIs. A typical example is to use it as the request
				174	# or the response type of an API method. For instance:
				175	#
				176	# service Foo {
				177	# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
				178	# }
				179	#
				180	# The JSON representation for `Empty` is empty JSON object `{}`.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	181	}</pre>
				182	</div>
				183
				184	<div class="method">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	185	<code class="details" id="get">get(name, publicKeyType=None, x__xgafv=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	186	<pre>Gets the ServiceAccountKey
				187	by key id.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	188
				189	Args:
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	190	name: string, The resource name of the service account key in the following format:
				191	`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.
				192
				193	Using `-` as a wildcard for the project will infer the project from
				194	the account. The `account` value can be the `email` address or the
				195	`unique_id` of the service account. (required)
				196	publicKeyType: string, The output format of the public key requested.
				197	X509_PEM is the default output format.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	198	x__xgafv: string, V1 error format.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	199	Allowed values
				200	1 - v1 error format
				201	2 - v2 error format
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	202
				203	Returns:
				204	An object of the form:
				205
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	206	{ # Represents a service account key.
				207	#
				208	# A service account has two sets of key-pairs: user-managed, and
				209	# system-managed.
				210	#
				211	# User-managed key-pairs can be created and deleted by users. Users are
				212	# responsible for rotating these keys periodically to ensure security of
				213	# their service accounts. Users retain the private key of these key-pairs,
				214	# and Google retains ONLY the public key.
				215	#
				216	# System-managed key-pairs are managed automatically by Google, and rotated
				217	# daily without user intervention. The private key never leaves Google's
				218	# servers to maximize security.
				219	#
				220	# Public keys for all service accounts are also published at the OAuth2
				221	# Service Account API.
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	222	"name": "A String", # The resource name of the service account key in the following format
				223	# `projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.
				224	"validBeforeTime": "A String", # The key can be used before this timestamp.
				225	"keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	226	"privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey`
				227	# responses.
				228	"privateKeyType": "A String", # The output format for the private key.
				229	# Only provided in `CreateServiceAccountKey` responses, not
				230	# in `GetServiceAccountKey` or `ListServiceAccountKey` responses.
				231	#
				232	# Google never exposes system-managed private keys, and never retains
				233	# user-managed private keys.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	234	"publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	235	"validAfterTime": "A String", # The key can be used after this timestamp.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	236	}</pre>
				237	</div>
				238
				239	<div class="method">
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	240	<code class="details" id="list">list(name, keyTypes=None, x__xgafv=None)</code>
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	241	<pre>Lists ServiceAccountKeys.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	242
				243	Args:
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	244	name: string, The resource name of the service account in the following format:
				245	`projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}`.
				246
				247	Using `-` as a wildcard for the project, will infer the project from
				248	the account. The `account` value can be the `email` address or the
				249	`unique_id` of the service account. (required)
				250	keyTypes: string, Filters the types of keys the user wants to include in the list
				251	response. Duplicate key types are not allowed. If no key type
				252	is provided, all keys are returned. (repeated)
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	253	x__xgafv: string, V1 error format.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	254	Allowed values
				255	1 - v1 error format
				256	2 - v2 error format
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	257
				258	Returns:
				259	An object of the form:
				260
				261	{ # The service account keys list response.
				262	"keys": [ # The public keys for the service account.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	263	{ # Represents a service account key.
				264	#
				265	# A service account has two sets of key-pairs: user-managed, and
				266	# system-managed.
				267	#
				268	# User-managed key-pairs can be created and deleted by users. Users are
				269	# responsible for rotating these keys periodically to ensure security of
				270	# their service accounts. Users retain the private key of these key-pairs,
				271	# and Google retains ONLY the public key.
				272	#
				273	# System-managed key-pairs are managed automatically by Google, and rotated
				274	# daily without user intervention. The private key never leaves Google's
				275	# servers to maximize security.
				276	#
				277	# Public keys for all service accounts are also published at the OAuth2
				278	# Service Account API.
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	279	"name": "A String", # The resource name of the service account key in the following format
				280	# `projects/{PROJECT_ID}/serviceAccounts/{SERVICE_ACCOUNT_EMAIL}/keys/{key}`.
				281	"validBeforeTime": "A String", # The key can be used before this timestamp.
				282	"keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	283	"privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey`
				284	# responses.
				285	"privateKeyType": "A String", # The output format for the private key.
				286	# Only provided in `CreateServiceAccountKey` responses, not
				287	# in `GetServiceAccountKey` or `ListServiceAccountKey` responses.
				288	#
				289	# Google never exposes system-managed private keys, and never retains
				290	# user-managed private keys.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	291	"publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
Thomas Coffee	2f24537	2017-03-27 10:39:26 -0700	[diff] [blame]	292	"validAfterTime": "A String", # The key can be used after this timestamp.
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	293	},
				294	],
				295	}</pre>
				296	</div>
				297
				298	</body></html>