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