Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b9f1d0b803b3c5b9a4f6e6b3180a78b445aa450c / . / docs / dyn / androidenterprise_v1.serviceaccountkeys.html
blob: 50aad60dff42e9e61f5754f5146e395edd3b1ca8 [file] [log] [blame]
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#delete">delete(enterpriseId, keyId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Removes and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]84 <code><a href="#insert">insert(enterpriseId, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Generates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount. Only the type of the key should be populated in the resource to be inserted.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]86<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]87 <code><a href="#list">list(enterpriseId, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Lists all active credentials for the service account associated with this enterprise. Only the ID and key type are returned. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.</p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]96 <code class="details" id="delete">delete(enterpriseId, keyId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97 <pre>Removes and invalidates the specified credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]98
99Args:
100 enterpriseId: string, The ID of the enterprise. (required)
101 keyId: string, The ID of the key. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]102 x__xgafv: string, V1 error format.
103 Allowed values
104 1 - v1 error format
105 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]106</pre>
107</div>
108
109<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]110 <code class="details" id="insert">insert(enterpriseId, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]111 <pre>Generates new credentials for the service account associated with this enterprise. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount. Only the type of the key should be populated in the resource to be inserted.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]112
113Args:
114 enterpriseId: string, The ID of the enterprise. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]115 body: object, The request body.
Jon Wayne Parrott7d5badb2016-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.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]119 &quot;data&quot;: &quot;A String&quot;, # The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]120 &quot;id&quot;: &quot;A String&quot;, # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]121 &quot;publicData&quot;: &quot;A String&quot;, # Public key data for the credentials file. This is an X.509 cert. If you are using the googleCredentials key type, this is identical to the cert that can be retrieved by using the X.509 cert url inside of the credentials file.
122 &quot;type&quot;: &quot;A String&quot;, # The file format of the generated key data.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]123}
124
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]125 x__xgafv: string, V1 error format.
126 Allowed values
127 1 - v1 error format
128 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]129
130Returns:
131 An object of the form:
132
133 { # Credentials that can be used to authenticate as a service account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]134 &quot;data&quot;: &quot;A String&quot;, # The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google.
135 &quot;id&quot;: &quot;A String&quot;, # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server.
136 &quot;publicData&quot;: &quot;A String&quot;, # Public key data for the credentials file. This is an X.509 cert. If you are using the googleCredentials key type, this is identical to the cert that can be retrieved by using the X.509 cert url inside of the credentials file.
137 &quot;type&quot;: &quot;A String&quot;, # The file format of the generated key data.
138}</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]139</div>
140
141<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]142 <code class="details" id="list">list(enterpriseId, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]143 <pre>Lists all active credentials for the service account associated with this enterprise. Only the ID and key type are returned. The calling service account must have been retrieved by calling Enterprises.GetServiceAccount and must have been set as the enterprise service account by calling Enterprises.SetAccount.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]144
145Args:
146 enterpriseId: string, The ID of the enterprise. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]147 x__xgafv: string, V1 error format.
148 Allowed values
149 1 - v1 error format
150 2 - v2 error format
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]151
152Returns:
153 An object of the form:
154
155 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]156 &quot;serviceAccountKey&quot;: [ # The service account credentials.
157 { # Credentials that can be used to authenticate as a service account.
158 &quot;data&quot;: &quot;A String&quot;, # The body of the private key credentials file, in string format. This is only populated when the ServiceAccountKey is created, and is not stored by Google.
159 &quot;id&quot;: &quot;A String&quot;, # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server.
160 &quot;publicData&quot;: &quot;A String&quot;, # Public key data for the credentials file. This is an X.509 cert. If you are using the googleCredentials key type, this is identical to the cert that can be retrieved by using the X.509 cert url inside of the credentials file.
161 &quot;type&quot;: &quot;A String&quot;, # The file format of the generated key data.
162 },
163 ],
164}</pre>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]165</div>
166
167</body></html>