Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 860a6378c538d8e2e424c7be150b41ba28120387 / . / docs / dyn / iam_v1.projects.serviceAccounts.keys.html
blob: 8532552a16e9971529ae85d928cfa2ea592bd143 [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">
78 <code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]79<p class="firstline">Creates a ServiceAccountKey and returns it.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]80<p class="toc_element">
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">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]84 <code><a href="#get">get(name, publicKeyType=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]85<p class="firstline">Gets the ServiceAccountKey by key id.</p>
86<p class="toc_element">
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">
91 <code class="details" id="create">create(name, body, x__xgafv=None)</code>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]92 <pre>Creates a ServiceAccountKey and returns it.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]93
94Args:
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]95 name: string, The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]96 body: object, The request body. (required)
97 The object takes the form of:
98
99{ # The service account key create request.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]100 "privateKeyType": "A String", # The output format of the private key. `GOOGLE_CREDENTIALS_FILE` is the default output format.
101 "keyAlgorithm": "A String", # Which type of key and algorithm to use for the key. The default is currently a 4K RSA key. However this may change in the future.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]102 }
103
104 x__xgafv: string, V1 error format.
105
106Returns:
107 An object of the form:
108
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]109 { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed key-pairs are managed automatically by Google, and rotated daily without user intervention. The private key never leaves Google's servers to maximize security. Public keys for all service accounts are also published at the OAuth2 Service Account API.
110 "privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]111 "validAfterTime": "A String", # The key can be used after this timestamp.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]112 "validBeforeTime": "A String", # The key can be used before this timestamp.
113 "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
114 "privateKeyType": "A String", # The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
115 "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
116 "name": "A String", # The resource name of the service account key in the following format `projects/{project}/serviceAccounts/{account}/keys/{key}`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]117 }</pre>
118</div>
119
120<div class="method">
121 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]122 <pre>Deletes a ServiceAccountKey.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]123
124Args:
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]125 name: string, The resource name of the service account key in the following format: `projects/{project}/serviceAccounts/{account}/keys/{key}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]126 x__xgafv: string, V1 error format.
127
128Returns:
129 An object of the form:
130
131 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
132 }</pre>
133</div>
134
135<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]136 <code class="details" id="get">get(name, publicKeyType=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]137 <pre>Gets the ServiceAccountKey by key id.
138
139Args:
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]140 name: string, The resource name of the service account key in the following format: `projects/{project}/serviceAccounts/{account}/keys/{key}`. Using `-` as a wildcard for the project will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
141 publicKeyType: string, The output format of the public key requested. X509_PEM is the default output format.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]142 x__xgafv: string, V1 error format.
143
144Returns:
145 An object of the form:
146
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]147 { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed key-pairs are managed automatically by Google, and rotated daily without user intervention. The private key never leaves Google's servers to maximize security. Public keys for all service accounts are also published at the OAuth2 Service Account API.
148 "privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]149 "validAfterTime": "A String", # The key can be used after this timestamp.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]150 "validBeforeTime": "A String", # The key can be used before this timestamp.
151 "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
152 "privateKeyType": "A String", # The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
153 "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
154 "name": "A String", # The resource name of the service account key in the following format `projects/{project}/serviceAccounts/{account}/keys/{key}`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]155 }</pre>
156</div>
157
158<div class="method">
159 <code class="details" id="list">list(name, keyTypes=None, x__xgafv=None)</code>
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]160 <pre>Lists ServiceAccountKeys.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]161
162Args:
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]163 name: string, The resource name of the service account in the following format: `projects/{project}/serviceAccounts/{account}`. Using `-` as a wildcard for the project, will infer the project from the account. The `account` value can be the `email` address or the `unique_id` of the service account. (required)
164 keyTypes: string, Filters the types of keys the user wants to include in the list response. Duplicate key types are not allowed. If no key type is provided, all keys are returned. (repeated)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]165 x__xgafv: string, V1 error format.
166
167Returns:
168 An object of the form:
169
170 { # The service account keys list response.
171 "keys": [ # The public keys for the service account.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]172 { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed key-pairs are managed automatically by Google, and rotated daily without user intervention. The private key never leaves Google's servers to maximize security. Public keys for all service accounts are also published at the OAuth2 Service Account API.
173 "privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]174 "validAfterTime": "A String", # The key can be used after this timestamp.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]175 "validBeforeTime": "A String", # The key can be used before this timestamp.
176 "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
177 "privateKeyType": "A String", # The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
178 "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
179 "name": "A String", # The resource name of the service account key in the following format `projects/{project}/serviceAccounts/{account}/keys/{key}`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]180 },
181 ],
182 }</pre>
183</div>
184
185</body></html>