Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / androidenterprise_v1.serviceaccountkeys.html
blob: ec97efb634b8c44bb0d7ce0ee73e3592946f9895 [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">
78 <code><a href="#delete">delete(enterpriseId, keyId)</a></code></p>
79<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>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]81 <code><a href="#insert">insert(enterpriseId, body=None)</a></code></p>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]82<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.</p>
83<p class="toc_element">
84 <code><a href="#list">list(enterpriseId)</a></code></p>
85<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>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="delete">delete(enterpriseId, keyId)</code>
89 <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.
90
91Args:
92 enterpriseId: string, The ID of the enterprise. (required)
93 keyId: string, The ID of the key. (required)
94</pre>
95</div>
96
97<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]98 <code class="details" id="insert">insert(enterpriseId, body=None)</code>
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]99 <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.
100
101Only the type of the key should be populated in the resource to be inserted.
102
103Args:
104 enterpriseId: string, The ID of the enterprise. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]105 body: object, The request body.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]106 The object takes the form of:
107
108{ # Credentials that can be used to authenticate as a service account.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]109 "publicData": "A String", # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]110 "kind": "androidenterprise#serviceAccountKey",
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]111 "data": "A String", # 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.
112 "id": "A String", # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]113 "type": "A String", # The file format of the generated key data.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]114}
115
116
117Returns:
118 An object of the form:
119
120 { # Credentials that can be used to authenticate as a service account.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]121 "publicData": "A String", # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122 "kind": "androidenterprise#serviceAccountKey",
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]123 "data": "A String", # 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.
124 "id": "A String", # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]125 "type": "A String", # The file format of the generated key data.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]126 }</pre>
127</div>
128
129<div class="method">
130 <code class="details" id="list">list(enterpriseId)</code>
131 <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.
132
133Args:
134 enterpriseId: string, The ID of the enterprise. (required)
135
136Returns:
137 An object of the form:
138
139 {
140 "serviceAccountKey": [ # The service account credentials.
141 { # Credentials that can be used to authenticate as a service account.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]142 "publicData": "A String", # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]143 "kind": "androidenterprise#serviceAccountKey",
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]144 "data": "A String", # 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.
145 "id": "A String", # An opaque, unique identifier for this ServiceAccountKey. Assigned by the server.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]146 "type": "A String", # The file format of the generated key data.
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]147 },
148 ],
149 }</pre>
150</div>
151
152</body></html>