1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a ServiceAccountKey and returns it.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a ServiceAccountKey.</p>
<p class="toc_element">
<code><a href="#get">get(name, publicKeyType=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the ServiceAccountKey by key id.</p>
<p class="toc_element">
<code><a href="#list">list(name, keyTypes=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists ServiceAccountKeys.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(name, body, x__xgafv=None)</code>
<pre>Creates a ServiceAccountKey and returns it.
Args:
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)
body: object, The request body. (required)
The object takes the form of:
{ # The service account key create request.
"privateKeyType": "A String", # The output format of the private key. `GOOGLE_CREDENTIALS_FILE` is the default output format.
"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.
}
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # 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.
"privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses.
"validAfterTime": "A String", # The key can be used after this timestamp.
"validBeforeTime": "A String", # The key can be used before this timestamp.
"keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
"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.
"publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
"name": "A String", # The resource name of the service account key in the following format `projects/{project}/serviceAccounts/{account}/keys/{key}`.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a ServiceAccountKey.
Args:
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)
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # 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 `{}`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, publicKeyType=None, x__xgafv=None)</code>
<pre>Gets the ServiceAccountKey by key id.
Args:
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)
publicKeyType: string, The output format of the public key requested. X509_PEM is the default output format.
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # 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.
"privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses.
"validAfterTime": "A String", # The key can be used after this timestamp.
"validBeforeTime": "A String", # The key can be used before this timestamp.
"keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
"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.
"publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
"name": "A String", # The resource name of the service account key in the following format `projects/{project}/serviceAccounts/{account}/keys/{key}`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(name, keyTypes=None, x__xgafv=None)</code>
<pre>Lists ServiceAccountKeys.
Args:
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)
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)
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # The service account keys list response.
"keys": [ # The public keys for the service account.
{ # 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.
"privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses.
"validAfterTime": "A String", # The key can be used after this timestamp.
"validBeforeTime": "A String", # The key can be used before this timestamp.
"keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
"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.
"publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
"name": "A String", # The resource name of the service account key in the following format `projects/{project}/serviceAccounts/{account}/keys/{key}`.
},
],
}</pre>
</div>
</body></html>
|
