Skip to content

Commit e37baee

Browse files
committed
docs: Add examples for service_account, trusted_account
Signed-off-by: lhhyung <[email protected]>
1 parent ffb5231 commit e37baee

File tree

2 files changed

+89
-6
lines changed

2 files changed

+89
-6
lines changed

proto/spaceone/api/identity/v2/service_account.proto

+1-1
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ message ServiceAccountSearchQuery {
257257
// "service_account_id": "sa-g7h8i9j1k2l3",
258258
// "state": "ACTIVE",
259259
// "tags": {},
260-
// "workspace_id": "workspace-529eb6a10fe3"
260+
// "workspace_id": "workspace-g7h8i9j1k2l3"
261261
// }
262262
// ],
263263
// "total_count": 2

proto/spaceone/api/identity/v2/trusted_account.proto

+88-5
Original file line numberDiff line numberDiff line change
@@ -76,16 +76,19 @@ message Scheduled {
7676
//{
7777
// "name": "Trusted Account",
7878
// "data": {
79-
// "account_id": "123456789",
80-
// }
79+
// "account_id": "a1b2c3d4e5f6"
80+
// },
8181
// "provider": "aws",
8282
// "secret_schema_id": "aws-secret-access-key",
83+
// "secret_data": {
84+
// "aws_access_key_id": "a1b2c3d4e5f6",
85+
// "aws_secret_access_key": "a1b2c3d4e5f6"
86+
// },
8387
// "schedule": {
8488
// "state": "ENABLED",
8589
// "hours": [3, 15]
8690
// },
87-
// "resource_group": "DOMAIN",
88-
// "workspace_id": "*"
91+
// "resource_group": "DOMAIN"
8992
//}
9093
message CreateTrustedAccountRequest {
9194
enum ResourceGroup {
@@ -113,6 +116,10 @@ message CreateTrustedAccountRequest {
113116
string workspace_id = 21;
114117
}
115118

119+
//{
120+
// "trusted_account_id": "ta-a1b2c3d4e5f6",
121+
// "name": "Trusted Account"
122+
//}
116123
message UpdateTrustedAccountRequest {
117124
string trusted_account_id = 1;
118125
// +optional
@@ -128,17 +135,45 @@ message UpdateTrustedAccountRequest {
128135
google.protobuf.Struct tags = 7;
129136
}
130137

138+
//{
139+
// "trusted_account_id": "ta-a1b2c3d4e5f6",
140+
// "secretSchemaId": "aws-secret-access-key",
141+
// "secretData": {
142+
// "aws_access_key_id": "a1b2c3d4e5f6",
143+
// "aws_secret_access_key": "a1b2c3d4e5f6"
144+
// }
145+
//}
131146
message UpdateTrustedAccountSecretRequest {
132147
string trusted_account_id = 1;
133148
string secret_schema_id = 2;
134149
google.protobuf.Struct secret_data = 3;
135150
}
136151

137-
152+
//{
153+
// "trusted_account_id": "ta-a1b2c3d4e5f6"
154+
//}
138155
message TrustedAccountRequest {
139156
string trusted_account_id = 1;
140157
}
141158

159+
//{
160+
// "created_at": "2024-11-18T07:53:57.897Z",
161+
// "data": {
162+
// "account_id": "a1b2c3d4e5f6"
163+
// },
164+
// "domain_id": "domain-a1b2c3d4e5f6",
165+
// "name": "Trusted Account",
166+
// "provider": "aws",
167+
// "resource_group": "DOMAIN",
168+
// "schedule": {
169+
// "hours": [3, 15],
170+
// "state": "ENABLED"
171+
// },
172+
// "secret_schema_id": "aws-secret-access-key",
173+
// "trusted_account_id": "ta-a1b2c3d4e5f6",
174+
// "trusted_secret_id": "trusted-secret-a1b2c3d4e5f6",
175+
// "workspace_id": "*"
176+
//}
142177
message TrustedAccountInfo {
143178
enum ResourceGroup {
144179
NONE = 0;
@@ -162,6 +197,21 @@ message TrustedAccountInfo {
162197
string created_at = 31;
163198
}
164199

200+
//{
201+
// "provider": "aws",
202+
// "query": {
203+
// "page": {
204+
// "start": 1,
205+
// "limit": 10
206+
// },
207+
// "sort": [
208+
// {
209+
// "key": "created_at",
210+
// "desc": true
211+
// }
212+
// ]
213+
// }
214+
//}
165215
message TrustedAccountSearchQuery {
166216
enum ResourceGroup {
167217
NONE = 0;
@@ -185,6 +235,39 @@ message TrustedAccountSearchQuery {
185235
string trusted_secret_id = 23;
186236
}
187237

238+
//{
239+
// "results": [
240+
// {
241+
// "created_at": "2024-11-18T07:47:02.789Z",
242+
// "data": {
243+
// "account_id": "a1b2c3d4e5f6"
244+
// },
245+
// "domain_id": "domain-a1b2c3d4e5f6",
246+
// "name": "Trusted Account",
247+
// "provider": "aws",
248+
// "resource_group": "DOMAIN",
249+
// "secret_schema_id": "aws-secret-access-key",
250+
// "trusted_account_id": "ta-a1b2c3d4e5f6",
251+
// "trusted_secret_id": "trusted-secret-a1b2c3d4e5f6",
252+
// "workspace_id": "*"
253+
// },
254+
// {
255+
// "created_at": "2024-11-18T07:10:17.114Z",
256+
// "data": {
257+
// "account_id": "g7h8i9j1k2l3"
258+
// },
259+
// "domain_id": "domain-a1b2c3d4e5f6",
260+
// "name": "Wonny Trusted Account",
261+
// "provider": "aws",
262+
// "resource_group": "DOMAIN",
263+
// "secret_schema_id": "aws-secret-access-key",
264+
// "trusted_account_id": "ta-g7h8i9j1k2l3",
265+
// "trusted_secret_id": "trusted-secret-g7h8i9j1k2l3",
266+
// "workspace_id": "*"
267+
// }
268+
// ],
269+
// "total_count": 2
270+
//}
188271
message TrustedAccountsInfo {
189272
repeated TrustedAccountInfo results = 1;
190273
int32 total_count = 2;

0 commit comments

Comments
 (0)