Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 36e41bc9e5f0c6e6d5920ae4a5c9802ca63554e2 / . / docs / dyn / iam_v1.projects.serviceAccounts.keys.html
blob: 56b7b2d70e7a42c98fe0c34378e1d009bc485635 [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
75<h1><a href="iam_v1.html">Google Identity and Access Management 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>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a service account key and returns it.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a service account key.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
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>
88<p class="firstline">Lists service account keys</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="create">create(name, body, x__xgafv=None)</code>
92 <pre>Creates a service account key and returns it.
93
94Args:
95 name: string, The resource name of the service account in the 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)
96 body: object, The request body. (required)
97 The object takes the form of:
98
99{ # The service account key create request.
100 "privateKeyType": "A String", # The type of the key requested. GOOGLE_CREDENTIALS is the default key type.
101 }
102
103 x__xgafv: string, V1 error format.
104
105Returns:
106 An object of the form:
107
108 { # Represents a service account key. A service account can have 0 or more key pairs. The private keys for these are not stored by Google. ServiceAccountKeys are immutable.
109 "privateKeyType": "A String", # The type of the private key.
110 "privateKeyData": "A String", # The key data.
111 "validBeforeTime": "A String", # The key can be used before this timestamp.
112 "name": "A String", # The resource name of the service account key in the format "projects/{project}/serviceAccounts/{email}/keys/{key}".
113 "validAfterTime": "A String", # The key can be used after this timestamp.
114 }</pre>
115</div>
116
117<div class="method">
118 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
119 <pre>Deletes a service account key.
120
121Args:
122 name: string, The resource name of the service account key in the 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)
123 x__xgafv: string, V1 error format.
124
125Returns:
126 An object of the form:
127
128 { # 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 `{}`.
129 }</pre>
130</div>
131
132<div class="method">
133 <code class="details" id="get">get(name, x__xgafv=None)</code>
134 <pre>Gets the ServiceAccountKey by key id.
135
136Args:
137 name: string, The resource name of the service account key in the 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)
138 x__xgafv: string, V1 error format.
139
140Returns:
141 An object of the form:
142
143 { # Represents a service account key. A service account can have 0 or more key pairs. The private keys for these are not stored by Google. ServiceAccountKeys are immutable.
144 "privateKeyType": "A String", # The type of the private key.
145 "privateKeyData": "A String", # The key data.
146 "validBeforeTime": "A String", # The key can be used before this timestamp.
147 "name": "A String", # The resource name of the service account key in the format "projects/{project}/serviceAccounts/{email}/keys/{key}".
148 "validAfterTime": "A String", # The key can be used after this timestamp.
149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="list">list(name, keyTypes=None, x__xgafv=None)</code>
154 <pre>Lists service account keys
155
156Args:
157 name: string, The resource name of the service account in the 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)
158 keyTypes: string, The type of keys the user wants to list. If empty, all key types are included in the response. Duplicate key types are not allowed. (repeated)
159 x__xgafv: string, V1 error format.
160
161Returns:
162 An object of the form:
163
164 { # The service account keys list response.
165 "keys": [ # The public keys for the service account.
166 { # Represents a service account key. A service account can have 0 or more key pairs. The private keys for these are not stored by Google. ServiceAccountKeys are immutable.
167 "privateKeyType": "A String", # The type of the private key.
168 "privateKeyData": "A String", # The key data.
169 "validBeforeTime": "A String", # The key can be used before this timestamp.
170 "name": "A String", # The resource name of the service account key in the format "projects/{project}/serviceAccounts/{email}/keys/{key}".
171 "validAfterTime": "A String", # The key can be used after this timestamp.
172 },
173 ],
174 }</pre>
175</div>
176
177</body></html>