Blame - docs/dyn/androidenterprise_v1.serviceaccountkeys.html - platform/external/python/google-api-python-client

blob: 79961d0a125877a2a67bd5d4e30685c24fd8cd82 [file] [log] [blame]

Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -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="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.serviceaccountkeys.html">serviceaccountkeys</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	78	<code><a href="#delete">delete(enterpriseId, keyId, x__xgafv=None)</a></code></p>
				79	<p class="firstline">Removes and invalidates the specified credentials for the service account</p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	80	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	81	<code><a href="#insert">insert(enterpriseId, body=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Generates new credentials for the service account associated with this</p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	83	<p class="toc_element">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	84	<code><a href="#list">list(enterpriseId, x__xgafv=None)</a></code></p>
				85	<p class="firstline">Lists all active credentials for the service account associated with this</p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	86	<h3>Method Details</h3>
				87	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	88	<code class="details" id="delete">delete(enterpriseId, keyId, x__xgafv=None)</code>
				89	<pre>Removes and invalidates the specified credentials for the service account
				90	associated with this enterprise. The calling service account must have been
				91	retrieved by calling Enterprises.GetServiceAccount and must have been set
				92	as the enterprise service account by calling Enterprises.SetAccount.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	93
				94	Args:
				95	enterpriseId: string, The ID of the enterprise. (required)
				96	keyId: string, The ID of the key. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	97	x__xgafv: string, V1 error format.
				98	Allowed values
				99	1 - v1 error format
				100	2 - v2 error format
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	101	</pre>
				102	</div>
				103
				104	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	105	<code class="details" id="insert">insert(enterpriseId, body=None, x__xgafv=None)</code>
				106	<pre>Generates new credentials for the service account associated with this
				107	enterprise. The calling service account must have been retrieved by calling
				108	Enterprises.GetServiceAccount and must have been set as the enterprise
				109	service account by calling Enterprises.SetAccount. <br><br>
				110	Only the type of the key should be populated in the resource to be
				111	inserted.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	112
				113	Args:
				114	enterpriseId: string, The ID of the enterprise. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	115	body: object, The request body.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	116	The object takes the form of:
				117
				118	{ # Credentials that can be used to authenticate as a service account.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	119	"data": "A String", # The body of the private key credentials file, in string format. This
				120	# is only populated when the ServiceAccountKey is created, and is not stored
				121	# by Google.
				122	"publicData": "A String", # Public key data for the credentials file. This is an X.509 cert. If you are
				123	# using the <code>googleCredentials</code> key type, this is identical to the
				124	# cert that can be retrieved by using the X.509 cert url inside of the
				125	# credentials file.
				126	"id": "A String", # An opaque, unique identifier for this ServiceAccountKey.
				127	# Assigned by the server.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	128	"type": "A String", # The file format of the generated key data.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	129	}
				130
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	131	x__xgafv: string, V1 error format.
				132	Allowed values
				133	1 - v1 error format
				134	2 - v2 error format
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	135
				136	Returns:
				137	An object of the form:
				138
				139	{ # Credentials that can be used to authenticate as a service account.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	140	"data": "A String", # The body of the private key credentials file, in string format. This
				141	# is only populated when the ServiceAccountKey is created, and is not stored
				142	# by Google.
				143	"publicData": "A String", # Public key data for the credentials file. This is an X.509 cert. If you are
				144	# using the <code>googleCredentials</code> key type, this is identical to the
				145	# cert that can be retrieved by using the X.509 cert url inside of the
				146	# credentials file.
				147	"id": "A String", # An opaque, unique identifier for this ServiceAccountKey.
				148	# Assigned by the server.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	149	"type": "A String", # The file format of the generated key data.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	150	}</pre>
				151	</div>
				152
				153	<div class="method">
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	154	<code class="details" id="list">list(enterpriseId, x__xgafv=None)</code>
				155	<pre>Lists all active credentials for the service account associated with this
				156	enterprise. Only the ID and key type are returned. The calling service
				157	account must have been retrieved by calling Enterprises.GetServiceAccount
				158	and must have been set as the enterprise service account by calling
				159	Enterprises.SetAccount.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	160
				161	Args:
				162	enterpriseId: string, The ID of the enterprise. (required)
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	163	x__xgafv: string, V1 error format.
				164	Allowed values
				165	1 - v1 error format
				166	2 - v2 error format
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	167
				168	Returns:
				169	An object of the form:
				170
				171	{
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	172	"serviceAccountKey": [ # The service account credentials.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	173	{ # Credentials that can be used to authenticate as a service account.
Bu Sun Kim	d059ad8	2020-07-22 17:02:09 -0700	[diff] [blame]	174	"data": "A String", # The body of the private key credentials file, in string format. This
				175	# is only populated when the ServiceAccountKey is created, and is not stored
				176	# by Google.
				177	"publicData": "A String", # Public key data for the credentials file. This is an X.509 cert. If you are
				178	# using the <code>googleCredentials</code> key type, this is identical to the
				179	# cert that can be retrieved by using the X.509 cert url inside of the
				180	# credentials file.
				181	"id": "A String", # An opaque, unique identifier for this ServiceAccountKey.
				182	# Assigned by the server.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	183	"type": "A String", # The file format of the generated key data.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	184	},
				185	],
				186	}</pre>
				187	</div>
				188
				189	</body></html>