@studio-design/studio-auth-node 0.2.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +99 -0
- package/LICENSE +21 -0
- package/README.md +42 -0
- package/dist/generated/client/client.gen.d.ts +3 -0
- package/dist/generated/client/client.gen.d.ts.map +1 -0
- package/dist/generated/client/client.gen.js +236 -0
- package/dist/generated/client/client.gen.js.map +1 -0
- package/dist/generated/client/index.d.ts +9 -0
- package/dist/generated/client/index.d.ts.map +1 -0
- package/dist/generated/client/index.js +7 -0
- package/dist/generated/client/index.js.map +1 -0
- package/dist/generated/client/types.gen.d.ts +118 -0
- package/dist/generated/client/types.gen.d.ts.map +1 -0
- package/dist/generated/client/types.gen.js +3 -0
- package/dist/generated/client/types.gen.js.map +1 -0
- package/dist/generated/client/utils.gen.d.ts +34 -0
- package/dist/generated/client/utils.gen.d.ts.map +1 -0
- package/dist/generated/client/utils.gen.js +229 -0
- package/dist/generated/client/utils.gen.js.map +1 -0
- package/dist/generated/client.gen.d.ts +13 -0
- package/dist/generated/client.gen.d.ts.map +1 -0
- package/dist/generated/client.gen.js +4 -0
- package/dist/generated/client.gen.js.map +1 -0
- package/dist/generated/core/auth.gen.d.ts +19 -0
- package/dist/generated/core/auth.gen.d.ts.map +1 -0
- package/dist/generated/core/auth.gen.js +15 -0
- package/dist/generated/core/auth.gen.js.map +1 -0
- package/dist/generated/core/bodySerializer.gen.d.ts +26 -0
- package/dist/generated/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/bodySerializer.gen.js +58 -0
- package/dist/generated/core/bodySerializer.gen.js.map +1 -0
- package/dist/generated/core/params.gen.d.ts +44 -0
- package/dist/generated/core/params.gen.d.ts.map +1 -0
- package/dist/generated/core/params.gen.js +101 -0
- package/dist/generated/core/params.gen.js.map +1 -0
- package/dist/generated/core/pathSerializer.gen.d.ts +34 -0
- package/dist/generated/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/pathSerializer.gen.js +107 -0
- package/dist/generated/core/pathSerializer.gen.js.map +1 -0
- package/dist/generated/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/generated/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/generated/core/queryKeySerializer.gen.js +93 -0
- package/dist/generated/core/queryKeySerializer.gen.js.map +1 -0
- package/dist/generated/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/generated/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/generated/core/serverSentEvents.gen.js +133 -0
- package/dist/generated/core/serverSentEvents.gen.js.map +1 -0
- package/dist/generated/core/types.gen.d.ts +79 -0
- package/dist/generated/core/types.gen.d.ts.map +1 -0
- package/dist/generated/core/types.gen.js +3 -0
- package/dist/generated/core/types.gen.js.map +1 -0
- package/dist/generated/core/utils.gen.d.ts +20 -0
- package/dist/generated/core/utils.gen.d.ts.map +1 -0
- package/dist/generated/core/utils.gen.js +88 -0
- package/dist/generated/core/utils.gen.js.map +1 -0
- package/dist/generated/index.d.ts +3 -0
- package/dist/generated/index.d.ts.map +1 -0
- package/dist/generated/index.js +4 -0
- package/dist/generated/index.js.map +1 -0
- package/dist/generated/sdk.gen.d.ts +438 -0
- package/dist/generated/sdk.gen.d.ts.map +1 -0
- package/dist/generated/sdk.gen.js +595 -0
- package/dist/generated/sdk.gen.js.map +1 -0
- package/dist/generated/types.gen.d.ts +3246 -0
- package/dist/generated/types.gen.d.ts.map +1 -0
- package/dist/generated/types.gen.js +85 -0
- package/dist/generated/types.gen.js.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +4 -0
- package/dist/index.js.map +1 -0
- package/package.json +40 -0
|
@@ -0,0 +1,3246 @@
|
|
|
1
|
+
export type ClientOptions = {
|
|
2
|
+
baseUrl: 'https://auth.local.studio.design' | 'https://auth.stg.studio.design' | 'https://auth.studio.design' | (string & {});
|
|
3
|
+
};
|
|
4
|
+
/**
|
|
5
|
+
* ヘルスチェック応答で返されるステータス情報。
|
|
6
|
+
*/
|
|
7
|
+
export type HealthStatus = {
|
|
8
|
+
/**
|
|
9
|
+
* サービスが稼働している場合は常に `ok` を返します。
|
|
10
|
+
*/
|
|
11
|
+
status: 'ok';
|
|
12
|
+
/**
|
|
13
|
+
* ヘルスチェックを実行した日時。
|
|
14
|
+
*/
|
|
15
|
+
checkedAt: string;
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* RFC 9457 Problem Details for HTTP APIs を表現する共通レスポンススキーマ。
|
|
19
|
+
* すべてのフィールドはオプショナルです。
|
|
20
|
+
* 拡張メンバー(Extension members)を自由に追加できます。
|
|
21
|
+
*/
|
|
22
|
+
export type ProblemDetails = {
|
|
23
|
+
/**
|
|
24
|
+
* 問題タイプを識別する URI 参照 (RFC 3986)。
|
|
25
|
+
* この URI は問題タイプを識別するもので、人間が読める説明へのリンクであることが推奨されます。
|
|
26
|
+
* 省略時のデフォルト値は "about:blank" です。
|
|
27
|
+
*/
|
|
28
|
+
type?: string;
|
|
29
|
+
/**
|
|
30
|
+
* 問題タイプの短い、人間が読める要約。
|
|
31
|
+
* ローカライズを除き、同じ問題タイプでは常に同じ値であるべきです。
|
|
32
|
+
*/
|
|
33
|
+
title?: string;
|
|
34
|
+
/**
|
|
35
|
+
* この問題の HTTP ステータスコード。
|
|
36
|
+
* 情報提供的な性質を持ち、実際の HTTP レスポンスのステータスコードと一致する必要があります。
|
|
37
|
+
*/
|
|
38
|
+
status?: number;
|
|
39
|
+
/**
|
|
40
|
+
* この問題の特定の発生に関する、人間が読める説明。
|
|
41
|
+
* 問題の詳細を提供し、クライアントが問題を理解・解決するのを助けることに焦点を当てます。
|
|
42
|
+
*/
|
|
43
|
+
detail?: string;
|
|
44
|
+
/**
|
|
45
|
+
* この問題の特定の発生を識別する URI 参照。
|
|
46
|
+
* 逆参照可能な URI、またはサーバー側で不透明な識別子として機能します。
|
|
47
|
+
*/
|
|
48
|
+
instance?: string;
|
|
49
|
+
[key: string]: unknown;
|
|
50
|
+
};
|
|
51
|
+
export type TokenRequest = ({
|
|
52
|
+
grant_type: 'authorization_code';
|
|
53
|
+
} | {
|
|
54
|
+
grant_type: 'refresh_token';
|
|
55
|
+
}) & {
|
|
56
|
+
/**
|
|
57
|
+
* 使用する OAuth 2.0 グラントタイプ。`authorization_code` または `refresh_token` のみを受け付けます。
|
|
58
|
+
*/
|
|
59
|
+
grant_type: 'authorization_code' | 'refresh_token';
|
|
60
|
+
client_id?: ClientId & unknown;
|
|
61
|
+
/**
|
|
62
|
+
* OAuth 2.0 クライアントシークレット。HTTP Basic 認証を利用できないクライアントでのみ、本文に含めることが許可されます。
|
|
63
|
+
*/
|
|
64
|
+
client_secret?: string;
|
|
65
|
+
/**
|
|
66
|
+
* `/oauth/authorize` で発行された認可コード。単回使用で、発行後短時間で失効します。
|
|
67
|
+
*/
|
|
68
|
+
code?: string;
|
|
69
|
+
redirect_uri?: RedirectUri;
|
|
70
|
+
code_verifier?: PkceVerifierString & unknown;
|
|
71
|
+
/**
|
|
72
|
+
* 事前に発行されたリフレッシュトークン。再発行時には同じスコープまたはそのサブセットを要求できます。
|
|
73
|
+
*/
|
|
74
|
+
refresh_token?: string;
|
|
75
|
+
scope?: Scope & unknown;
|
|
76
|
+
};
|
|
77
|
+
/**
|
|
78
|
+
* RFC 6749 OAuth 2.0 Token Response に準拠したトークン発行レスポンス。
|
|
79
|
+
*
|
|
80
|
+
* アクセストークンを必ず含み、条件に応じてリフレッシュトークンおよび OpenID Connect の ID トークンを含みます。
|
|
81
|
+
*/
|
|
82
|
+
export type TokenResponse = {
|
|
83
|
+
/**
|
|
84
|
+
* Bearer トークン (JWT)。HTTP Authorization ヘッダーで `Bearer {token}` として利用します。
|
|
85
|
+
*/
|
|
86
|
+
access_token: string;
|
|
87
|
+
/**
|
|
88
|
+
* トークンタイプ。現在は `Bearer` のみをサポートします。
|
|
89
|
+
*/
|
|
90
|
+
token_type: 'Bearer';
|
|
91
|
+
/**
|
|
92
|
+
* アクセストークンの有効期限 (秒)。クライアントはこの値を参考にトークン更新をスケジュールします。
|
|
93
|
+
*/
|
|
94
|
+
expires_in: number;
|
|
95
|
+
/**
|
|
96
|
+
* 長寿命トークン。アクセストークンの更新に使用します。セキュアストレージで保管し、漏洩時は即座に失効させてください。
|
|
97
|
+
* 認可リクエストに `offline_access` スコープを含む場合のみ返却されます。
|
|
98
|
+
*/
|
|
99
|
+
refresh_token?: string;
|
|
100
|
+
/**
|
|
101
|
+
* OpenID Connect ID Token (JWT)。ユーザー認証結果としてクレームセットを含みます。
|
|
102
|
+
*/
|
|
103
|
+
id_token?: string;
|
|
104
|
+
scope?: Scope & unknown;
|
|
105
|
+
};
|
|
106
|
+
/**
|
|
107
|
+
* RFC 6749 Section 5.2 に準拠した OAuth 2.0 トークンエンドポイントのエラーレスポンス。
|
|
108
|
+
*
|
|
109
|
+
* トークンリクエストが失敗した場合、認可サーバーは HTTP 400 (Bad Request) または
|
|
110
|
+
* 401 (Unauthorized) ステータスコードと共にこのレスポンスを返します。
|
|
111
|
+
*/
|
|
112
|
+
export type TokenErrorResponse = {
|
|
113
|
+
/**
|
|
114
|
+
* RFC 6749 Section 5.2 で定義されるエラーコード。
|
|
115
|
+
*
|
|
116
|
+
* **エラーコード一覧**:
|
|
117
|
+
* - `invalid_request`: リクエストに必須パラメータが不足、無効なパラメータ値、重複パラメータ、または不正な形式
|
|
118
|
+
* - `invalid_client`: クライアント認証失敗(未知のクライアント、認証情報なし、サポートされていない認証方式)
|
|
119
|
+
* - `invalid_grant`: 認可コードまたはリフレッシュトークンが無効、期限切れ、失効、または redirect_uri 不一致
|
|
120
|
+
* - `unauthorized_client`: 認証されたクライアントがこのグラントタイプを使用する権限がない
|
|
121
|
+
* - `unsupported_grant_type`: 認可サーバーがこのグラントタイプをサポートしていない
|
|
122
|
+
* - `invalid_scope`: 要求されたスコープが無効、未知、不正、または元の認可範囲を超過
|
|
123
|
+
*/
|
|
124
|
+
error: 'invalid_request' | 'invalid_client' | 'invalid_grant' | 'unauthorized_client' | 'unsupported_grant_type' | 'invalid_scope';
|
|
125
|
+
/**
|
|
126
|
+
* 人間が読める形式のエラー説明(ASCII 文字のみ)。
|
|
127
|
+
* クライアント開発者がエラーを理解するための追加情報を提供します。
|
|
128
|
+
* エンドユーザーに直接表示することは意図されていません。
|
|
129
|
+
*/
|
|
130
|
+
error_description?: string;
|
|
131
|
+
/**
|
|
132
|
+
* エラーに関する追加情報を提供する人間が読める Web ページの URI。
|
|
133
|
+
* クライアント開発者向けのドキュメントへのリンクとして使用されます。
|
|
134
|
+
*/
|
|
135
|
+
error_uri?: string;
|
|
136
|
+
};
|
|
137
|
+
/**
|
|
138
|
+
* OpenID Connect Discovery 1.0 プロバイダーメタデータ。
|
|
139
|
+
* クライアントがエンドポイントやサポート機能を自動検出するために使用します。
|
|
140
|
+
*/
|
|
141
|
+
export type OpenIdProviderMetadataResponse = {
|
|
142
|
+
/**
|
|
143
|
+
* 発行者識別子 (Issuer Identifier)。
|
|
144
|
+
* HTTPS URL で、クエリやフラグメントを含まない。
|
|
145
|
+
*/
|
|
146
|
+
issuer: string;
|
|
147
|
+
/**
|
|
148
|
+
* 認可エンドポイントの URL。
|
|
149
|
+
*/
|
|
150
|
+
authorization_endpoint: string;
|
|
151
|
+
/**
|
|
152
|
+
* トークンエンドポイントの URL。
|
|
153
|
+
*/
|
|
154
|
+
token_endpoint: string;
|
|
155
|
+
/**
|
|
156
|
+
* UserInfo エンドポイントの URL。
|
|
157
|
+
*/
|
|
158
|
+
userinfo_endpoint?: string;
|
|
159
|
+
/**
|
|
160
|
+
* JSON Web Key Set (JWKS) の URL。
|
|
161
|
+
* ID トークンの署名検証に使用する公開鍵を提供します。
|
|
162
|
+
*/
|
|
163
|
+
jwks_uri: string;
|
|
164
|
+
/**
|
|
165
|
+
* サポートする OAuth 2.0 スコープ値のリスト。
|
|
166
|
+
*/
|
|
167
|
+
scopes_supported?: Array<string>;
|
|
168
|
+
/**
|
|
169
|
+
* サポートする OAuth 2.0 response_type 値のリスト。
|
|
170
|
+
*/
|
|
171
|
+
response_types_supported: Array<string>;
|
|
172
|
+
/**
|
|
173
|
+
* サポートする OAuth 2.0 response_mode 値のリスト。
|
|
174
|
+
*/
|
|
175
|
+
response_modes_supported?: Array<string>;
|
|
176
|
+
/**
|
|
177
|
+
* サポートする OAuth 2.0 グラントタイプのリスト。
|
|
178
|
+
*/
|
|
179
|
+
grant_types_supported?: Array<string>;
|
|
180
|
+
/**
|
|
181
|
+
* サポートする Subject Identifier タイプのリスト。
|
|
182
|
+
*/
|
|
183
|
+
subject_types_supported: Array<'public'>;
|
|
184
|
+
/**
|
|
185
|
+
* ID トークンの署名に使用できる JWS アルゴリズムのリスト。
|
|
186
|
+
*/
|
|
187
|
+
id_token_signing_alg_values_supported: Array<string>;
|
|
188
|
+
/**
|
|
189
|
+
* トークンエンドポイントでサポートするクライアント認証方式のリスト。
|
|
190
|
+
*/
|
|
191
|
+
token_endpoint_auth_methods_supported?: Array<string>;
|
|
192
|
+
/**
|
|
193
|
+
* サポートするクレーム名のリスト。
|
|
194
|
+
*/
|
|
195
|
+
claims_supported?: Array<string>;
|
|
196
|
+
/**
|
|
197
|
+
* サポートする PKCE code_challenge_method 値のリスト (RFC 7636)。
|
|
198
|
+
*/
|
|
199
|
+
code_challenge_methods_supported?: Array<string>;
|
|
200
|
+
/**
|
|
201
|
+
* サポートする prompt パラメータ値のリスト (OIDC Discovery 1.0 Section 3)。
|
|
202
|
+
*/
|
|
203
|
+
prompt_values_supported?: Array<'none' | 'login'>;
|
|
204
|
+
/**
|
|
205
|
+
* トークン取り消しエンドポイントの URL (RFC 7009)。
|
|
206
|
+
*/
|
|
207
|
+
revocation_endpoint?: string;
|
|
208
|
+
/**
|
|
209
|
+
* トークンイントロスペクションエンドポイントの URL (RFC 7662)。
|
|
210
|
+
*/
|
|
211
|
+
introspection_endpoint?: string;
|
|
212
|
+
/**
|
|
213
|
+
* ログアウトエンドポイントの URL。
|
|
214
|
+
*/
|
|
215
|
+
end_session_endpoint?: string;
|
|
216
|
+
[key: string]: unknown;
|
|
217
|
+
};
|
|
218
|
+
/**
|
|
219
|
+
* JSON Web Key Set (JWKS) レスポンス。
|
|
220
|
+
* ID トークンの署名検証に使用する公開鍵のセットを返します (RFC 7517)。
|
|
221
|
+
*/
|
|
222
|
+
export type JwksResponse = {
|
|
223
|
+
/**
|
|
224
|
+
* JSON Web Key (JWK) の配列。
|
|
225
|
+
*/
|
|
226
|
+
keys: Array<JsonWebKey>;
|
|
227
|
+
[key: string]: unknown;
|
|
228
|
+
};
|
|
229
|
+
/**
|
|
230
|
+
* UserInfo エンドポイントのレスポンス。
|
|
231
|
+
* アクセストークンに関連付けられたユーザーの情報を返します (OpenID Connect Core 1.0 Section 5.3)。
|
|
232
|
+
*
|
|
233
|
+
* 返却されるクレームは、認可リクエスト時に要求されたスコープに依存します:
|
|
234
|
+
* - `openid`: sub (必須)
|
|
235
|
+
* - `profile`: name
|
|
236
|
+
* - `email`: email, email_verified
|
|
237
|
+
*/
|
|
238
|
+
export type UserinfoResponse = {
|
|
239
|
+
/**
|
|
240
|
+
* サブジェクト識別子 (Subject Identifier)。
|
|
241
|
+
* 発行者内でユーザーを一意に識別する値。
|
|
242
|
+
*/
|
|
243
|
+
sub: string;
|
|
244
|
+
/**
|
|
245
|
+
* ユーザーのフルネーム。
|
|
246
|
+
* `profile` スコープが要求された場合に含まれます。
|
|
247
|
+
*/
|
|
248
|
+
name?: string;
|
|
249
|
+
/**
|
|
250
|
+
* ユーザーのメールアドレス。
|
|
251
|
+
* `email` スコープが要求された場合に含まれます。
|
|
252
|
+
*/
|
|
253
|
+
email?: string;
|
|
254
|
+
/**
|
|
255
|
+
* メールアドレスが検証済みかどうか。
|
|
256
|
+
* `email` スコープが要求された場合に含まれます。
|
|
257
|
+
*/
|
|
258
|
+
email_verified?: boolean;
|
|
259
|
+
[key: string]: unknown;
|
|
260
|
+
};
|
|
261
|
+
/**
|
|
262
|
+
* RFC 7009 OAuth 2.0 Token Revocation に準拠したトークン無効化リクエスト。
|
|
263
|
+
*
|
|
264
|
+
* クライアントは、不要になったトークン(ログアウト時など)を明示的に無効化することで、
|
|
265
|
+
* トークン漏洩のリスクを軽減できます。
|
|
266
|
+
*/
|
|
267
|
+
export type RevokeRequest = {
|
|
268
|
+
/**
|
|
269
|
+
* 無効化するトークン文字列。アクセストークンまたはリフレッシュトークンを指定できます。
|
|
270
|
+
*/
|
|
271
|
+
token: string;
|
|
272
|
+
/**
|
|
273
|
+
* クライアントが無効化しようとしているトークンの種類を示すヒント。
|
|
274
|
+
* 認可サーバーはこのヒントを参考にしてトークン検索を最適化できますが、
|
|
275
|
+
* ヒントと異なる種類のトークンであっても無効化を試みます。
|
|
276
|
+
*/
|
|
277
|
+
token_type_hint?: 'access_token' | 'refresh_token';
|
|
278
|
+
};
|
|
279
|
+
/**
|
|
280
|
+
* RFC 7009 Section 2.2.1 に準拠した OAuth 2.0 Token Revocation エンドポイントのエラーレスポンス。
|
|
281
|
+
*
|
|
282
|
+
* トークン無効化リクエストが失敗した場合、認可サーバーは HTTP 400 (Bad Request) または
|
|
283
|
+
* 401 (Unauthorized) ステータスコードと共にこのレスポンスを返します。
|
|
284
|
+
*
|
|
285
|
+
* 注意: 無効なトークン(既に失効済み、存在しない等)を無効化しようとしても、
|
|
286
|
+
* エラーにはならず HTTP 200 が返されます(RFC 7009 Section 2.2)。
|
|
287
|
+
*/
|
|
288
|
+
export type RevokeErrorResponse = {
|
|
289
|
+
/**
|
|
290
|
+
* RFC 7009 Section 2.2.1 および RFC 6749 Section 5.2 で定義されるエラーコード。
|
|
291
|
+
*
|
|
292
|
+
* **エラーコード一覧**:
|
|
293
|
+
* - `invalid_request`: リクエストに必須パラメータが不足、無効なパラメータ値、重複パラメータ、または不正な形式
|
|
294
|
+
* - `invalid_client`: クライアント認証失敗(未知のクライアント、認証情報なし、サポートされていない認証方式)
|
|
295
|
+
* - `unsupported_token_type`: 認可サーバーが提示されたトークンタイプの無効化をサポートしていない
|
|
296
|
+
*/
|
|
297
|
+
error: 'invalid_request' | 'invalid_client' | 'unsupported_token_type';
|
|
298
|
+
/**
|
|
299
|
+
* 人間が読める形式のエラー説明(ASCII 文字のみ)。
|
|
300
|
+
* クライアント開発者がエラーを理解するための追加情報を提供します。
|
|
301
|
+
* エンドユーザーに直接表示することは意図されていません。
|
|
302
|
+
*/
|
|
303
|
+
error_description?: string;
|
|
304
|
+
/**
|
|
305
|
+
* エラーに関する追加情報を提供する人間が読める Web ページの URI。
|
|
306
|
+
* クライアント開発者向けのドキュメントへのリンクとして使用されます。
|
|
307
|
+
*/
|
|
308
|
+
error_uri?: string;
|
|
309
|
+
};
|
|
310
|
+
/**
|
|
311
|
+
* RFC 7662 OAuth 2.0 Token Introspection に準拠したトークンイントロスペクションリクエスト。
|
|
312
|
+
*
|
|
313
|
+
* リソースサーバーは、受け取ったトークンの有効性とメタ情報を確認するために
|
|
314
|
+
* このリクエストを送信します。
|
|
315
|
+
*
|
|
316
|
+
* クライアント認証は HTTP Basic 認証 (RFC 6749 Section 2.3.1) で行われるため、
|
|
317
|
+
* リクエストボディには含まれません。
|
|
318
|
+
*/
|
|
319
|
+
export type IntrospectRequest = {
|
|
320
|
+
/**
|
|
321
|
+
* イントロスペクション対象のトークン文字列。アクセストークンまたはリフレッシュトークンを指定できます。
|
|
322
|
+
*/
|
|
323
|
+
token: string;
|
|
324
|
+
/**
|
|
325
|
+
* クライアントが検証しようとしているトークンの種類を示すヒント。
|
|
326
|
+
* 認可サーバーはこのヒントを参考にしてトークン検索を最適化できますが、
|
|
327
|
+
* ヒントと異なる種類のトークンであっても検証を試みます。
|
|
328
|
+
*/
|
|
329
|
+
token_type_hint?: 'access_token' | 'refresh_token';
|
|
330
|
+
};
|
|
331
|
+
/**
|
|
332
|
+
* End Session エンドポイントへの POST リクエストボディ。
|
|
333
|
+
* すべてのプロパティはオプションです。
|
|
334
|
+
*/
|
|
335
|
+
export type EndSessionRequest = {
|
|
336
|
+
/**
|
|
337
|
+
* ログアウト対象のユーザーを特定するための ID トークン。
|
|
338
|
+
*
|
|
339
|
+
* OP (OpenID Provider) は、このトークンを使用してログアウト対象の
|
|
340
|
+
* エンドユーザーのセッションを特定します。トークンは暗号化されていても構いません。
|
|
341
|
+
*
|
|
342
|
+
* OP は必ずしもトークンの署名を検証する必要はありませんが、
|
|
343
|
+
* `aud` クレームに自身が含まれていることを確認します。
|
|
344
|
+
*/
|
|
345
|
+
id_token_hint?: string;
|
|
346
|
+
/**
|
|
347
|
+
* ログアウト対象のエンドユーザーに関するヒント。
|
|
348
|
+
*
|
|
349
|
+
* OP がエンドユーザーを特定するために使用できる追加情報です。
|
|
350
|
+
* `id_token_hint` が提供されていない場合に、ユーザーを特定するための
|
|
351
|
+
* 補助的な手段として使用されることがあります。
|
|
352
|
+
*/
|
|
353
|
+
logout_hint?: string;
|
|
354
|
+
/**
|
|
355
|
+
* ログアウト完了後にユーザーをリダイレクトする URI。
|
|
356
|
+
*
|
|
357
|
+
* この URI は、事前にクライアント登録時に `post_logout_redirect_uris` として
|
|
358
|
+
* 登録されている必要があります。登録されていない URI が指定された場合、
|
|
359
|
+
* リダイレクトは行われません。
|
|
360
|
+
*/
|
|
361
|
+
post_logout_redirect_uri?: string;
|
|
362
|
+
client_id?: ClientId;
|
|
363
|
+
/**
|
|
364
|
+
* RP がセッション状態を維持するための不透明な値。
|
|
365
|
+
*
|
|
366
|
+
* `post_logout_redirect_uri` へのリダイレクト時にクエリパラメータとして
|
|
367
|
+
* そのまま返却されます。CSRF 攻撃を防ぐために使用できます。
|
|
368
|
+
*/
|
|
369
|
+
state?: string;
|
|
370
|
+
/**
|
|
371
|
+
* エンドユーザーの優先言語およびスクリプトを表す BCP47 言語タグのスペース区切りリスト。
|
|
372
|
+
*
|
|
373
|
+
* OP はこの値を使用して、ログアウト確認画面やエラーメッセージの表示言語を
|
|
374
|
+
* 決定することができます。優先度の高い順に並べます。
|
|
375
|
+
*/
|
|
376
|
+
ui_locales?: string;
|
|
377
|
+
};
|
|
378
|
+
/**
|
|
379
|
+
* RFC 7662 OAuth 2.0 Token Introspection に準拠したトークンイントロスペクションレスポンス。
|
|
380
|
+
*
|
|
381
|
+
* `active` フィールドは常に含まれ、トークンが有効かどうかを示します。
|
|
382
|
+
* トークンが有効な場合(`active: true`)、追加のメタ情報(スコープ、有効期限等)が含まれます。
|
|
383
|
+
* トークンが無効な場合(`active: false`)、通常は `active` フィールドのみが返されます。
|
|
384
|
+
*
|
|
385
|
+
* 認可サーバーは、トークンの種類やリソースサーバーに応じて、
|
|
386
|
+
* 返却する情報を制限する場合があります。
|
|
387
|
+
*/
|
|
388
|
+
export type IntrospectResponse = {
|
|
389
|
+
/**
|
|
390
|
+
* トークンが現在アクティブ(有効)かどうかを示すブール値。
|
|
391
|
+
*
|
|
392
|
+
* `true` の場合、トークンは有効であり、追加のメタ情報が含まれます。
|
|
393
|
+
* `false` の場合、トークンは無効(期限切れ、失効済み、不正等)です。
|
|
394
|
+
*/
|
|
395
|
+
active: boolean;
|
|
396
|
+
/**
|
|
397
|
+
* トークンに関連付けられたスコープのスペース区切りリスト。
|
|
398
|
+
* 認可サーバーは、リソースサーバーに応じて返却するスコープを制限する場合があります。
|
|
399
|
+
*/
|
|
400
|
+
scope?: string;
|
|
401
|
+
/**
|
|
402
|
+
* トークンを要求したクライアントの識別子。
|
|
403
|
+
*/
|
|
404
|
+
client_id?: string;
|
|
405
|
+
/**
|
|
406
|
+
* トークンに関連付けられたリソースオーナーの人間が読める識別子。
|
|
407
|
+
*/
|
|
408
|
+
username?: string;
|
|
409
|
+
/**
|
|
410
|
+
* トークンのタイプ。RFC 6749 Section 7.1 で定義されています。
|
|
411
|
+
*/
|
|
412
|
+
token_type?: string;
|
|
413
|
+
/**
|
|
414
|
+
* トークンの有効期限を示す UNIX タイムスタンプ(秒)。
|
|
415
|
+
* RFC 7519 Section 4.1.4 で定義されています。
|
|
416
|
+
*/
|
|
417
|
+
exp?: number;
|
|
418
|
+
/**
|
|
419
|
+
* トークンが発行された時刻を示す UNIX タイムスタンプ(秒)。
|
|
420
|
+
* RFC 7519 Section 4.1.6 で定義されています。
|
|
421
|
+
*/
|
|
422
|
+
iat?: number;
|
|
423
|
+
/**
|
|
424
|
+
* トークンが有効になる時刻(この時刻より前は無効)を示す UNIX タイムスタンプ(秒)。
|
|
425
|
+
* RFC 7519 Section 4.1.5 で定義されています。
|
|
426
|
+
*/
|
|
427
|
+
nbf?: number;
|
|
428
|
+
/**
|
|
429
|
+
* トークンのサブジェクト(主体)を識別する一意の識別子。
|
|
430
|
+
* 通常はリソースオーナー(ユーザー)の識別子です。
|
|
431
|
+
* RFC 7519 Section 4.1.2 で定義されています。
|
|
432
|
+
*/
|
|
433
|
+
sub?: string;
|
|
434
|
+
/**
|
|
435
|
+
* トークンの対象となるオーディエンス(受信者)。
|
|
436
|
+
* 単一の文字列または文字列の配列で表されます。
|
|
437
|
+
* RFC 7519 Section 4.1.3 で定義されています。
|
|
438
|
+
*/
|
|
439
|
+
aud?: string | Array<string>;
|
|
440
|
+
/**
|
|
441
|
+
* トークンを発行した認可サーバーの識別子(URL)。
|
|
442
|
+
* RFC 7519 Section 4.1.1 で定義されています。
|
|
443
|
+
*/
|
|
444
|
+
iss?: string;
|
|
445
|
+
/**
|
|
446
|
+
* トークンの一意識別子(JWT ID)。
|
|
447
|
+
* RFC 7519 Section 4.1.7 で定義されています。
|
|
448
|
+
*/
|
|
449
|
+
jti?: string;
|
|
450
|
+
/**
|
|
451
|
+
* トークンに関連付けられたユーザーのメールアドレス。
|
|
452
|
+
* "email" スコープがトークンのスコープに含まれる場合のみ返されます。
|
|
453
|
+
*/
|
|
454
|
+
email?: string;
|
|
455
|
+
/**
|
|
456
|
+
* ユーザーのメールアドレスが検証済みかどうかを示すブール値。
|
|
457
|
+
* "email" スコープがトークンのスコープに含まれる場合のみ返されます。
|
|
458
|
+
*/
|
|
459
|
+
email_verified?: boolean;
|
|
460
|
+
/**
|
|
461
|
+
* トークンに紐づく組織識別子(UUID形式)。
|
|
462
|
+
* アクセストークンに `org_id` クレームが含まれている場合に返却されます。
|
|
463
|
+
* 組織コンテキストを持たないトークンの場合は `null` または不在となります。
|
|
464
|
+
*/
|
|
465
|
+
org_id?: string | null;
|
|
466
|
+
[key: string]: unknown;
|
|
467
|
+
};
|
|
468
|
+
/**
|
|
469
|
+
* RFC 7662 Section 2.3 に準拠した OAuth 2.0 Token Introspection エンドポイントのエラーレスポンス。
|
|
470
|
+
*
|
|
471
|
+
* トークンイントロスペクションリクエストが失敗した場合、認可サーバーは
|
|
472
|
+
* HTTP 400 (Bad Request) または 401 (Unauthorized) ステータスコードと共にこのレスポンスを返します。
|
|
473
|
+
*
|
|
474
|
+
* 注意: 無効なトークン(期限切れ、失効済み、存在しない等)を検証しようとしても、
|
|
475
|
+
* エラーにはならず HTTP 200 で `active: false` が返されます(RFC 7662 Section 2.2)。
|
|
476
|
+
*/
|
|
477
|
+
export type IntrospectErrorResponse = {
|
|
478
|
+
/**
|
|
479
|
+
* RFC 7662 Section 2.3 および RFC 6749 Section 5.2 で定義されるエラーコード。
|
|
480
|
+
*
|
|
481
|
+
* **エラーコード一覧**:
|
|
482
|
+
* - `invalid_request`: リクエストに必須パラメータが不足、無効なパラメータ値、重複パラメータ、または不正な形式
|
|
483
|
+
* - `invalid_client`: クライアント認証失敗(未知のクライアント、認証情報なし、サポートされていない認証方式)
|
|
484
|
+
*/
|
|
485
|
+
error: 'invalid_request' | 'invalid_client';
|
|
486
|
+
/**
|
|
487
|
+
* 人間が読める形式のエラー説明(ASCII 文字のみ)。
|
|
488
|
+
* クライアント開発者がエラーを理解するための追加情報を提供します。
|
|
489
|
+
* エンドユーザーに直接表示することは意図されていません。
|
|
490
|
+
*/
|
|
491
|
+
error_description?: string;
|
|
492
|
+
/**
|
|
493
|
+
* エラーに関する追加情報を提供する人間が読める Web ページの URI。
|
|
494
|
+
* クライアント開発者向けのドキュメントへのリンクとして使用されます。
|
|
495
|
+
*/
|
|
496
|
+
error_uri?: string;
|
|
497
|
+
};
|
|
498
|
+
/**
|
|
499
|
+
* OAuth 2.0 クライアント情報。
|
|
500
|
+
* 認可サーバーに登録されたクライアントアプリケーションを表します。
|
|
501
|
+
*/
|
|
502
|
+
export type Client = {
|
|
503
|
+
/**
|
|
504
|
+
* クライアント識別子(一意)。
|
|
505
|
+
*/
|
|
506
|
+
client_id: string;
|
|
507
|
+
/**
|
|
508
|
+
* クライアントアプリケーションの表示名。
|
|
509
|
+
*/
|
|
510
|
+
client_name: string;
|
|
511
|
+
/**
|
|
512
|
+
* クライアントの説明。
|
|
513
|
+
*/
|
|
514
|
+
description?: string | null;
|
|
515
|
+
/**
|
|
516
|
+
* クライアントタイプ。
|
|
517
|
+
*
|
|
518
|
+
* - `confidential`: 機密クライアント(サーバーサイドアプリ)。クライアントシークレットを安全に保持可能。
|
|
519
|
+
*/
|
|
520
|
+
client_type: 'confidential';
|
|
521
|
+
/**
|
|
522
|
+
* 許可されたリダイレクト URI のリスト。
|
|
523
|
+
*/
|
|
524
|
+
redirect_uris: Array<string>;
|
|
525
|
+
/**
|
|
526
|
+
* このクライアントに許可されたスコープのリスト。
|
|
527
|
+
*/
|
|
528
|
+
allowed_scopes: Array<'openid' | 'profile' | 'email' | 'offline_access'>;
|
|
529
|
+
/**
|
|
530
|
+
* このクライアントに許可されたグラントタイプのリスト。
|
|
531
|
+
*/
|
|
532
|
+
grant_types_supported: Array<'authorization_code' | 'refresh_token'>;
|
|
533
|
+
/**
|
|
534
|
+
* トークンエンドポイントでのクライアント認証方式。
|
|
535
|
+
*
|
|
536
|
+
* - `client_secret_basic`: HTTP Basic 認証
|
|
537
|
+
* - `client_secret_post`: リクエストボディでの送信
|
|
538
|
+
* - `private_key_jwt`: JWT による認証
|
|
539
|
+
*/
|
|
540
|
+
token_endpoint_auth_method: 'client_secret_basic' | 'client_secret_post' | 'private_key_jwt';
|
|
541
|
+
/**
|
|
542
|
+
* クライアントが有効かどうか。無効なクライアントは認可リクエストを受け付けません。
|
|
543
|
+
*/
|
|
544
|
+
is_active: boolean;
|
|
545
|
+
/**
|
|
546
|
+
* クライアント登録日時(ISO 8601 形式)。
|
|
547
|
+
*/
|
|
548
|
+
created_at: string;
|
|
549
|
+
/**
|
|
550
|
+
* クライアント最終更新日時(ISO 8601 形式)。
|
|
551
|
+
*/
|
|
552
|
+
updated_at: string;
|
|
553
|
+
};
|
|
554
|
+
/**
|
|
555
|
+
* 組織情報。
|
|
556
|
+
* システムに登録された組織を表します。
|
|
557
|
+
*/
|
|
558
|
+
export type Organization = {
|
|
559
|
+
/**
|
|
560
|
+
* 組織識別子(UUID形式、一意)。
|
|
561
|
+
*/
|
|
562
|
+
organization_id: string;
|
|
563
|
+
/**
|
|
564
|
+
* 組織の識別名(一意)。システム内部での識別に使用されます。
|
|
565
|
+
*
|
|
566
|
+
* - 小文字英数字とハイフンのみ使用可能
|
|
567
|
+
* - 先頭・末尾にハイフンは使用不可
|
|
568
|
+
*/
|
|
569
|
+
name: string;
|
|
570
|
+
/**
|
|
571
|
+
* 組織の表示名。UI上での表示に使用されます。
|
|
572
|
+
*/
|
|
573
|
+
display_name: string | null;
|
|
574
|
+
/**
|
|
575
|
+
* 組織が有効かどうか。無効な組織は操作を受け付けません。
|
|
576
|
+
*/
|
|
577
|
+
is_active: boolean;
|
|
578
|
+
/**
|
|
579
|
+
* SSOログインを強制するかどうか。
|
|
580
|
+
* `true` の場合、この組織のドメインに属するユーザーはSSO認証のみが許可されます。
|
|
581
|
+
*/
|
|
582
|
+
is_sso_enforced: boolean;
|
|
583
|
+
/**
|
|
584
|
+
* 組織登録日時(ISO 8601 形式)。
|
|
585
|
+
*/
|
|
586
|
+
created_at: string;
|
|
587
|
+
/**
|
|
588
|
+
* 組織最終更新日時(ISO 8601 形式)。
|
|
589
|
+
*/
|
|
590
|
+
updated_at: string;
|
|
591
|
+
};
|
|
592
|
+
/**
|
|
593
|
+
* 組織メンバー情報。
|
|
594
|
+
*/
|
|
595
|
+
export type OrganizationMember = {
|
|
596
|
+
/**
|
|
597
|
+
* メンバー識別子(UUID形式)。
|
|
598
|
+
*/
|
|
599
|
+
id: string;
|
|
600
|
+
user: OrganizationMemberUser;
|
|
601
|
+
role: OrganizationRole;
|
|
602
|
+
/**
|
|
603
|
+
* メンバーのアバター画像 URL。アバター未設定時は `null`。
|
|
604
|
+
* ユーザーレコードの `picture_url` を参照します。
|
|
605
|
+
*/
|
|
606
|
+
avatar_src?: string | null;
|
|
607
|
+
/**
|
|
608
|
+
* 組織への最終アクセス日時(ISO 8601 形式)。
|
|
609
|
+
* 組織コンテキストでまだアクセスしていないメンバーは `null`。
|
|
610
|
+
*/
|
|
611
|
+
last_access?: string | null;
|
|
612
|
+
domain_type?: OrganizationMemberDomainType;
|
|
613
|
+
/**
|
|
614
|
+
* 組織への参加日時(ISO 8601 形式)。
|
|
615
|
+
*/
|
|
616
|
+
joined_at: string;
|
|
617
|
+
};
|
|
618
|
+
/**
|
|
619
|
+
* 組織メンバーのユーザー情報。
|
|
620
|
+
*/
|
|
621
|
+
export type OrganizationMemberUser = {
|
|
622
|
+
/**
|
|
623
|
+
* ユーザー識別子(UUID形式)。
|
|
624
|
+
*/
|
|
625
|
+
id: string;
|
|
626
|
+
/**
|
|
627
|
+
* ユーザーのメールアドレス。
|
|
628
|
+
*/
|
|
629
|
+
email: string;
|
|
630
|
+
/**
|
|
631
|
+
* ユーザーの表示名。
|
|
632
|
+
*/
|
|
633
|
+
name?: string | null;
|
|
634
|
+
};
|
|
635
|
+
/**
|
|
636
|
+
* メンバーのメールドメインが、組織に登録された verified ドメイン(`organization_email_domains`)と一致するかどうかを示す分類。
|
|
637
|
+
* - `corporate`: メンバーのメールドメインが組織の verified ドメインと一致する。
|
|
638
|
+
* - `personal`: 一致しない(フリーメールや個人利用と想定されるドメインを含む)。
|
|
639
|
+
*
|
|
640
|
+
* この分類はメンバーの email から動的に算出されるため、組織のドメイン登録状況に応じて変化します。
|
|
641
|
+
*/
|
|
642
|
+
export declare const OrganizationMemberDomainType: {
|
|
643
|
+
readonly CORPORATE: "corporate";
|
|
644
|
+
readonly PERSONAL: "personal";
|
|
645
|
+
};
|
|
646
|
+
/**
|
|
647
|
+
* メンバーのメールドメインが、組織に登録された verified ドメイン(`organization_email_domains`)と一致するかどうかを示す分類。
|
|
648
|
+
* - `corporate`: メンバーのメールドメインが組織の verified ドメインと一致する。
|
|
649
|
+
* - `personal`: 一致しない(フリーメールや個人利用と想定されるドメインを含む)。
|
|
650
|
+
*
|
|
651
|
+
* この分類はメンバーの email から動的に算出されるため、組織のドメイン登録状況に応じて変化します。
|
|
652
|
+
*/
|
|
653
|
+
export type OrganizationMemberDomainType = typeof OrganizationMemberDomainType[keyof typeof OrganizationMemberDomainType];
|
|
654
|
+
/**
|
|
655
|
+
* ロール別のメンバー数集計(フィルタ適用前の総件数)。
|
|
656
|
+
* `include_counts=true` の場合のみレスポンスに含まれます。
|
|
657
|
+
*/
|
|
658
|
+
export type MemberRoleCounts = {
|
|
659
|
+
/**
|
|
660
|
+
* Owner ロールのメンバー数。
|
|
661
|
+
*/
|
|
662
|
+
owner: number;
|
|
663
|
+
/**
|
|
664
|
+
* Admin ロールのメンバー数。
|
|
665
|
+
*/
|
|
666
|
+
admin: number;
|
|
667
|
+
/**
|
|
668
|
+
* Security Admin ロールのメンバー数。
|
|
669
|
+
*/
|
|
670
|
+
security_admin: number;
|
|
671
|
+
/**
|
|
672
|
+
* 一般 Member ロールのメンバー数。
|
|
673
|
+
*/
|
|
674
|
+
member: number;
|
|
675
|
+
};
|
|
676
|
+
/**
|
|
677
|
+
* メールドメイン分類別のメンバー数集計(フィルタ適用前の総件数)。
|
|
678
|
+
* `include_counts=true` の場合のみレスポンスに含まれます。
|
|
679
|
+
*/
|
|
680
|
+
export type MemberDomainTypeCounts = {
|
|
681
|
+
/**
|
|
682
|
+
* 組織の verified ドメインに一致するメールを持つメンバー数。
|
|
683
|
+
*/
|
|
684
|
+
corporate: number;
|
|
685
|
+
/**
|
|
686
|
+
* 組織の verified ドメインに一致しないメールを持つメンバー数。
|
|
687
|
+
*/
|
|
688
|
+
personal: number;
|
|
689
|
+
};
|
|
690
|
+
/**
|
|
691
|
+
* ページネーション情報。
|
|
692
|
+
*/
|
|
693
|
+
export type PaginationMeta = {
|
|
694
|
+
/**
|
|
695
|
+
* 現在のページ番号(1始まり)。
|
|
696
|
+
*/
|
|
697
|
+
current_page: number;
|
|
698
|
+
/**
|
|
699
|
+
* 1ページあたりの件数。
|
|
700
|
+
*/
|
|
701
|
+
per_page: number;
|
|
702
|
+
/**
|
|
703
|
+
* 総件数。
|
|
704
|
+
*/
|
|
705
|
+
total: number;
|
|
706
|
+
/**
|
|
707
|
+
* 最終ページ番号。
|
|
708
|
+
*/
|
|
709
|
+
last_page: number;
|
|
710
|
+
};
|
|
711
|
+
/**
|
|
712
|
+
* クライアント登録リクエスト。
|
|
713
|
+
*/
|
|
714
|
+
export type AdminClientCreateRequest = {
|
|
715
|
+
/**
|
|
716
|
+
* クライアントアプリケーションの表示名。
|
|
717
|
+
*/
|
|
718
|
+
client_name: string;
|
|
719
|
+
/**
|
|
720
|
+
* クライアントの説明(オプション)。
|
|
721
|
+
*/
|
|
722
|
+
description?: string;
|
|
723
|
+
/**
|
|
724
|
+
* クライアントタイプ。
|
|
725
|
+
*
|
|
726
|
+
* - `confidential`: 機密クライアント(サーバーサイドアプリ)
|
|
727
|
+
*/
|
|
728
|
+
client_type: 'confidential';
|
|
729
|
+
/**
|
|
730
|
+
* 許可するリダイレクト URI のリスト。
|
|
731
|
+
*/
|
|
732
|
+
redirect_uris: Array<string>;
|
|
733
|
+
/**
|
|
734
|
+
* このクライアントに許可するスコープのリスト。
|
|
735
|
+
*/
|
|
736
|
+
allowed_scopes: Array<'openid' | 'profile' | 'email' | 'offline_access'>;
|
|
737
|
+
/**
|
|
738
|
+
* このクライアントに許可するグラントタイプのリスト。
|
|
739
|
+
*/
|
|
740
|
+
grant_types_supported: Array<'authorization_code' | 'refresh_token'>;
|
|
741
|
+
/**
|
|
742
|
+
* トークンエンドポイントでのクライアント認証方式。
|
|
743
|
+
*
|
|
744
|
+
* - `client_secret_basic`: HTTP Basic 認証(デフォルト)
|
|
745
|
+
* - `client_secret_post`: リクエストボディでの送信
|
|
746
|
+
* - `private_key_jwt`: JWT による認証
|
|
747
|
+
*/
|
|
748
|
+
token_endpoint_auth_method?: 'client_secret_basic' | 'client_secret_post' | 'private_key_jwt';
|
|
749
|
+
};
|
|
750
|
+
/**
|
|
751
|
+
* クライアント登録成功レスポンス。
|
|
752
|
+
*
|
|
753
|
+
* **重要**: `client_secret` はこのレスポンスでのみ返却されます。
|
|
754
|
+
* 後から再取得することはできないため、安全な場所に保存してください。
|
|
755
|
+
*/
|
|
756
|
+
export type AdminClientCreatedResponse = {
|
|
757
|
+
/**
|
|
758
|
+
* 発行されたクライアント識別子。
|
|
759
|
+
*/
|
|
760
|
+
client_id: string;
|
|
761
|
+
/**
|
|
762
|
+
* 発行されたクライアントシークレット。
|
|
763
|
+
*
|
|
764
|
+
* **重要**: この値は一度しか表示されません。安全な場所に保存してください。
|
|
765
|
+
*/
|
|
766
|
+
client_secret: string;
|
|
767
|
+
/**
|
|
768
|
+
* クライアントアプリケーションの表示名。
|
|
769
|
+
*/
|
|
770
|
+
client_name: string;
|
|
771
|
+
/**
|
|
772
|
+
* クライアントの説明。
|
|
773
|
+
*/
|
|
774
|
+
description?: string | null;
|
|
775
|
+
/**
|
|
776
|
+
* クライアントタイプ。
|
|
777
|
+
*/
|
|
778
|
+
client_type: 'confidential';
|
|
779
|
+
/**
|
|
780
|
+
* 許可されたリダイレクト URI のリスト。
|
|
781
|
+
*/
|
|
782
|
+
redirect_uris: Array<string>;
|
|
783
|
+
/**
|
|
784
|
+
* このクライアントに許可されたスコープのリスト。
|
|
785
|
+
*/
|
|
786
|
+
allowed_scopes: Array<string>;
|
|
787
|
+
/**
|
|
788
|
+
* このクライアントに許可されたグラントタイプのリスト。
|
|
789
|
+
*/
|
|
790
|
+
grant_types_supported: Array<string>;
|
|
791
|
+
/**
|
|
792
|
+
* トークンエンドポイントでのクライアント認証方式。
|
|
793
|
+
*/
|
|
794
|
+
token_endpoint_auth_method: string;
|
|
795
|
+
/**
|
|
796
|
+
* クライアントが有効かどうか。
|
|
797
|
+
*/
|
|
798
|
+
is_active: boolean;
|
|
799
|
+
/**
|
|
800
|
+
* クライアント登録日時(ISO 8601 形式)。
|
|
801
|
+
*/
|
|
802
|
+
created_at: string;
|
|
803
|
+
/**
|
|
804
|
+
* クライアント最終更新日時(ISO 8601 形式)。
|
|
805
|
+
*/
|
|
806
|
+
updated_at: string;
|
|
807
|
+
};
|
|
808
|
+
/**
|
|
809
|
+
* クライアント一覧レスポンス(ページネーション付き)。
|
|
810
|
+
*/
|
|
811
|
+
export type AdminClientListResponse = {
|
|
812
|
+
/**
|
|
813
|
+
* クライアントの配列。
|
|
814
|
+
*/
|
|
815
|
+
data: Array<Client>;
|
|
816
|
+
meta: PaginationMeta;
|
|
817
|
+
};
|
|
818
|
+
/**
|
|
819
|
+
* 組織一覧レスポンス(ページネーション付き)。
|
|
820
|
+
*/
|
|
821
|
+
export type AdminOrganizationListResponse = {
|
|
822
|
+
/**
|
|
823
|
+
* 組織の配列。
|
|
824
|
+
*/
|
|
825
|
+
data: Array<Organization>;
|
|
826
|
+
meta: PaginationMeta;
|
|
827
|
+
};
|
|
828
|
+
/**
|
|
829
|
+
* クライアント更新リクエスト。
|
|
830
|
+
* 指定されたフィールドのみが更新されます。
|
|
831
|
+
*/
|
|
832
|
+
export type AdminClientUpdateRequest = {
|
|
833
|
+
/**
|
|
834
|
+
* クライアントアプリケーションの表示名。
|
|
835
|
+
*/
|
|
836
|
+
client_name?: string;
|
|
837
|
+
/**
|
|
838
|
+
* クライアントの説明。`null` を指定すると説明を削除します。
|
|
839
|
+
*/
|
|
840
|
+
description?: string | null;
|
|
841
|
+
/**
|
|
842
|
+
* 許可するリダイレクト URI のリスト。
|
|
843
|
+
*/
|
|
844
|
+
redirect_uris?: Array<string>;
|
|
845
|
+
/**
|
|
846
|
+
* このクライアントに許可するスコープのリスト。
|
|
847
|
+
*/
|
|
848
|
+
allowed_scopes?: Array<'openid' | 'profile' | 'email' | 'offline_access'>;
|
|
849
|
+
/**
|
|
850
|
+
* このクライアントに許可するグラントタイプのリスト。
|
|
851
|
+
*/
|
|
852
|
+
grant_types_supported?: Array<'authorization_code' | 'refresh_token'>;
|
|
853
|
+
/**
|
|
854
|
+
* トークンエンドポイントでのクライアント認証方式。
|
|
855
|
+
*
|
|
856
|
+
* - `client_secret_basic`: HTTP Basic 認証
|
|
857
|
+
* - `client_secret_post`: リクエストボディでの送信
|
|
858
|
+
* - `private_key_jwt`: JWT による認証
|
|
859
|
+
*/
|
|
860
|
+
token_endpoint_auth_method?: 'client_secret_basic' | 'client_secret_post' | 'private_key_jwt';
|
|
861
|
+
/**
|
|
862
|
+
* クライアントの有効/無効を切り替えます。
|
|
863
|
+
*/
|
|
864
|
+
is_active?: boolean;
|
|
865
|
+
};
|
|
866
|
+
/**
|
|
867
|
+
* 組織登録リクエスト。
|
|
868
|
+
*/
|
|
869
|
+
export type AdminOrganizationCreateRequest = {
|
|
870
|
+
/**
|
|
871
|
+
* 組織の識別名。システム内部での識別に使用されます。
|
|
872
|
+
*
|
|
873
|
+
* - 小文字英数字とハイフンのみ使用可能
|
|
874
|
+
* - 先頭・末尾にハイフンは使用不可
|
|
875
|
+
* - システム内で一意である必要があります
|
|
876
|
+
*/
|
|
877
|
+
name: string;
|
|
878
|
+
/**
|
|
879
|
+
* 組織の表示名(オプション)。UI上での表示に使用されます。`null` を指定するか省略すると表示名なしになります。
|
|
880
|
+
*/
|
|
881
|
+
display_name?: string | null;
|
|
882
|
+
};
|
|
883
|
+
/**
|
|
884
|
+
* 組織登録成功レスポンス。
|
|
885
|
+
*/
|
|
886
|
+
export type AdminOrganizationCreatedResponse = {
|
|
887
|
+
/**
|
|
888
|
+
* 発行された組織識別子(UUID形式)。
|
|
889
|
+
*/
|
|
890
|
+
organization_id: string;
|
|
891
|
+
/**
|
|
892
|
+
* 組織の識別名。
|
|
893
|
+
*/
|
|
894
|
+
name: string;
|
|
895
|
+
/**
|
|
896
|
+
* 組織の表示名。
|
|
897
|
+
*/
|
|
898
|
+
display_name?: string | null;
|
|
899
|
+
/**
|
|
900
|
+
* 組織が有効かどうか。
|
|
901
|
+
*/
|
|
902
|
+
is_active: boolean;
|
|
903
|
+
/**
|
|
904
|
+
* 組織登録日時(ISO 8601 形式)。
|
|
905
|
+
*/
|
|
906
|
+
created_at: string;
|
|
907
|
+
/**
|
|
908
|
+
* 組織最終更新日時(ISO 8601 形式)。
|
|
909
|
+
*/
|
|
910
|
+
updated_at: string;
|
|
911
|
+
};
|
|
912
|
+
/**
|
|
913
|
+
* 組織更新リクエスト。
|
|
914
|
+
* 指定されたフィールドのみが更新されます。
|
|
915
|
+
*/
|
|
916
|
+
export type AdminOrganizationUpdateRequest = {
|
|
917
|
+
/**
|
|
918
|
+
* 組織の識別名。システム内部での識別に使用されます。
|
|
919
|
+
*
|
|
920
|
+
* - 小文字英数字とハイフンのみ使用可能
|
|
921
|
+
* - 先頭・末尾にハイフンは使用不可
|
|
922
|
+
* - システム内で一意である必要があります
|
|
923
|
+
*/
|
|
924
|
+
name?: string;
|
|
925
|
+
/**
|
|
926
|
+
* 組織の表示名。`null` を指定すると表示名を削除します。
|
|
927
|
+
*/
|
|
928
|
+
display_name?: string | null;
|
|
929
|
+
/**
|
|
930
|
+
* 組織の有効/無効を切り替えます。
|
|
931
|
+
* `false` を指定すると組織を無効化(論理削除)し、
|
|
932
|
+
* `true` を指定すると再有効化します。
|
|
933
|
+
*/
|
|
934
|
+
is_active?: boolean;
|
|
935
|
+
/**
|
|
936
|
+
* SSOログインを強制するかどうかを切り替えます。
|
|
937
|
+
* `true` を指定すると、この組織のドメインに属するユーザーはSSO認証のみが許可されます。
|
|
938
|
+
*/
|
|
939
|
+
is_sso_enforced?: boolean;
|
|
940
|
+
};
|
|
941
|
+
/**
|
|
942
|
+
* 組織メンバー一覧レスポンス(ページネーション付き)。
|
|
943
|
+
* `include_counts=true` クエリ指定時のみ `role_counts` と `domain_counts` を含みます(フィルタ適用前の総件数)。
|
|
944
|
+
*/
|
|
945
|
+
export type AdminOrganizationMemberListResponse = {
|
|
946
|
+
/**
|
|
947
|
+
* 組織メンバーの配列。
|
|
948
|
+
*/
|
|
949
|
+
data: Array<OrganizationMember>;
|
|
950
|
+
meta: PaginationMeta;
|
|
951
|
+
role_counts?: MemberRoleCounts;
|
|
952
|
+
domain_counts?: MemberDomainTypeCounts;
|
|
953
|
+
};
|
|
954
|
+
/**
|
|
955
|
+
* 組織メンバー一覧レスポンス(ページネーション付き)。
|
|
956
|
+
* `include_counts=true` クエリ指定時のみ `role_counts` と `domain_counts` を含みます(フィルタ適用前の総件数)。
|
|
957
|
+
*/
|
|
958
|
+
export type OrganizationMemberListResponse = {
|
|
959
|
+
/**
|
|
960
|
+
* 組織メンバーの配列。
|
|
961
|
+
*/
|
|
962
|
+
data: Array<OrganizationMember>;
|
|
963
|
+
meta: PaginationMeta;
|
|
964
|
+
role_counts?: MemberRoleCounts;
|
|
965
|
+
domain_counts?: MemberDomainTypeCounts;
|
|
966
|
+
};
|
|
967
|
+
/**
|
|
968
|
+
* メンバーロール変更リクエスト。
|
|
969
|
+
*/
|
|
970
|
+
export type AdminOrganizationMemberUpdateRequest = {
|
|
971
|
+
role: OrganizationRole;
|
|
972
|
+
};
|
|
973
|
+
/**
|
|
974
|
+
* 組織内でのロール。
|
|
975
|
+
* - `owner`: 組織のオーナー。すべての権限を持つ。
|
|
976
|
+
* - `admin`: 管理者。メンバーの招待・削除および請求管理が可能。ロール変更やセキュリティ管理は不可。
|
|
977
|
+
* - `security_admin`: セキュリティ管理者。セキュリティ設定の管理が可能。メンバー管理や請求管理は不可。
|
|
978
|
+
* - `member`: 一般メンバー。管理権限なし。
|
|
979
|
+
*/
|
|
980
|
+
export declare const OrganizationRole: {
|
|
981
|
+
readonly OWNER: "owner";
|
|
982
|
+
readonly ADMIN: "admin";
|
|
983
|
+
readonly SECURITY_ADMIN: "security_admin";
|
|
984
|
+
readonly MEMBER: "member";
|
|
985
|
+
};
|
|
986
|
+
/**
|
|
987
|
+
* 組織内でのロール。
|
|
988
|
+
* - `owner`: 組織のオーナー。すべての権限を持つ。
|
|
989
|
+
* - `admin`: 管理者。メンバーの招待・削除および請求管理が可能。ロール変更やセキュリティ管理は不可。
|
|
990
|
+
* - `security_admin`: セキュリティ管理者。セキュリティ設定の管理が可能。メンバー管理や請求管理は不可。
|
|
991
|
+
* - `member`: 一般メンバー。管理権限なし。
|
|
992
|
+
*/
|
|
993
|
+
export type OrganizationRole = typeof OrganizationRole[keyof typeof OrganizationRole];
|
|
994
|
+
/**
|
|
995
|
+
* 組織への招待情報。
|
|
996
|
+
* メンバーを組織に招待する際に作成されます。
|
|
997
|
+
*/
|
|
998
|
+
export type OrganizationInvitation = {
|
|
999
|
+
/**
|
|
1000
|
+
* 招待識別子(UUID形式、一意)。
|
|
1001
|
+
*/
|
|
1002
|
+
id: string;
|
|
1003
|
+
/**
|
|
1004
|
+
* 招待先のメールアドレス。
|
|
1005
|
+
*/
|
|
1006
|
+
email: string;
|
|
1007
|
+
role: OrganizationRole;
|
|
1008
|
+
/**
|
|
1009
|
+
* 招待のステータス。
|
|
1010
|
+
* - `pending`: 招待が送信され、承認待ち。
|
|
1011
|
+
* - `accepted`: 招待が承認された。
|
|
1012
|
+
* - `expired`: 招待の有効期限が切れた。
|
|
1013
|
+
* - `revoked`: 招待が取り消された。
|
|
1014
|
+
*/
|
|
1015
|
+
status: 'pending' | 'accepted' | 'expired' | 'revoked';
|
|
1016
|
+
/**
|
|
1017
|
+
* 招待の有効期限(ISO 8601 形式)。
|
|
1018
|
+
*/
|
|
1019
|
+
expires_at: string;
|
|
1020
|
+
/**
|
|
1021
|
+
* 招待作成日時(ISO 8601 形式)。
|
|
1022
|
+
*/
|
|
1023
|
+
created_at: string;
|
|
1024
|
+
};
|
|
1025
|
+
/**
|
|
1026
|
+
* 組織へのメンバー招待リクエスト。
|
|
1027
|
+
*/
|
|
1028
|
+
export type AdminOrganizationInvitationCreateRequest = {
|
|
1029
|
+
/**
|
|
1030
|
+
* 招待先のメールアドレス。
|
|
1031
|
+
*/
|
|
1032
|
+
email: string;
|
|
1033
|
+
role: OrganizationRole;
|
|
1034
|
+
};
|
|
1035
|
+
/**
|
|
1036
|
+
* 組織へのメンバー招待成功レスポンス。
|
|
1037
|
+
*/
|
|
1038
|
+
export type AdminOrganizationInvitationCreatedResponse = {
|
|
1039
|
+
/**
|
|
1040
|
+
* 発行された招待識別子(UUID形式)。
|
|
1041
|
+
*/
|
|
1042
|
+
id: string;
|
|
1043
|
+
/**
|
|
1044
|
+
* 招待先のメールアドレス。
|
|
1045
|
+
*/
|
|
1046
|
+
email: string;
|
|
1047
|
+
role: OrganizationRole;
|
|
1048
|
+
/**
|
|
1049
|
+
* 招待のステータス。新規作成時は常に `pending`。
|
|
1050
|
+
*/
|
|
1051
|
+
status: 'pending';
|
|
1052
|
+
/**
|
|
1053
|
+
* 招待の有効期限(ISO 8601 形式)。
|
|
1054
|
+
*/
|
|
1055
|
+
expires_at: string;
|
|
1056
|
+
/**
|
|
1057
|
+
* 招待の作成日時(ISO 8601 形式)。
|
|
1058
|
+
*/
|
|
1059
|
+
created_at: string;
|
|
1060
|
+
};
|
|
1061
|
+
/**
|
|
1062
|
+
* WorkOS Admin Portal セッション作成リクエスト。
|
|
1063
|
+
* Admin Portal は組織のIT管理者がSSO接続の設定、ドメイン認証、監査ログの閲覧等をセルフサービスで行うための画面です。
|
|
1064
|
+
*/
|
|
1065
|
+
export type AdminPortalSessionCreateRequest = {
|
|
1066
|
+
/**
|
|
1067
|
+
* ポータルセッションの用途。
|
|
1068
|
+
* - `sso`: SSO接続の設定
|
|
1069
|
+
* - `domain_verification`: ドメイン認証の設定
|
|
1070
|
+
* - `audit_log`: 監査ログの閲覧
|
|
1071
|
+
*/
|
|
1072
|
+
intent: 'sso' | 'domain_verification' | 'audit_log';
|
|
1073
|
+
};
|
|
1074
|
+
/**
|
|
1075
|
+
* WorkOS Admin Portal セッション作成成功レスポンス。
|
|
1076
|
+
* 生成されたポータル URL は5分間有効です。
|
|
1077
|
+
*/
|
|
1078
|
+
export type AdminPortalSessionCreatedResponse = {
|
|
1079
|
+
/**
|
|
1080
|
+
* WorkOS Admin Portal の URL。
|
|
1081
|
+
* IT管理者がこの URL にアクセスすることで、SSO接続の設定を行えます。
|
|
1082
|
+
* この URL は発行から5分間有効です。
|
|
1083
|
+
*/
|
|
1084
|
+
admin_portal_url: string;
|
|
1085
|
+
};
|
|
1086
|
+
/**
|
|
1087
|
+
* 組織Adminによるメンバー招待リクエスト。
|
|
1088
|
+
*/
|
|
1089
|
+
export type OrganizationInvitationCreateRequest = {
|
|
1090
|
+
/**
|
|
1091
|
+
* 招待先のメールアドレス。
|
|
1092
|
+
*/
|
|
1093
|
+
email: string;
|
|
1094
|
+
role: OrganizationRole;
|
|
1095
|
+
};
|
|
1096
|
+
/**
|
|
1097
|
+
* 組織Adminによるメンバー招待成功レスポンス。
|
|
1098
|
+
*/
|
|
1099
|
+
export type OrganizationInvitationCreatedResponse = {
|
|
1100
|
+
/**
|
|
1101
|
+
* 発行された招待識別子(UUID形式)。
|
|
1102
|
+
*/
|
|
1103
|
+
id: string;
|
|
1104
|
+
/**
|
|
1105
|
+
* 招待先のメールアドレス。
|
|
1106
|
+
*/
|
|
1107
|
+
email: string;
|
|
1108
|
+
role: OrganizationRole;
|
|
1109
|
+
/**
|
|
1110
|
+
* 招待のステータス。新規作成時は常に `pending`。
|
|
1111
|
+
*/
|
|
1112
|
+
status: 'pending';
|
|
1113
|
+
/**
|
|
1114
|
+
* 招待の有効期限(ISO 8601 形式)。
|
|
1115
|
+
*/
|
|
1116
|
+
expires_at: string;
|
|
1117
|
+
/**
|
|
1118
|
+
* 招待の作成日時(ISO 8601 形式)。
|
|
1119
|
+
*/
|
|
1120
|
+
created_at: string;
|
|
1121
|
+
};
|
|
1122
|
+
/**
|
|
1123
|
+
* メンバーロール変更リクエスト(組織メンバー向け)。
|
|
1124
|
+
*/
|
|
1125
|
+
export type OrganizationMemberUpdateRequest = {
|
|
1126
|
+
role: OrganizationRole;
|
|
1127
|
+
};
|
|
1128
|
+
/**
|
|
1129
|
+
* SSO 強制判定レスポンス
|
|
1130
|
+
*/
|
|
1131
|
+
export type CheckSsoEnforcementResponse = {
|
|
1132
|
+
/**
|
|
1133
|
+
* SSO 強制が適用されているかどうか
|
|
1134
|
+
*/
|
|
1135
|
+
enforced: boolean;
|
|
1136
|
+
/**
|
|
1137
|
+
* SSO 強制を適用している組織の ID。強制されていない場合は null
|
|
1138
|
+
*/
|
|
1139
|
+
org_id: string | null;
|
|
1140
|
+
};
|
|
1141
|
+
/**
|
|
1142
|
+
* SSO 強制判定エンドポイントのエラーレスポンス
|
|
1143
|
+
*/
|
|
1144
|
+
export type SsoEnforcementErrorResponse = {
|
|
1145
|
+
/**
|
|
1146
|
+
* エラーコード
|
|
1147
|
+
*/
|
|
1148
|
+
error: string;
|
|
1149
|
+
/**
|
|
1150
|
+
* エラーの説明
|
|
1151
|
+
*/
|
|
1152
|
+
error_description: string;
|
|
1153
|
+
};
|
|
1154
|
+
/**
|
|
1155
|
+
* サービス情報のレスポンススキーマ。サービス名と OpenID Connect Discovery エンドポイントへのリンクを含みます。
|
|
1156
|
+
*/
|
|
1157
|
+
export type ServiceInfoResponse = {
|
|
1158
|
+
/**
|
|
1159
|
+
* サービス名
|
|
1160
|
+
*/
|
|
1161
|
+
name: string;
|
|
1162
|
+
/**
|
|
1163
|
+
* OpenID Connect Discovery エンドポイントの URL
|
|
1164
|
+
*/
|
|
1165
|
+
documentation: string;
|
|
1166
|
+
};
|
|
1167
|
+
/**
|
|
1168
|
+
* RSA JSON Web Key (JWK)。
|
|
1169
|
+
* RSA 公開鍵を JSON 形式で表現します (RFC 7517)。
|
|
1170
|
+
*/
|
|
1171
|
+
export type RsaJsonWebKey = {
|
|
1172
|
+
/**
|
|
1173
|
+
* 鍵タイプ (Key Type)。
|
|
1174
|
+
* RSA 鍵の場合は "RSA"。
|
|
1175
|
+
*/
|
|
1176
|
+
kty: 'RSA';
|
|
1177
|
+
/**
|
|
1178
|
+
* 公開鍵の用途 (Public Key Use)。
|
|
1179
|
+
* 署名検証用の場合は "sig"。
|
|
1180
|
+
*/
|
|
1181
|
+
use: 'sig';
|
|
1182
|
+
/**
|
|
1183
|
+
* 鍵 ID (Key ID)。
|
|
1184
|
+
* JWT ヘッダーの kid と照合して使用する鍵を特定します。
|
|
1185
|
+
*/
|
|
1186
|
+
kid: string;
|
|
1187
|
+
/**
|
|
1188
|
+
* アルゴリズム (Algorithm)。
|
|
1189
|
+
* この鍵で使用するアルゴリズムを示します。
|
|
1190
|
+
*/
|
|
1191
|
+
alg: 'RS256' | 'PS256';
|
|
1192
|
+
/**
|
|
1193
|
+
* RSA 公開鍵のモジュラス (Modulus)。
|
|
1194
|
+
* Base64url エンコードされた値。
|
|
1195
|
+
*/
|
|
1196
|
+
n: string;
|
|
1197
|
+
/**
|
|
1198
|
+
* RSA 公開鍵の指数 (Exponent)。
|
|
1199
|
+
* Base64url エンコードされた値。
|
|
1200
|
+
*/
|
|
1201
|
+
e: string;
|
|
1202
|
+
[key: string]: unknown;
|
|
1203
|
+
};
|
|
1204
|
+
/**
|
|
1205
|
+
* EC JSON Web Key (JWK)。
|
|
1206
|
+
* 楕円曲線 (Elliptic Curve) 公開鍵を JSON 形式で表現します (RFC 7517)。
|
|
1207
|
+
*/
|
|
1208
|
+
export type EcJsonWebKey = {
|
|
1209
|
+
/**
|
|
1210
|
+
* 鍵タイプ (Key Type)。
|
|
1211
|
+
* EC 鍵の場合は "EC"。
|
|
1212
|
+
*/
|
|
1213
|
+
kty: 'EC';
|
|
1214
|
+
/**
|
|
1215
|
+
* 公開鍵の用途 (Public Key Use)。
|
|
1216
|
+
* 署名検証用の場合は "sig"。
|
|
1217
|
+
*/
|
|
1218
|
+
use: 'sig';
|
|
1219
|
+
/**
|
|
1220
|
+
* 鍵 ID (Key ID)。
|
|
1221
|
+
* JWT ヘッダーの kid と照合して使用する鍵を特定します。
|
|
1222
|
+
*/
|
|
1223
|
+
kid: string;
|
|
1224
|
+
/**
|
|
1225
|
+
* アルゴリズム (Algorithm)。
|
|
1226
|
+
* この鍵で使用するアルゴリズムを示します。
|
|
1227
|
+
*/
|
|
1228
|
+
alg: 'ES256';
|
|
1229
|
+
/**
|
|
1230
|
+
* 楕円曲線名 (Curve)。
|
|
1231
|
+
* ES256 の場合は "P-256"。
|
|
1232
|
+
*/
|
|
1233
|
+
crv: 'P-256';
|
|
1234
|
+
/**
|
|
1235
|
+
* 楕円曲線の x 座標 (X Coordinate)。
|
|
1236
|
+
* Base64url エンコードされた値。
|
|
1237
|
+
*/
|
|
1238
|
+
x: string;
|
|
1239
|
+
/**
|
|
1240
|
+
* 楕円曲線の y 座標 (Y Coordinate)。
|
|
1241
|
+
* Base64url エンコードされた値。
|
|
1242
|
+
*/
|
|
1243
|
+
y: string;
|
|
1244
|
+
[key: string]: unknown;
|
|
1245
|
+
};
|
|
1246
|
+
/**
|
|
1247
|
+
* JSON Web Key (JWK)。
|
|
1248
|
+
* 公開鍵を JSON 形式で表現します (RFC 7517)。
|
|
1249
|
+
* 鍵タイプ (kty) に応じて RSA または EC の形式を返します。
|
|
1250
|
+
*/
|
|
1251
|
+
export type JsonWebKey = ({
|
|
1252
|
+
kty: 'RSA';
|
|
1253
|
+
} & RsaJsonWebKey) | ({
|
|
1254
|
+
kty: 'EC';
|
|
1255
|
+
} & EcJsonWebKey);
|
|
1256
|
+
/**
|
|
1257
|
+
* OAuth 2.0 クライアント識別子(英数字小文字・ハイフン)。
|
|
1258
|
+
*
|
|
1259
|
+
* クライアントは事前に認可サーバーに登録され、一意の識別子が発行されます。
|
|
1260
|
+
* パブリッククライアント(SPA、モバイルアプリ)と機密クライアント(サーバーサイドアプリ)の両方で使用されます。
|
|
1261
|
+
*/
|
|
1262
|
+
export type ClientId = string;
|
|
1263
|
+
/**
|
|
1264
|
+
* 認証後にリダイレクトする URI。登録済みのコールバック URI と一致する必要があります。
|
|
1265
|
+
*
|
|
1266
|
+
* **重要**: `/oauth/authorize` で使用した値と `/oauth/token` で送信する値は完全一致する必要があります(RFC 6749 Section 4.1.3)。
|
|
1267
|
+
* クライアントは事前に認可サーバーへリダイレクト URI を登録し、ホワイトリスト化されたもののみが許可されます。
|
|
1268
|
+
*/
|
|
1269
|
+
export type RedirectUri = string;
|
|
1270
|
+
/**
|
|
1271
|
+
* 要求するスコープを空白区切りで指定します(例: `openid profile email`)。
|
|
1272
|
+
*
|
|
1273
|
+
* **許可されたスコープ値**:
|
|
1274
|
+
* - `openid`: OpenID Connect 認証(必須)
|
|
1275
|
+
* - `profile`: ユーザープロファイル情報へのアクセス
|
|
1276
|
+
* - `email`: メールアドレスへのアクセス
|
|
1277
|
+
* - `offline_access`: リフレッシュトークンの発行
|
|
1278
|
+
*/
|
|
1279
|
+
export type Scope = string;
|
|
1280
|
+
/**
|
|
1281
|
+
* PKCE コードチャレンジメソッド。本実装は S256(SHA-256)のみをサポートします。
|
|
1282
|
+
*
|
|
1283
|
+
* **RFC 7636 Section 4.3**:
|
|
1284
|
+
* - `S256`: code_challenge = BASE64URL(SHA256(ASCII(code_verifier)))
|
|
1285
|
+
* - `plain`: セキュリティ上のリスクがあるため、本実装では非サポート
|
|
1286
|
+
*
|
|
1287
|
+
* クライアントは必ず S256 メソッドを使用してください。
|
|
1288
|
+
*/
|
|
1289
|
+
export declare const CodeChallengeMethod: {
|
|
1290
|
+
readonly S256: "S256";
|
|
1291
|
+
};
|
|
1292
|
+
/**
|
|
1293
|
+
* PKCE コードチャレンジメソッド。本実装は S256(SHA-256)のみをサポートします。
|
|
1294
|
+
*
|
|
1295
|
+
* **RFC 7636 Section 4.3**:
|
|
1296
|
+
* - `S256`: code_challenge = BASE64URL(SHA256(ASCII(code_verifier)))
|
|
1297
|
+
* - `plain`: セキュリティ上のリスクがあるため、本実装では非サポート
|
|
1298
|
+
*
|
|
1299
|
+
* クライアントは必ず S256 メソッドを使用してください。
|
|
1300
|
+
*/
|
|
1301
|
+
export type CodeChallengeMethod = typeof CodeChallengeMethod[keyof typeof CodeChallengeMethod];
|
|
1302
|
+
/**
|
|
1303
|
+
* PKCE (RFC 7636) で使用する文字列。unreserved 文字セット(A-Z, a-z, 0-9, -, ., _, ~)のみで構成されます。
|
|
1304
|
+
*
|
|
1305
|
+
* **RFC 7636 Section 4.1**:
|
|
1306
|
+
* > unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~"
|
|
1307
|
+
*
|
|
1308
|
+
* このスキーマは code_challenge と code_verifier の両方に使用されます。
|
|
1309
|
+
*/
|
|
1310
|
+
export type PkceVerifierString = string;
|
|
1311
|
+
/**
|
|
1312
|
+
* 組織招待一覧レスポンス(ページネーション付き)。
|
|
1313
|
+
*/
|
|
1314
|
+
export type AdminOrganizationInvitationListResponse = {
|
|
1315
|
+
/**
|
|
1316
|
+
* 招待の配列。
|
|
1317
|
+
*/
|
|
1318
|
+
data: Array<OrganizationInvitation>;
|
|
1319
|
+
meta: PaginationMeta;
|
|
1320
|
+
};
|
|
1321
|
+
/**
|
|
1322
|
+
* OAuth 2.0 Authorization Code フローを示す固定値です。
|
|
1323
|
+
*/
|
|
1324
|
+
export declare const ResponseType: {
|
|
1325
|
+
readonly CODE: "code";
|
|
1326
|
+
};
|
|
1327
|
+
/**
|
|
1328
|
+
* OAuth 2.0 Authorization Code フローを示す固定値です。
|
|
1329
|
+
*/
|
|
1330
|
+
export type ResponseType = typeof ResponseType[keyof typeof ResponseType];
|
|
1331
|
+
export type ClientId2 = ClientId;
|
|
1332
|
+
export type RedirectUri2 = RedirectUri;
|
|
1333
|
+
export type Scope2 = Scope;
|
|
1334
|
+
/**
|
|
1335
|
+
* CSRF 対策用のランダムなトークン。
|
|
1336
|
+
*/
|
|
1337
|
+
export type AuthorizeState = string;
|
|
1338
|
+
export type CodeChallengeMethod2 = CodeChallengeMethod;
|
|
1339
|
+
export type CodeChallenge = PkceVerifierString & unknown;
|
|
1340
|
+
/**
|
|
1341
|
+
* OIDC リプレイ攻撃対策用の値。レスポンスに含めて検証します。
|
|
1342
|
+
*/
|
|
1343
|
+
export type Nonce = string;
|
|
1344
|
+
/**
|
|
1345
|
+
* 組織固有の SSO プロバイダ(Okta, Azure AD 等)へルーティングするための組織 ID。未指定時は AuthKit のデフォルトログインフローが使用されます。
|
|
1346
|
+
*/
|
|
1347
|
+
export type OrganizationId = string;
|
|
1348
|
+
/**
|
|
1349
|
+
* WorkOS 招待メールに含まれるトークン。指定時は WorkOS AuthKit に招待受諾フローとしてパススルーされます。
|
|
1350
|
+
*/
|
|
1351
|
+
export type InvitationToken = string;
|
|
1352
|
+
/**
|
|
1353
|
+
* OIDC 認証プロンプト制御。
|
|
1354
|
+
* - `none`: ユーザーインタラクションなしで認証を試みる。セッションがない場合は `login_required` エラーをリダイレクト
|
|
1355
|
+
* - `login`: 既存セッションを無視して再認証を強制
|
|
1356
|
+
* - 未指定: セッションがあれば利用、なければ IdP リダイレクト
|
|
1357
|
+
*/
|
|
1358
|
+
export declare const Prompt: {
|
|
1359
|
+
readonly NONE: "none";
|
|
1360
|
+
readonly LOGIN: "login";
|
|
1361
|
+
};
|
|
1362
|
+
/**
|
|
1363
|
+
* OIDC 認証プロンプト制御。
|
|
1364
|
+
* - `none`: ユーザーインタラクションなしで認証を試みる。セッションがない場合は `login_required` エラーをリダイレクト
|
|
1365
|
+
* - `login`: 既存セッションを無視して再認証を強制
|
|
1366
|
+
* - 未指定: セッションがあれば利用、なければ IdP リダイレクト
|
|
1367
|
+
*/
|
|
1368
|
+
export type Prompt = typeof Prompt[keyof typeof Prompt];
|
|
1369
|
+
/**
|
|
1370
|
+
* WorkOS AuthKit の Sign-in endpoint から渡される不透明トークン。招待受諾やパスワードリセット等、アプリ外から開始されたフローのコンテキストを保持します。
|
|
1371
|
+
*/
|
|
1372
|
+
export type Context = string;
|
|
1373
|
+
/**
|
|
1374
|
+
* IdP から発行された認可コード。
|
|
1375
|
+
* 認証が成功した場合にのみ含まれます。
|
|
1376
|
+
*/
|
|
1377
|
+
export type Code = string;
|
|
1378
|
+
/**
|
|
1379
|
+
* `/oauth/authorize` リクエスト時にクライアントが送信した state パラメータ。
|
|
1380
|
+
* CSRF 対策およびリクエストの紐付けに使用します。
|
|
1381
|
+
*/
|
|
1382
|
+
export type CallbackState = string;
|
|
1383
|
+
/**
|
|
1384
|
+
* IdP での認証・認可が失敗した場合のエラーコード (RFC 6749 Section 4.1.2.1)。
|
|
1385
|
+
*
|
|
1386
|
+
* - `access_denied`: ユーザーが認可を拒否した
|
|
1387
|
+
* - `server_error`: IdP でサーバーエラーが発生した
|
|
1388
|
+
* - `temporarily_unavailable`: IdP が一時的に利用不可
|
|
1389
|
+
* - `invalid_request`: リクエストが不正
|
|
1390
|
+
* - `unauthorized_client`: クライアントが認可されていない
|
|
1391
|
+
* - `unsupported_response_type`: response_type がサポートされていない
|
|
1392
|
+
* - `invalid_scope`: スコープが不正
|
|
1393
|
+
*/
|
|
1394
|
+
export declare const Error_: {
|
|
1395
|
+
readonly ACCESS_DENIED: "access_denied";
|
|
1396
|
+
readonly SERVER_ERROR: "server_error";
|
|
1397
|
+
readonly TEMPORARILY_UNAVAILABLE: "temporarily_unavailable";
|
|
1398
|
+
readonly INVALID_REQUEST: "invalid_request";
|
|
1399
|
+
readonly UNAUTHORIZED_CLIENT: "unauthorized_client";
|
|
1400
|
+
readonly UNSUPPORTED_RESPONSE_TYPE: "unsupported_response_type";
|
|
1401
|
+
readonly INVALID_SCOPE: "invalid_scope";
|
|
1402
|
+
};
|
|
1403
|
+
/**
|
|
1404
|
+
* IdP での認証・認可が失敗した場合のエラーコード (RFC 6749 Section 4.1.2.1)。
|
|
1405
|
+
*
|
|
1406
|
+
* - `access_denied`: ユーザーが認可を拒否した
|
|
1407
|
+
* - `server_error`: IdP でサーバーエラーが発生した
|
|
1408
|
+
* - `temporarily_unavailable`: IdP が一時的に利用不可
|
|
1409
|
+
* - `invalid_request`: リクエストが不正
|
|
1410
|
+
* - `unauthorized_client`: クライアントが認可されていない
|
|
1411
|
+
* - `unsupported_response_type`: response_type がサポートされていない
|
|
1412
|
+
* - `invalid_scope`: スコープが不正
|
|
1413
|
+
*/
|
|
1414
|
+
export type Error = typeof Error_[keyof typeof Error_];
|
|
1415
|
+
/**
|
|
1416
|
+
* エラーの詳細を説明する人間可読なテキスト (RFC 6749 Section 4.1.2.1)。
|
|
1417
|
+
*/
|
|
1418
|
+
export type ErrorDescription = string;
|
|
1419
|
+
/**
|
|
1420
|
+
* ログアウト対象のユーザーを特定するための ID トークン。
|
|
1421
|
+
*
|
|
1422
|
+
* OP (OpenID Provider) は、このトークンを使用してログアウト対象の
|
|
1423
|
+
* エンドユーザーのセッションを特定します。トークンは暗号化されていても構いません。
|
|
1424
|
+
*
|
|
1425
|
+
* OP は必ずしもトークンの署名を検証する必要はありませんが、
|
|
1426
|
+
* `aud` クレームに自身が含まれていることを確認します。
|
|
1427
|
+
*/
|
|
1428
|
+
export type IdTokenHint = string;
|
|
1429
|
+
/**
|
|
1430
|
+
* ログアウト対象のエンドユーザーに関するヒント。
|
|
1431
|
+
*
|
|
1432
|
+
* OP がエンドユーザーを特定するために使用できる追加情報です。
|
|
1433
|
+
* `id_token_hint` が提供されていない場合に、ユーザーを特定するための
|
|
1434
|
+
* 補助的な手段として使用されることがあります。
|
|
1435
|
+
*/
|
|
1436
|
+
export type LogoutHint = string;
|
|
1437
|
+
/**
|
|
1438
|
+
* ログアウト完了後にユーザーをリダイレクトする URI。
|
|
1439
|
+
*
|
|
1440
|
+
* この URI は、事前にクライアント登録時に `post_logout_redirect_uris` として
|
|
1441
|
+
* 登録されている必要があります。登録されていない URI が指定された場合、
|
|
1442
|
+
* リダイレクトは行われません。
|
|
1443
|
+
*
|
|
1444
|
+
* `id_token_hint` が省略され、`client_id` が指定されている場合、
|
|
1445
|
+
* その `client_id` に登録されている URI と照合されます。
|
|
1446
|
+
*
|
|
1447
|
+
* `id_token_hint` と `client_id` の両方が省略された場合、
|
|
1448
|
+
* リダイレクトは行われず、ログアウト完了画面が表示されます。
|
|
1449
|
+
*/
|
|
1450
|
+
export type PostLogoutRedirectUri = string;
|
|
1451
|
+
/**
|
|
1452
|
+
* RP (Relying Party) のクライアント識別子。
|
|
1453
|
+
*
|
|
1454
|
+
* `id_token_hint` が提供されない場合に、クライアントを特定するために使用されます。
|
|
1455
|
+
* `id_token_hint` が提供される場合、このパラメータは無視される場合があります。
|
|
1456
|
+
*/
|
|
1457
|
+
export type EndSessionClientId = ClientId;
|
|
1458
|
+
/**
|
|
1459
|
+
* RP がセッション状態を維持するために生成する推測困難な任意の文字列(OP はこの値を解釈せずそのまま返却します)。
|
|
1460
|
+
*
|
|
1461
|
+
* `post_logout_redirect_uri` へのリダイレクト時にクエリパラメータとして
|
|
1462
|
+
* そのまま返却されます。CSRF 攻撃を防ぐために使用できます。
|
|
1463
|
+
*/
|
|
1464
|
+
export type EndSessionState = string;
|
|
1465
|
+
/**
|
|
1466
|
+
* エンドユーザーの優先言語およびスクリプトを表す BCP47 言語タグのスペース区切りリスト。
|
|
1467
|
+
*
|
|
1468
|
+
* OP はこの値を使用して、ログアウト確認画面やエラーメッセージの表示言語を
|
|
1469
|
+
* 決定することができます。優先度の高い順に並べます。
|
|
1470
|
+
*/
|
|
1471
|
+
export type UiLocales = string;
|
|
1472
|
+
/**
|
|
1473
|
+
* 取得するページ番号(1始まり)。
|
|
1474
|
+
*/
|
|
1475
|
+
export type Page = number;
|
|
1476
|
+
/**
|
|
1477
|
+
* 1ページあたりの取得件数。
|
|
1478
|
+
*/
|
|
1479
|
+
export type PerPage = number;
|
|
1480
|
+
/**
|
|
1481
|
+
* クライアント識別子。
|
|
1482
|
+
*/
|
|
1483
|
+
export type ClientIdPath = string;
|
|
1484
|
+
/**
|
|
1485
|
+
* 組織識別子(UUID形式)。
|
|
1486
|
+
*/
|
|
1487
|
+
export type OrganizationIdPath = string;
|
|
1488
|
+
/**
|
|
1489
|
+
* ソート基準フィールド。
|
|
1490
|
+
* - `name`: ユーザー表示名
|
|
1491
|
+
* - `email`: ユーザーメールアドレス
|
|
1492
|
+
* - `role`: 組織内ロール
|
|
1493
|
+
* - `joined_at`: 組織への参加日時
|
|
1494
|
+
* - `last_access`: 組織への最終アクセス日時
|
|
1495
|
+
*/
|
|
1496
|
+
export declare const MemberSortBy: {
|
|
1497
|
+
readonly NAME: "name";
|
|
1498
|
+
readonly EMAIL: "email";
|
|
1499
|
+
readonly ROLE: "role";
|
|
1500
|
+
readonly JOINED_AT: "joined_at";
|
|
1501
|
+
readonly LAST_ACCESS: "last_access";
|
|
1502
|
+
};
|
|
1503
|
+
/**
|
|
1504
|
+
* ソート基準フィールド。
|
|
1505
|
+
* - `name`: ユーザー表示名
|
|
1506
|
+
* - `email`: ユーザーメールアドレス
|
|
1507
|
+
* - `role`: 組織内ロール
|
|
1508
|
+
* - `joined_at`: 組織への参加日時
|
|
1509
|
+
* - `last_access`: 組織への最終アクセス日時
|
|
1510
|
+
*/
|
|
1511
|
+
export type MemberSortBy = typeof MemberSortBy[keyof typeof MemberSortBy];
|
|
1512
|
+
/**
|
|
1513
|
+
* ソート順。
|
|
1514
|
+
* - `asc`: 昇順
|
|
1515
|
+
* - `desc`: 降順
|
|
1516
|
+
*/
|
|
1517
|
+
export declare const MemberSortOrder: {
|
|
1518
|
+
readonly ASC: "asc";
|
|
1519
|
+
readonly DESC: "desc";
|
|
1520
|
+
};
|
|
1521
|
+
/**
|
|
1522
|
+
* ソート順。
|
|
1523
|
+
* - `asc`: 昇順
|
|
1524
|
+
* - `desc`: 降順
|
|
1525
|
+
*/
|
|
1526
|
+
export type MemberSortOrder = typeof MemberSortOrder[keyof typeof MemberSortOrder];
|
|
1527
|
+
/**
|
|
1528
|
+
* ロールでメンバーを絞り込みます。カンマ区切りで複数値を指定可能(例: `?role=owner,admin`)。
|
|
1529
|
+
* 未指定時は全ロールを返却します。
|
|
1530
|
+
*/
|
|
1531
|
+
export type MemberRoleFilter = Array<OrganizationRole>;
|
|
1532
|
+
/**
|
|
1533
|
+
* メンバーのメールドメインが組織の verified ドメインと一致するか (`corporate`)、しないか (`personal`) で絞り込みます。
|
|
1534
|
+
* カンマ区切りで複数値を指定可能(例: `?domain_type=corporate,personal`)。未指定時は全件返却します。
|
|
1535
|
+
*/
|
|
1536
|
+
export type MemberDomainTypeFilter = Array<OrganizationMemberDomainType>;
|
|
1537
|
+
/**
|
|
1538
|
+
* メンバーの表示名またはメールアドレスに対する部分一致検索文字列。
|
|
1539
|
+
* 1〜255 文字。空文字列はバリデーションエラー(400)となります。
|
|
1540
|
+
*/
|
|
1541
|
+
export type MemberSearch = string;
|
|
1542
|
+
/**
|
|
1543
|
+
* `true` の場合、レスポンスのトップレベルに `role_counts` と `domain_counts`(フィルタ適用前の総件数集計)を含めて返却します。
|
|
1544
|
+
* 集計コストを避けるためデフォルトは `false`。
|
|
1545
|
+
*/
|
|
1546
|
+
export type IncludeCounts = boolean;
|
|
1547
|
+
/**
|
|
1548
|
+
* メンバー識別子(UUID形式)。
|
|
1549
|
+
*/
|
|
1550
|
+
export type MemberIdPath = string;
|
|
1551
|
+
/**
|
|
1552
|
+
* 招待識別子(UUID形式)。
|
|
1553
|
+
*/
|
|
1554
|
+
export type InvitationIdPath = string;
|
|
1555
|
+
export type GetServiceInfoData = {
|
|
1556
|
+
body?: never;
|
|
1557
|
+
path?: never;
|
|
1558
|
+
query?: never;
|
|
1559
|
+
url: '/';
|
|
1560
|
+
};
|
|
1561
|
+
export type GetServiceInfoErrors = {
|
|
1562
|
+
/**
|
|
1563
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1564
|
+
*/
|
|
1565
|
+
404: ProblemDetails;
|
|
1566
|
+
};
|
|
1567
|
+
export type GetServiceInfoError = GetServiceInfoErrors[keyof GetServiceInfoErrors];
|
|
1568
|
+
export type GetServiceInfoResponses = {
|
|
1569
|
+
/**
|
|
1570
|
+
* サービス情報の応答。
|
|
1571
|
+
*/
|
|
1572
|
+
200: ServiceInfoResponse;
|
|
1573
|
+
};
|
|
1574
|
+
export type GetServiceInfoResponse = GetServiceInfoResponses[keyof GetServiceInfoResponses];
|
|
1575
|
+
export type GetOpenIdConfigurationData = {
|
|
1576
|
+
body?: never;
|
|
1577
|
+
path?: never;
|
|
1578
|
+
query?: never;
|
|
1579
|
+
url: '/.well-known/openid-configuration';
|
|
1580
|
+
};
|
|
1581
|
+
export type GetOpenIdConfigurationErrors = {
|
|
1582
|
+
/**
|
|
1583
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1584
|
+
*/
|
|
1585
|
+
500: ProblemDetails;
|
|
1586
|
+
/**
|
|
1587
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1588
|
+
*/
|
|
1589
|
+
503: ProblemDetails;
|
|
1590
|
+
};
|
|
1591
|
+
export type GetOpenIdConfigurationError = GetOpenIdConfigurationErrors[keyof GetOpenIdConfigurationErrors];
|
|
1592
|
+
export type GetOpenIdConfigurationResponses = {
|
|
1593
|
+
/**
|
|
1594
|
+
* OpenID Connect プロバイダーメタデータ。
|
|
1595
|
+
*/
|
|
1596
|
+
200: OpenIdProviderMetadataResponse;
|
|
1597
|
+
};
|
|
1598
|
+
export type GetOpenIdConfigurationResponse = GetOpenIdConfigurationResponses[keyof GetOpenIdConfigurationResponses];
|
|
1599
|
+
export type GetHealthStatusData = {
|
|
1600
|
+
body?: never;
|
|
1601
|
+
path?: never;
|
|
1602
|
+
query?: never;
|
|
1603
|
+
url: '/health';
|
|
1604
|
+
};
|
|
1605
|
+
export type GetHealthStatusErrors = {
|
|
1606
|
+
/**
|
|
1607
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1608
|
+
*/
|
|
1609
|
+
503: ProblemDetails;
|
|
1610
|
+
};
|
|
1611
|
+
export type GetHealthStatusError = GetHealthStatusErrors[keyof GetHealthStatusErrors];
|
|
1612
|
+
export type GetHealthStatusResponses = {
|
|
1613
|
+
/**
|
|
1614
|
+
* ヘルスチェックが成功した場合の応答。
|
|
1615
|
+
*/
|
|
1616
|
+
200: HealthStatus;
|
|
1617
|
+
};
|
|
1618
|
+
export type GetHealthStatusResponse = GetHealthStatusResponses[keyof GetHealthStatusResponses];
|
|
1619
|
+
export type GetJwksData = {
|
|
1620
|
+
body?: never;
|
|
1621
|
+
path?: never;
|
|
1622
|
+
query?: never;
|
|
1623
|
+
url: '/jwks';
|
|
1624
|
+
};
|
|
1625
|
+
export type GetJwksErrors = {
|
|
1626
|
+
/**
|
|
1627
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
1628
|
+
*/
|
|
1629
|
+
429: ProblemDetails;
|
|
1630
|
+
/**
|
|
1631
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1632
|
+
*/
|
|
1633
|
+
500: ProblemDetails;
|
|
1634
|
+
/**
|
|
1635
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1636
|
+
*/
|
|
1637
|
+
503: ProblemDetails;
|
|
1638
|
+
};
|
|
1639
|
+
export type GetJwksError = GetJwksErrors[keyof GetJwksErrors];
|
|
1640
|
+
export type GetJwksResponses = {
|
|
1641
|
+
/**
|
|
1642
|
+
* JSON Web Key Set の取得に成功した場合のレスポンス。
|
|
1643
|
+
*/
|
|
1644
|
+
200: JwksResponse;
|
|
1645
|
+
};
|
|
1646
|
+
export type GetJwksResponse = GetJwksResponses[keyof GetJwksResponses];
|
|
1647
|
+
export type InitiateAuthorizationData = {
|
|
1648
|
+
body?: never;
|
|
1649
|
+
path?: never;
|
|
1650
|
+
query: {
|
|
1651
|
+
/**
|
|
1652
|
+
* OAuth 2.0 Authorization Code フローを示す固定値です。
|
|
1653
|
+
*/
|
|
1654
|
+
response_type: 'code';
|
|
1655
|
+
client_id: ClientId;
|
|
1656
|
+
redirect_uri: RedirectUri;
|
|
1657
|
+
scope: Scope;
|
|
1658
|
+
/**
|
|
1659
|
+
* CSRF 対策用のランダムなトークン。
|
|
1660
|
+
*/
|
|
1661
|
+
state: string;
|
|
1662
|
+
code_challenge_method: CodeChallengeMethod;
|
|
1663
|
+
code_challenge: PkceVerifierString & unknown;
|
|
1664
|
+
/**
|
|
1665
|
+
* OIDC リプレイ攻撃対策用の値。レスポンスに含めて検証します。
|
|
1666
|
+
*/
|
|
1667
|
+
nonce: string;
|
|
1668
|
+
/**
|
|
1669
|
+
* 組織固有の SSO プロバイダ(Okta, Azure AD 等)へルーティングするための組織 ID。未指定時は AuthKit のデフォルトログインフローが使用されます。
|
|
1670
|
+
*/
|
|
1671
|
+
organization_id?: string;
|
|
1672
|
+
/**
|
|
1673
|
+
* WorkOS 招待メールに含まれるトークン。指定時は WorkOS AuthKit に招待受諾フローとしてパススルーされます。
|
|
1674
|
+
*/
|
|
1675
|
+
invitation_token?: string;
|
|
1676
|
+
/**
|
|
1677
|
+
* OIDC 認証プロンプト制御。
|
|
1678
|
+
* - `none`: ユーザーインタラクションなしで認証を試みる。セッションがない場合は `login_required` エラーをリダイレクト
|
|
1679
|
+
* - `login`: 既存セッションを無視して再認証を強制
|
|
1680
|
+
* - 未指定: セッションがあれば利用、なければ IdP リダイレクト
|
|
1681
|
+
*/
|
|
1682
|
+
prompt?: 'none' | 'login';
|
|
1683
|
+
/**
|
|
1684
|
+
* WorkOS AuthKit の Sign-in endpoint から渡される不透明トークン。招待受諾やパスワードリセット等、アプリ外から開始されたフローのコンテキストを保持します。
|
|
1685
|
+
*/
|
|
1686
|
+
context?: string;
|
|
1687
|
+
};
|
|
1688
|
+
url: '/oauth/authorize';
|
|
1689
|
+
};
|
|
1690
|
+
export type InitiateAuthorizationErrors = {
|
|
1691
|
+
/**
|
|
1692
|
+
* エラー情報を含むHTMLページ
|
|
1693
|
+
*/
|
|
1694
|
+
400: string;
|
|
1695
|
+
/**
|
|
1696
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1697
|
+
*/
|
|
1698
|
+
422: ProblemDetails;
|
|
1699
|
+
/**
|
|
1700
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
1701
|
+
*/
|
|
1702
|
+
429: ProblemDetails;
|
|
1703
|
+
/**
|
|
1704
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1705
|
+
*/
|
|
1706
|
+
500: ProblemDetails;
|
|
1707
|
+
/**
|
|
1708
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1709
|
+
*/
|
|
1710
|
+
503: ProblemDetails;
|
|
1711
|
+
};
|
|
1712
|
+
export type InitiateAuthorizationError = InitiateAuthorizationErrors[keyof InitiateAuthorizationErrors];
|
|
1713
|
+
export type HandleIdpCallbackData = {
|
|
1714
|
+
body?: never;
|
|
1715
|
+
path?: never;
|
|
1716
|
+
query?: {
|
|
1717
|
+
/**
|
|
1718
|
+
* IdP から発行された認可コード。
|
|
1719
|
+
* 認証が成功した場合にのみ含まれます。
|
|
1720
|
+
*/
|
|
1721
|
+
code?: string;
|
|
1722
|
+
/**
|
|
1723
|
+
* `/oauth/authorize` リクエスト時にクライアントが送信した state パラメータ。
|
|
1724
|
+
* CSRF 対策およびリクエストの紐付けに使用します。
|
|
1725
|
+
*/
|
|
1726
|
+
state?: string;
|
|
1727
|
+
/**
|
|
1728
|
+
* IdP での認証・認可が失敗した場合のエラーコード (RFC 6749 Section 4.1.2.1)。
|
|
1729
|
+
*
|
|
1730
|
+
* - `access_denied`: ユーザーが認可を拒否した
|
|
1731
|
+
* - `server_error`: IdP でサーバーエラーが発生した
|
|
1732
|
+
* - `temporarily_unavailable`: IdP が一時的に利用不可
|
|
1733
|
+
* - `invalid_request`: リクエストが不正
|
|
1734
|
+
* - `unauthorized_client`: クライアントが認可されていない
|
|
1735
|
+
* - `unsupported_response_type`: response_type がサポートされていない
|
|
1736
|
+
* - `invalid_scope`: スコープが不正
|
|
1737
|
+
*/
|
|
1738
|
+
error?: 'access_denied' | 'server_error' | 'temporarily_unavailable' | 'invalid_request' | 'unauthorized_client' | 'unsupported_response_type' | 'invalid_scope';
|
|
1739
|
+
/**
|
|
1740
|
+
* エラーの詳細を説明する人間可読なテキスト (RFC 6749 Section 4.1.2.1)。
|
|
1741
|
+
*/
|
|
1742
|
+
error_description?: string;
|
|
1743
|
+
};
|
|
1744
|
+
url: '/oauth/callback';
|
|
1745
|
+
};
|
|
1746
|
+
export type HandleIdpCallbackErrors = {
|
|
1747
|
+
/**
|
|
1748
|
+
* エラー情報を含むHTMLページ
|
|
1749
|
+
*/
|
|
1750
|
+
400: string;
|
|
1751
|
+
/**
|
|
1752
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1753
|
+
*/
|
|
1754
|
+
500: ProblemDetails;
|
|
1755
|
+
/**
|
|
1756
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1757
|
+
*/
|
|
1758
|
+
503: ProblemDetails;
|
|
1759
|
+
};
|
|
1760
|
+
export type HandleIdpCallbackError = HandleIdpCallbackErrors[keyof HandleIdpCallbackErrors];
|
|
1761
|
+
export type IssueTokensData = {
|
|
1762
|
+
body: TokenRequest;
|
|
1763
|
+
path?: never;
|
|
1764
|
+
query?: never;
|
|
1765
|
+
url: '/oauth/token';
|
|
1766
|
+
};
|
|
1767
|
+
export type IssueTokensErrors = {
|
|
1768
|
+
/**
|
|
1769
|
+
* トークンリクエストが無効な場合のエラーレスポンス (RFC 6749 Section 5.2)。
|
|
1770
|
+
*
|
|
1771
|
+
* **返却されるエラーコード**:
|
|
1772
|
+
* - `invalid_request`: リクエストパラメータの不備
|
|
1773
|
+
* - `invalid_grant`: 認可コード/リフレッシュトークンの問題
|
|
1774
|
+
* - `unauthorized_client`: グラントタイプの権限不足
|
|
1775
|
+
* - `unsupported_grant_type`: 未サポートのグラントタイプ
|
|
1776
|
+
* - `invalid_scope`: スコープの問題
|
|
1777
|
+
*/
|
|
1778
|
+
400: TokenErrorResponse;
|
|
1779
|
+
/**
|
|
1780
|
+
* クライアント認証に失敗した場合のエラーレスポンス (RFC 6749 Section 5.2)。
|
|
1781
|
+
*
|
|
1782
|
+
* **返却されるエラーコード**:
|
|
1783
|
+
* - `invalid_client`: クライアント認証失敗
|
|
1784
|
+
*
|
|
1785
|
+
* HTTP Basic 認証を使用している場合、WWW-Authenticate ヘッダーが含まれます。
|
|
1786
|
+
*/
|
|
1787
|
+
401: TokenErrorResponse;
|
|
1788
|
+
/**
|
|
1789
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
1790
|
+
*/
|
|
1791
|
+
429: ProblemDetails;
|
|
1792
|
+
/**
|
|
1793
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1794
|
+
*/
|
|
1795
|
+
500: ProblemDetails;
|
|
1796
|
+
/**
|
|
1797
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1798
|
+
*/
|
|
1799
|
+
503: ProblemDetails;
|
|
1800
|
+
};
|
|
1801
|
+
export type IssueTokensError = IssueTokensErrors[keyof IssueTokensErrors];
|
|
1802
|
+
export type IssueTokensResponses = {
|
|
1803
|
+
/**
|
|
1804
|
+
* トークンの発行に成功した場合のレスポンス。
|
|
1805
|
+
*/
|
|
1806
|
+
200: TokenResponse;
|
|
1807
|
+
};
|
|
1808
|
+
export type IssueTokensResponse = IssueTokensResponses[keyof IssueTokensResponses];
|
|
1809
|
+
export type GetUserinfoData = {
|
|
1810
|
+
body?: never;
|
|
1811
|
+
path?: never;
|
|
1812
|
+
query?: never;
|
|
1813
|
+
url: '/oauth/userinfo';
|
|
1814
|
+
};
|
|
1815
|
+
export type GetUserinfoErrors = {
|
|
1816
|
+
/**
|
|
1817
|
+
* アクセストークンが無効または期限切れの場合のエラーレスポンス (RFC 6750)。
|
|
1818
|
+
*/
|
|
1819
|
+
401: {
|
|
1820
|
+
/**
|
|
1821
|
+
* エラーコード。
|
|
1822
|
+
*/
|
|
1823
|
+
error: 'invalid_token';
|
|
1824
|
+
/**
|
|
1825
|
+
* エラーの詳細な説明。
|
|
1826
|
+
*/
|
|
1827
|
+
error_description?: string;
|
|
1828
|
+
};
|
|
1829
|
+
/**
|
|
1830
|
+
* アクセストークンに必要なスコープが含まれていない場合のエラーレスポンス (RFC 6750)。
|
|
1831
|
+
*/
|
|
1832
|
+
403: {
|
|
1833
|
+
/**
|
|
1834
|
+
* エラーコード。
|
|
1835
|
+
*/
|
|
1836
|
+
error: 'insufficient_scope';
|
|
1837
|
+
/**
|
|
1838
|
+
* エラーの詳細な説明。
|
|
1839
|
+
*/
|
|
1840
|
+
error_description?: string;
|
|
1841
|
+
};
|
|
1842
|
+
/**
|
|
1843
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
1844
|
+
*/
|
|
1845
|
+
429: ProblemDetails;
|
|
1846
|
+
/**
|
|
1847
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1848
|
+
*/
|
|
1849
|
+
500: ProblemDetails;
|
|
1850
|
+
/**
|
|
1851
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1852
|
+
*/
|
|
1853
|
+
503: ProblemDetails;
|
|
1854
|
+
};
|
|
1855
|
+
export type GetUserinfoError = GetUserinfoErrors[keyof GetUserinfoErrors];
|
|
1856
|
+
export type GetUserinfoResponses = {
|
|
1857
|
+
/**
|
|
1858
|
+
* ユーザー情報の取得に成功した場合のレスポンス。
|
|
1859
|
+
*/
|
|
1860
|
+
200: UserinfoResponse;
|
|
1861
|
+
};
|
|
1862
|
+
export type GetUserinfoResponse = GetUserinfoResponses[keyof GetUserinfoResponses];
|
|
1863
|
+
export type PostUserinfoData = {
|
|
1864
|
+
body?: never;
|
|
1865
|
+
path?: never;
|
|
1866
|
+
query?: never;
|
|
1867
|
+
url: '/oauth/userinfo';
|
|
1868
|
+
};
|
|
1869
|
+
export type PostUserinfoErrors = {
|
|
1870
|
+
/**
|
|
1871
|
+
* アクセストークンが無効または期限切れの場合のエラーレスポンス (RFC 6750)。
|
|
1872
|
+
*/
|
|
1873
|
+
401: {
|
|
1874
|
+
/**
|
|
1875
|
+
* エラーコード。
|
|
1876
|
+
*/
|
|
1877
|
+
error: 'invalid_token';
|
|
1878
|
+
/**
|
|
1879
|
+
* エラーの詳細な説明。
|
|
1880
|
+
*/
|
|
1881
|
+
error_description?: string;
|
|
1882
|
+
};
|
|
1883
|
+
/**
|
|
1884
|
+
* アクセストークンに必要なスコープが含まれていない場合のエラーレスポンス (RFC 6750)。
|
|
1885
|
+
*/
|
|
1886
|
+
403: {
|
|
1887
|
+
/**
|
|
1888
|
+
* エラーコード。
|
|
1889
|
+
*/
|
|
1890
|
+
error: 'insufficient_scope';
|
|
1891
|
+
/**
|
|
1892
|
+
* エラーの詳細な説明。
|
|
1893
|
+
*/
|
|
1894
|
+
error_description?: string;
|
|
1895
|
+
};
|
|
1896
|
+
/**
|
|
1897
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
1898
|
+
*/
|
|
1899
|
+
429: ProblemDetails;
|
|
1900
|
+
/**
|
|
1901
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1902
|
+
*/
|
|
1903
|
+
500: ProblemDetails;
|
|
1904
|
+
/**
|
|
1905
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1906
|
+
*/
|
|
1907
|
+
503: ProblemDetails;
|
|
1908
|
+
};
|
|
1909
|
+
export type PostUserinfoError = PostUserinfoErrors[keyof PostUserinfoErrors];
|
|
1910
|
+
export type PostUserinfoResponses = {
|
|
1911
|
+
/**
|
|
1912
|
+
* ユーザー情報の取得に成功した場合のレスポンス。
|
|
1913
|
+
*/
|
|
1914
|
+
200: UserinfoResponse;
|
|
1915
|
+
};
|
|
1916
|
+
export type PostUserinfoResponse = PostUserinfoResponses[keyof PostUserinfoResponses];
|
|
1917
|
+
export type RevokeTokenData = {
|
|
1918
|
+
body: RevokeRequest;
|
|
1919
|
+
path?: never;
|
|
1920
|
+
query?: never;
|
|
1921
|
+
url: '/oauth/revoke';
|
|
1922
|
+
};
|
|
1923
|
+
export type RevokeTokenErrors = {
|
|
1924
|
+
/**
|
|
1925
|
+
* トークン無効化リクエストが無効な場合のエラーレスポンス (RFC 7009 Section 2.2.1)。
|
|
1926
|
+
*
|
|
1927
|
+
* **返却されるエラーコード**:
|
|
1928
|
+
* - `invalid_request`: リクエストパラメータの不備(token パラメータが欠落など)
|
|
1929
|
+
* - `unsupported_token_type`: 指定されたトークンタイプの無効化がサポートされていない
|
|
1930
|
+
*/
|
|
1931
|
+
400: RevokeErrorResponse;
|
|
1932
|
+
/**
|
|
1933
|
+
* クライアント認証に失敗した場合のエラーレスポンス (RFC 7009 Section 2.1)。
|
|
1934
|
+
*
|
|
1935
|
+
* **返却されるエラーコード**:
|
|
1936
|
+
* - `invalid_client`: クライアント認証失敗
|
|
1937
|
+
*
|
|
1938
|
+
* HTTP Basic 認証を使用している場合、WWW-Authenticate ヘッダーが含まれます。
|
|
1939
|
+
*/
|
|
1940
|
+
401: RevokeErrorResponse;
|
|
1941
|
+
/**
|
|
1942
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
1943
|
+
*/
|
|
1944
|
+
429: ProblemDetails;
|
|
1945
|
+
/**
|
|
1946
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1947
|
+
*/
|
|
1948
|
+
500: ProblemDetails;
|
|
1949
|
+
/**
|
|
1950
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1951
|
+
*/
|
|
1952
|
+
503: ProblemDetails;
|
|
1953
|
+
};
|
|
1954
|
+
export type RevokeTokenError = RevokeTokenErrors[keyof RevokeTokenErrors];
|
|
1955
|
+
export type RevokeTokenResponses = {
|
|
1956
|
+
/**
|
|
1957
|
+
* トークンの無効化に成功した場合のレスポンス。
|
|
1958
|
+
*
|
|
1959
|
+
* RFC 7009 Section 2.2 に従い、無効なトークン(既に失効済み、存在しない等)を
|
|
1960
|
+
* 無効化しようとした場合も HTTP 200 が返されます。これは、クライアントに
|
|
1961
|
+
* トークンの存在有無を漏洩させないためのセキュリティ上の設計です。
|
|
1962
|
+
*/
|
|
1963
|
+
200: unknown;
|
|
1964
|
+
};
|
|
1965
|
+
export type IntrospectTokenData = {
|
|
1966
|
+
body: IntrospectRequest;
|
|
1967
|
+
path?: never;
|
|
1968
|
+
query?: never;
|
|
1969
|
+
url: '/oauth/introspect';
|
|
1970
|
+
};
|
|
1971
|
+
export type IntrospectTokenErrors = {
|
|
1972
|
+
/**
|
|
1973
|
+
* トークンイントロスペクションリクエストが無効な場合のエラーレスポンス (RFC 7662 Section 2.3)。
|
|
1974
|
+
*
|
|
1975
|
+
* **返却されるエラーコード**:
|
|
1976
|
+
* - `invalid_request`: リクエストパラメータの不備(token パラメータが欠落など)
|
|
1977
|
+
*/
|
|
1978
|
+
400: IntrospectErrorResponse;
|
|
1979
|
+
/**
|
|
1980
|
+
* クライアント認証に失敗した場合のエラーレスポンス (RFC 7662 Section 2.1)。
|
|
1981
|
+
*
|
|
1982
|
+
* **返却されるエラーコード**:
|
|
1983
|
+
* - `invalid_client`: クライアント認証失敗
|
|
1984
|
+
*
|
|
1985
|
+
* HTTP Basic 認証を使用している場合、WWW-Authenticate ヘッダーが含まれます。
|
|
1986
|
+
*
|
|
1987
|
+
* **注意**: トークンイントロスペクションエンドポイントは、トークンスキャン攻撃を防ぐため、
|
|
1988
|
+
* 認証なしでのアクセスを許可しません。リソースサーバーは必ず認証情報を提供する必要があります。
|
|
1989
|
+
*/
|
|
1990
|
+
401: IntrospectErrorResponse;
|
|
1991
|
+
/**
|
|
1992
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
1993
|
+
*/
|
|
1994
|
+
429: ProblemDetails;
|
|
1995
|
+
/**
|
|
1996
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
1997
|
+
*/
|
|
1998
|
+
500: ProblemDetails;
|
|
1999
|
+
/**
|
|
2000
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2001
|
+
*/
|
|
2002
|
+
503: ProblemDetails;
|
|
2003
|
+
};
|
|
2004
|
+
export type IntrospectTokenError = IntrospectTokenErrors[keyof IntrospectTokenErrors];
|
|
2005
|
+
export type IntrospectTokenResponses = {
|
|
2006
|
+
/**
|
|
2007
|
+
* トークンイントロスペクションの結果。
|
|
2008
|
+
*
|
|
2009
|
+
* RFC 7662 Section 2.2 に従い、トークンが無効(期限切れ、失効済み、存在しない等)な場合でも
|
|
2010
|
+
* HTTP 200 が返され、`active: false` がレスポンスに含まれます。
|
|
2011
|
+
* これは、トークンの存在有無を漏洩させないためのセキュリティ上の設計です。
|
|
2012
|
+
*/
|
|
2013
|
+
200: IntrospectResponse;
|
|
2014
|
+
};
|
|
2015
|
+
export type IntrospectTokenResponse = IntrospectTokenResponses[keyof IntrospectTokenResponses];
|
|
2016
|
+
export type EndSessionData = {
|
|
2017
|
+
body?: never;
|
|
2018
|
+
path?: never;
|
|
2019
|
+
query?: {
|
|
2020
|
+
/**
|
|
2021
|
+
* ログアウト対象のユーザーを特定するための ID トークン。
|
|
2022
|
+
*
|
|
2023
|
+
* OP (OpenID Provider) は、このトークンを使用してログアウト対象の
|
|
2024
|
+
* エンドユーザーのセッションを特定します。トークンは暗号化されていても構いません。
|
|
2025
|
+
*
|
|
2026
|
+
* OP は必ずしもトークンの署名を検証する必要はありませんが、
|
|
2027
|
+
* `aud` クレームに自身が含まれていることを確認します。
|
|
2028
|
+
*/
|
|
2029
|
+
id_token_hint?: string;
|
|
2030
|
+
/**
|
|
2031
|
+
* ログアウト対象のエンドユーザーに関するヒント。
|
|
2032
|
+
*
|
|
2033
|
+
* OP がエンドユーザーを特定するために使用できる追加情報です。
|
|
2034
|
+
* `id_token_hint` が提供されていない場合に、ユーザーを特定するための
|
|
2035
|
+
* 補助的な手段として使用されることがあります。
|
|
2036
|
+
*/
|
|
2037
|
+
logout_hint?: string;
|
|
2038
|
+
/**
|
|
2039
|
+
* ログアウト完了後にユーザーをリダイレクトする URI。
|
|
2040
|
+
*
|
|
2041
|
+
* この URI は、事前にクライアント登録時に `post_logout_redirect_uris` として
|
|
2042
|
+
* 登録されている必要があります。登録されていない URI が指定された場合、
|
|
2043
|
+
* リダイレクトは行われません。
|
|
2044
|
+
*
|
|
2045
|
+
* `id_token_hint` が省略され、`client_id` が指定されている場合、
|
|
2046
|
+
* その `client_id` に登録されている URI と照合されます。
|
|
2047
|
+
*
|
|
2048
|
+
* `id_token_hint` と `client_id` の両方が省略された場合、
|
|
2049
|
+
* リダイレクトは行われず、ログアウト完了画面が表示されます。
|
|
2050
|
+
*/
|
|
2051
|
+
post_logout_redirect_uri?: string;
|
|
2052
|
+
/**
|
|
2053
|
+
* RP (Relying Party) のクライアント識別子。
|
|
2054
|
+
*
|
|
2055
|
+
* `id_token_hint` が提供されない場合に、クライアントを特定するために使用されます。
|
|
2056
|
+
* `id_token_hint` が提供される場合、このパラメータは無視される場合があります。
|
|
2057
|
+
*/
|
|
2058
|
+
client_id?: ClientId;
|
|
2059
|
+
/**
|
|
2060
|
+
* RP がセッション状態を維持するために生成する推測困難な任意の文字列(OP はこの値を解釈せずそのまま返却します)。
|
|
2061
|
+
*
|
|
2062
|
+
* `post_logout_redirect_uri` へのリダイレクト時にクエリパラメータとして
|
|
2063
|
+
* そのまま返却されます。CSRF 攻撃を防ぐために使用できます。
|
|
2064
|
+
*/
|
|
2065
|
+
state?: string;
|
|
2066
|
+
/**
|
|
2067
|
+
* エンドユーザーの優先言語およびスクリプトを表す BCP47 言語タグのスペース区切りリスト。
|
|
2068
|
+
*
|
|
2069
|
+
* OP はこの値を使用して、ログアウト確認画面やエラーメッセージの表示言語を
|
|
2070
|
+
* 決定することができます。優先度の高い順に並べます。
|
|
2071
|
+
*/
|
|
2072
|
+
ui_locales?: string;
|
|
2073
|
+
};
|
|
2074
|
+
url: '/oauth/logout';
|
|
2075
|
+
};
|
|
2076
|
+
export type EndSessionErrors = {
|
|
2077
|
+
/**
|
|
2078
|
+
* エラー情報を含むHTMLページ
|
|
2079
|
+
*/
|
|
2080
|
+
400: string;
|
|
2081
|
+
/**
|
|
2082
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2083
|
+
*/
|
|
2084
|
+
500: ProblemDetails;
|
|
2085
|
+
/**
|
|
2086
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2087
|
+
*/
|
|
2088
|
+
503: ProblemDetails;
|
|
2089
|
+
};
|
|
2090
|
+
export type EndSessionError = EndSessionErrors[keyof EndSessionErrors];
|
|
2091
|
+
export type EndSessionResponses = {
|
|
2092
|
+
/**
|
|
2093
|
+
* ログアウト完了画面の HTML
|
|
2094
|
+
*/
|
|
2095
|
+
200: string;
|
|
2096
|
+
};
|
|
2097
|
+
export type EndSessionResponse = EndSessionResponses[keyof EndSessionResponses];
|
|
2098
|
+
export type EndSessionPostData = {
|
|
2099
|
+
body?: EndSessionRequest;
|
|
2100
|
+
path?: never;
|
|
2101
|
+
query?: never;
|
|
2102
|
+
url: '/oauth/logout';
|
|
2103
|
+
};
|
|
2104
|
+
export type EndSessionPostErrors = {
|
|
2105
|
+
/**
|
|
2106
|
+
* エラー情報を含むHTMLページ
|
|
2107
|
+
*/
|
|
2108
|
+
400: string;
|
|
2109
|
+
/**
|
|
2110
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2111
|
+
*/
|
|
2112
|
+
500: ProblemDetails;
|
|
2113
|
+
/**
|
|
2114
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2115
|
+
*/
|
|
2116
|
+
503: ProblemDetails;
|
|
2117
|
+
};
|
|
2118
|
+
export type EndSessionPostError = EndSessionPostErrors[keyof EndSessionPostErrors];
|
|
2119
|
+
export type EndSessionPostResponses = {
|
|
2120
|
+
/**
|
|
2121
|
+
* ログアウト完了画面の HTML
|
|
2122
|
+
*/
|
|
2123
|
+
200: string;
|
|
2124
|
+
};
|
|
2125
|
+
export type EndSessionPostResponse = EndSessionPostResponses[keyof EndSessionPostResponses];
|
|
2126
|
+
export type ListClientsData = {
|
|
2127
|
+
body?: never;
|
|
2128
|
+
path?: never;
|
|
2129
|
+
query?: {
|
|
2130
|
+
/**
|
|
2131
|
+
* 取得するページ番号(1始まり)。
|
|
2132
|
+
*/
|
|
2133
|
+
page?: number;
|
|
2134
|
+
/**
|
|
2135
|
+
* 1ページあたりの取得件数。
|
|
2136
|
+
*/
|
|
2137
|
+
per_page?: number;
|
|
2138
|
+
};
|
|
2139
|
+
url: '/admin/clients';
|
|
2140
|
+
};
|
|
2141
|
+
export type ListClientsErrors = {
|
|
2142
|
+
/**
|
|
2143
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2144
|
+
*/
|
|
2145
|
+
401: ProblemDetails;
|
|
2146
|
+
/**
|
|
2147
|
+
* 権限が不足している場合のエラーレスポンス。
|
|
2148
|
+
*/
|
|
2149
|
+
403: ProblemDetails;
|
|
2150
|
+
/**
|
|
2151
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
2152
|
+
*/
|
|
2153
|
+
429: ProblemDetails;
|
|
2154
|
+
/**
|
|
2155
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2156
|
+
*/
|
|
2157
|
+
500: ProblemDetails;
|
|
2158
|
+
};
|
|
2159
|
+
export type ListClientsError = ListClientsErrors[keyof ListClientsErrors];
|
|
2160
|
+
export type ListClientsResponses = {
|
|
2161
|
+
/**
|
|
2162
|
+
* クライアント一覧の取得に成功した場合のレスポンス。
|
|
2163
|
+
*/
|
|
2164
|
+
200: AdminClientListResponse;
|
|
2165
|
+
};
|
|
2166
|
+
export type ListClientsResponse = ListClientsResponses[keyof ListClientsResponses];
|
|
2167
|
+
export type CreateClientData = {
|
|
2168
|
+
body: AdminClientCreateRequest;
|
|
2169
|
+
path?: never;
|
|
2170
|
+
query?: never;
|
|
2171
|
+
url: '/admin/clients';
|
|
2172
|
+
};
|
|
2173
|
+
export type CreateClientErrors = {
|
|
2174
|
+
/**
|
|
2175
|
+
* リクエストが不正な場合のエラーレスポンス。
|
|
2176
|
+
*/
|
|
2177
|
+
400: ProblemDetails;
|
|
2178
|
+
/**
|
|
2179
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2180
|
+
*/
|
|
2181
|
+
401: ProblemDetails;
|
|
2182
|
+
/**
|
|
2183
|
+
* 権限が不足している場合のエラーレスポンス。
|
|
2184
|
+
*/
|
|
2185
|
+
403: ProblemDetails;
|
|
2186
|
+
/**
|
|
2187
|
+
* バリデーションエラーが発生した場合のエラーレスポンス。
|
|
2188
|
+
*/
|
|
2189
|
+
422: ProblemDetails;
|
|
2190
|
+
/**
|
|
2191
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
2192
|
+
*/
|
|
2193
|
+
429: ProblemDetails;
|
|
2194
|
+
/**
|
|
2195
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2196
|
+
*/
|
|
2197
|
+
500: ProblemDetails;
|
|
2198
|
+
};
|
|
2199
|
+
export type CreateClientError = CreateClientErrors[keyof CreateClientErrors];
|
|
2200
|
+
export type CreateClientResponses = {
|
|
2201
|
+
/**
|
|
2202
|
+
* クライアントの登録に成功した場合のレスポンス。
|
|
2203
|
+
*/
|
|
2204
|
+
201: AdminClientCreatedResponse;
|
|
2205
|
+
};
|
|
2206
|
+
export type CreateClientResponse = CreateClientResponses[keyof CreateClientResponses];
|
|
2207
|
+
export type DeleteClientData = {
|
|
2208
|
+
body?: never;
|
|
2209
|
+
path: {
|
|
2210
|
+
/**
|
|
2211
|
+
* クライアント識別子。
|
|
2212
|
+
*/
|
|
2213
|
+
client_id: string;
|
|
2214
|
+
};
|
|
2215
|
+
query?: never;
|
|
2216
|
+
url: '/admin/clients/{client_id}';
|
|
2217
|
+
};
|
|
2218
|
+
export type DeleteClientErrors = {
|
|
2219
|
+
/**
|
|
2220
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2221
|
+
*/
|
|
2222
|
+
401: ProblemDetails;
|
|
2223
|
+
/**
|
|
2224
|
+
* 権限が不足している場合のエラーレスポンス。
|
|
2225
|
+
*/
|
|
2226
|
+
403: ProblemDetails;
|
|
2227
|
+
/**
|
|
2228
|
+
* 指定されたクライアントが存在しない場合のエラーレスポンス。
|
|
2229
|
+
*/
|
|
2230
|
+
404: ProblemDetails;
|
|
2231
|
+
/**
|
|
2232
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
2233
|
+
*/
|
|
2234
|
+
429: ProblemDetails;
|
|
2235
|
+
/**
|
|
2236
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2237
|
+
*/
|
|
2238
|
+
500: ProblemDetails;
|
|
2239
|
+
};
|
|
2240
|
+
export type DeleteClientError = DeleteClientErrors[keyof DeleteClientErrors];
|
|
2241
|
+
export type DeleteClientResponses = {
|
|
2242
|
+
/**
|
|
2243
|
+
* クライアントの削除に成功した場合のレスポンス(ボディなし)。
|
|
2244
|
+
*/
|
|
2245
|
+
204: void;
|
|
2246
|
+
};
|
|
2247
|
+
export type DeleteClientResponse = DeleteClientResponses[keyof DeleteClientResponses];
|
|
2248
|
+
export type GetClientData = {
|
|
2249
|
+
body?: never;
|
|
2250
|
+
path: {
|
|
2251
|
+
/**
|
|
2252
|
+
* クライアント識別子。
|
|
2253
|
+
*/
|
|
2254
|
+
client_id: string;
|
|
2255
|
+
};
|
|
2256
|
+
query?: never;
|
|
2257
|
+
url: '/admin/clients/{client_id}';
|
|
2258
|
+
};
|
|
2259
|
+
export type GetClientErrors = {
|
|
2260
|
+
/**
|
|
2261
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2262
|
+
*/
|
|
2263
|
+
401: ProblemDetails;
|
|
2264
|
+
/**
|
|
2265
|
+
* 権限が不足している場合のエラーレスポンス。
|
|
2266
|
+
*/
|
|
2267
|
+
403: ProblemDetails;
|
|
2268
|
+
/**
|
|
2269
|
+
* 指定されたクライアントが存在しない場合のエラーレスポンス。
|
|
2270
|
+
*/
|
|
2271
|
+
404: ProblemDetails;
|
|
2272
|
+
/**
|
|
2273
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
2274
|
+
*/
|
|
2275
|
+
429: ProblemDetails;
|
|
2276
|
+
/**
|
|
2277
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2278
|
+
*/
|
|
2279
|
+
500: ProblemDetails;
|
|
2280
|
+
};
|
|
2281
|
+
export type GetClientError = GetClientErrors[keyof GetClientErrors];
|
|
2282
|
+
export type GetClientResponses = {
|
|
2283
|
+
/**
|
|
2284
|
+
* クライアント情報の取得に成功した場合のレスポンス。
|
|
2285
|
+
*/
|
|
2286
|
+
200: Client;
|
|
2287
|
+
};
|
|
2288
|
+
export type GetClientResponse = GetClientResponses[keyof GetClientResponses];
|
|
2289
|
+
export type UpdateClientData = {
|
|
2290
|
+
body: AdminClientUpdateRequest;
|
|
2291
|
+
path: {
|
|
2292
|
+
/**
|
|
2293
|
+
* クライアント識別子。
|
|
2294
|
+
*/
|
|
2295
|
+
client_id: string;
|
|
2296
|
+
};
|
|
2297
|
+
query?: never;
|
|
2298
|
+
url: '/admin/clients/{client_id}';
|
|
2299
|
+
};
|
|
2300
|
+
export type UpdateClientErrors = {
|
|
2301
|
+
/**
|
|
2302
|
+
* リクエストが不正な場合のエラーレスポンス。
|
|
2303
|
+
*/
|
|
2304
|
+
400: ProblemDetails;
|
|
2305
|
+
/**
|
|
2306
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2307
|
+
*/
|
|
2308
|
+
401: ProblemDetails;
|
|
2309
|
+
/**
|
|
2310
|
+
* 権限が不足している場合のエラーレスポンス。
|
|
2311
|
+
*/
|
|
2312
|
+
403: ProblemDetails;
|
|
2313
|
+
/**
|
|
2314
|
+
* 指定されたクライアントが存在しない場合のエラーレスポンス。
|
|
2315
|
+
*/
|
|
2316
|
+
404: ProblemDetails;
|
|
2317
|
+
/**
|
|
2318
|
+
* バリデーションエラーが発生した場合のエラーレスポンス。
|
|
2319
|
+
*/
|
|
2320
|
+
422: ProblemDetails;
|
|
2321
|
+
/**
|
|
2322
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
2323
|
+
*/
|
|
2324
|
+
429: ProblemDetails;
|
|
2325
|
+
/**
|
|
2326
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2327
|
+
*/
|
|
2328
|
+
500: ProblemDetails;
|
|
2329
|
+
};
|
|
2330
|
+
export type UpdateClientError = UpdateClientErrors[keyof UpdateClientErrors];
|
|
2331
|
+
export type UpdateClientResponses = {
|
|
2332
|
+
/**
|
|
2333
|
+
* クライアントの更新に成功した場合のレスポンス。
|
|
2334
|
+
*/
|
|
2335
|
+
200: Client;
|
|
2336
|
+
};
|
|
2337
|
+
export type UpdateClientResponse = UpdateClientResponses[keyof UpdateClientResponses];
|
|
2338
|
+
export type ListOrganizationsData = {
|
|
2339
|
+
body?: never;
|
|
2340
|
+
path?: never;
|
|
2341
|
+
query?: {
|
|
2342
|
+
/**
|
|
2343
|
+
* 取得するページ番号(1始まり)。
|
|
2344
|
+
*/
|
|
2345
|
+
page?: number;
|
|
2346
|
+
/**
|
|
2347
|
+
* 1ページあたりの取得件数。
|
|
2348
|
+
*/
|
|
2349
|
+
per_page?: number;
|
|
2350
|
+
};
|
|
2351
|
+
url: '/admin/organizations';
|
|
2352
|
+
};
|
|
2353
|
+
export type ListOrganizationsErrors = {
|
|
2354
|
+
/**
|
|
2355
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2356
|
+
*/
|
|
2357
|
+
401: ProblemDetails;
|
|
2358
|
+
/**
|
|
2359
|
+
* 権限が不足している場合のエラーレスポンス。
|
|
2360
|
+
*/
|
|
2361
|
+
403: ProblemDetails;
|
|
2362
|
+
/**
|
|
2363
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
2364
|
+
*/
|
|
2365
|
+
429: ProblemDetails;
|
|
2366
|
+
/**
|
|
2367
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2368
|
+
*/
|
|
2369
|
+
500: ProblemDetails;
|
|
2370
|
+
};
|
|
2371
|
+
export type ListOrganizationsError = ListOrganizationsErrors[keyof ListOrganizationsErrors];
|
|
2372
|
+
export type ListOrganizationsResponses = {
|
|
2373
|
+
/**
|
|
2374
|
+
* 組織一覧の取得に成功した場合のレスポンス。
|
|
2375
|
+
*/
|
|
2376
|
+
200: AdminOrganizationListResponse;
|
|
2377
|
+
};
|
|
2378
|
+
export type ListOrganizationsResponse = ListOrganizationsResponses[keyof ListOrganizationsResponses];
|
|
2379
|
+
export type CreateOrganizationData = {
|
|
2380
|
+
body: AdminOrganizationCreateRequest;
|
|
2381
|
+
path?: never;
|
|
2382
|
+
query?: never;
|
|
2383
|
+
url: '/admin/organizations';
|
|
2384
|
+
};
|
|
2385
|
+
export type CreateOrganizationErrors = {
|
|
2386
|
+
/**
|
|
2387
|
+
* リクエストが不正な場合のエラーレスポンス。
|
|
2388
|
+
*/
|
|
2389
|
+
400: ProblemDetails;
|
|
2390
|
+
/**
|
|
2391
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2392
|
+
*/
|
|
2393
|
+
401: ProblemDetails;
|
|
2394
|
+
/**
|
|
2395
|
+
* 管理者権限がない場合のエラーレスポンス。
|
|
2396
|
+
*/
|
|
2397
|
+
403: ProblemDetails;
|
|
2398
|
+
/**
|
|
2399
|
+
* バリデーションエラーが発生した場合のエラーレスポンス。
|
|
2400
|
+
*/
|
|
2401
|
+
422: ProblemDetails;
|
|
2402
|
+
/**
|
|
2403
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
2404
|
+
*/
|
|
2405
|
+
429: ProblemDetails;
|
|
2406
|
+
/**
|
|
2407
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2408
|
+
*/
|
|
2409
|
+
500: ProblemDetails;
|
|
2410
|
+
};
|
|
2411
|
+
export type CreateOrganizationError = CreateOrganizationErrors[keyof CreateOrganizationErrors];
|
|
2412
|
+
export type CreateOrganizationResponses = {
|
|
2413
|
+
/**
|
|
2414
|
+
* 組織の登録に成功した場合のレスポンス。
|
|
2415
|
+
*/
|
|
2416
|
+
201: AdminOrganizationCreatedResponse;
|
|
2417
|
+
};
|
|
2418
|
+
export type CreateOrganizationResponse = CreateOrganizationResponses[keyof CreateOrganizationResponses];
|
|
2419
|
+
export type GetOrganizationData = {
|
|
2420
|
+
body?: never;
|
|
2421
|
+
path: {
|
|
2422
|
+
/**
|
|
2423
|
+
* 組織識別子(UUID形式)。
|
|
2424
|
+
*/
|
|
2425
|
+
organization_id: string;
|
|
2426
|
+
};
|
|
2427
|
+
query?: never;
|
|
2428
|
+
url: '/admin/organizations/{organization_id}';
|
|
2429
|
+
};
|
|
2430
|
+
export type GetOrganizationErrors = {
|
|
2431
|
+
/**
|
|
2432
|
+
* リクエストが不正な場合のエラーレスポンス。
|
|
2433
|
+
*/
|
|
2434
|
+
400: ProblemDetails;
|
|
2435
|
+
/**
|
|
2436
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2437
|
+
*/
|
|
2438
|
+
401: ProblemDetails;
|
|
2439
|
+
/**
|
|
2440
|
+
* 権限が不足している場合のエラーレスポンス。
|
|
2441
|
+
*/
|
|
2442
|
+
403: ProblemDetails;
|
|
2443
|
+
/**
|
|
2444
|
+
* 指定された組織が存在しない場合のエラーレスポンス。
|
|
2445
|
+
*/
|
|
2446
|
+
404: ProblemDetails;
|
|
2447
|
+
/**
|
|
2448
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
2449
|
+
*/
|
|
2450
|
+
429: ProblemDetails;
|
|
2451
|
+
/**
|
|
2452
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2453
|
+
*/
|
|
2454
|
+
500: ProblemDetails;
|
|
2455
|
+
};
|
|
2456
|
+
export type GetOrganizationError = GetOrganizationErrors[keyof GetOrganizationErrors];
|
|
2457
|
+
export type GetOrganizationResponses = {
|
|
2458
|
+
/**
|
|
2459
|
+
* 組織情報の取得に成功した場合のレスポンス。
|
|
2460
|
+
*/
|
|
2461
|
+
200: Organization;
|
|
2462
|
+
};
|
|
2463
|
+
export type GetOrganizationResponse = GetOrganizationResponses[keyof GetOrganizationResponses];
|
|
2464
|
+
export type UpdateOrganizationData = {
|
|
2465
|
+
body: AdminOrganizationUpdateRequest;
|
|
2466
|
+
path: {
|
|
2467
|
+
/**
|
|
2468
|
+
* 組織識別子(UUID形式)。
|
|
2469
|
+
*/
|
|
2470
|
+
organization_id: string;
|
|
2471
|
+
};
|
|
2472
|
+
query?: never;
|
|
2473
|
+
url: '/admin/organizations/{organization_id}';
|
|
2474
|
+
};
|
|
2475
|
+
export type UpdateOrganizationErrors = {
|
|
2476
|
+
/**
|
|
2477
|
+
* リクエストが不正な場合のエラーレスポンス。
|
|
2478
|
+
*/
|
|
2479
|
+
400: ProblemDetails;
|
|
2480
|
+
/**
|
|
2481
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2482
|
+
*/
|
|
2483
|
+
401: ProblemDetails;
|
|
2484
|
+
/**
|
|
2485
|
+
* 権限が不足している場合のエラーレスポンス。
|
|
2486
|
+
*/
|
|
2487
|
+
403: ProblemDetails;
|
|
2488
|
+
/**
|
|
2489
|
+
* 指定された組織が存在しない場合のエラーレスポンス。
|
|
2490
|
+
*/
|
|
2491
|
+
404: ProblemDetails;
|
|
2492
|
+
/**
|
|
2493
|
+
* バリデーションエラーが発生した場合のエラーレスポンス。
|
|
2494
|
+
* 一意制約違反(name が既に使用されている場合)もこのエラーとして返されます。
|
|
2495
|
+
*/
|
|
2496
|
+
422: ProblemDetails;
|
|
2497
|
+
/**
|
|
2498
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
2499
|
+
*/
|
|
2500
|
+
429: ProblemDetails;
|
|
2501
|
+
/**
|
|
2502
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2503
|
+
*/
|
|
2504
|
+
500: ProblemDetails;
|
|
2505
|
+
};
|
|
2506
|
+
export type UpdateOrganizationError = UpdateOrganizationErrors[keyof UpdateOrganizationErrors];
|
|
2507
|
+
export type UpdateOrganizationResponses = {
|
|
2508
|
+
/**
|
|
2509
|
+
* 組織の更新に成功した場合のレスポンス。
|
|
2510
|
+
*/
|
|
2511
|
+
200: Organization;
|
|
2512
|
+
};
|
|
2513
|
+
export type UpdateOrganizationResponse = UpdateOrganizationResponses[keyof UpdateOrganizationResponses];
|
|
2514
|
+
export type ListOrganizationMembersData = {
|
|
2515
|
+
body?: never;
|
|
2516
|
+
path: {
|
|
2517
|
+
/**
|
|
2518
|
+
* 組織識別子(UUID形式)。
|
|
2519
|
+
*/
|
|
2520
|
+
organization_id: string;
|
|
2521
|
+
};
|
|
2522
|
+
query?: {
|
|
2523
|
+
/**
|
|
2524
|
+
* 取得するページ番号(1始まり)。
|
|
2525
|
+
*/
|
|
2526
|
+
page?: number;
|
|
2527
|
+
/**
|
|
2528
|
+
* 1ページあたりの取得件数。
|
|
2529
|
+
*/
|
|
2530
|
+
per_page?: number;
|
|
2531
|
+
/**
|
|
2532
|
+
* ソート基準フィールド。
|
|
2533
|
+
* - `name`: ユーザー表示名
|
|
2534
|
+
* - `email`: ユーザーメールアドレス
|
|
2535
|
+
* - `role`: 組織内ロール
|
|
2536
|
+
* - `joined_at`: 組織への参加日時
|
|
2537
|
+
* - `last_access`: 組織への最終アクセス日時
|
|
2538
|
+
*/
|
|
2539
|
+
sort_by?: 'name' | 'email' | 'role' | 'joined_at' | 'last_access';
|
|
2540
|
+
/**
|
|
2541
|
+
* ソート順。
|
|
2542
|
+
* - `asc`: 昇順
|
|
2543
|
+
* - `desc`: 降順
|
|
2544
|
+
*/
|
|
2545
|
+
sort_order?: 'asc' | 'desc';
|
|
2546
|
+
/**
|
|
2547
|
+
* ロールでメンバーを絞り込みます。カンマ区切りで複数値を指定可能(例: `?role=owner,admin`)。
|
|
2548
|
+
* 未指定時は全ロールを返却します。
|
|
2549
|
+
*/
|
|
2550
|
+
role?: Array<OrganizationRole>;
|
|
2551
|
+
/**
|
|
2552
|
+
* メンバーのメールドメインが組織の verified ドメインと一致するか (`corporate`)、しないか (`personal`) で絞り込みます。
|
|
2553
|
+
* カンマ区切りで複数値を指定可能(例: `?domain_type=corporate,personal`)。未指定時は全件返却します。
|
|
2554
|
+
*/
|
|
2555
|
+
domain_type?: Array<OrganizationMemberDomainType>;
|
|
2556
|
+
/**
|
|
2557
|
+
* メンバーの表示名またはメールアドレスに対する部分一致検索文字列。
|
|
2558
|
+
* 1〜255 文字。空文字列はバリデーションエラー(400)となります。
|
|
2559
|
+
*/
|
|
2560
|
+
search?: string;
|
|
2561
|
+
/**
|
|
2562
|
+
* `true` の場合、レスポンスのトップレベルに `role_counts` と `domain_counts`(フィルタ適用前の総件数集計)を含めて返却します。
|
|
2563
|
+
* 集計コストを避けるためデフォルトは `false`。
|
|
2564
|
+
*/
|
|
2565
|
+
include_counts?: boolean;
|
|
2566
|
+
};
|
|
2567
|
+
url: '/admin/organizations/{organization_id}/members';
|
|
2568
|
+
};
|
|
2569
|
+
export type ListOrganizationMembersErrors = {
|
|
2570
|
+
/**
|
|
2571
|
+
* クエリパラメータが不正な場合のエラーレスポンス。
|
|
2572
|
+
*/
|
|
2573
|
+
400: ProblemDetails;
|
|
2574
|
+
/**
|
|
2575
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2576
|
+
*/
|
|
2577
|
+
401: ProblemDetails;
|
|
2578
|
+
/**
|
|
2579
|
+
* 権限が不足している場合のエラーレスポンス。
|
|
2580
|
+
*/
|
|
2581
|
+
403: ProblemDetails;
|
|
2582
|
+
/**
|
|
2583
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
2584
|
+
*/
|
|
2585
|
+
429: ProblemDetails;
|
|
2586
|
+
/**
|
|
2587
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2588
|
+
*/
|
|
2589
|
+
500: ProblemDetails;
|
|
2590
|
+
};
|
|
2591
|
+
export type ListOrganizationMembersError = ListOrganizationMembersErrors[keyof ListOrganizationMembersErrors];
|
|
2592
|
+
export type ListOrganizationMembersResponses = {
|
|
2593
|
+
/**
|
|
2594
|
+
* 組織メンバー一覧の取得に成功した場合のレスポンス。
|
|
2595
|
+
*/
|
|
2596
|
+
200: AdminOrganizationMemberListResponse;
|
|
2597
|
+
};
|
|
2598
|
+
export type ListOrganizationMembersResponse = ListOrganizationMembersResponses[keyof ListOrganizationMembersResponses];
|
|
2599
|
+
export type RemoveOrganizationMemberData = {
|
|
2600
|
+
body?: never;
|
|
2601
|
+
path: {
|
|
2602
|
+
/**
|
|
2603
|
+
* 組織識別子(UUID形式)。
|
|
2604
|
+
*/
|
|
2605
|
+
organization_id: string;
|
|
2606
|
+
/**
|
|
2607
|
+
* メンバー識別子(UUID形式)。
|
|
2608
|
+
*/
|
|
2609
|
+
member_id: string;
|
|
2610
|
+
};
|
|
2611
|
+
query?: never;
|
|
2612
|
+
url: '/admin/organizations/{organization_id}/members/{member_id}';
|
|
2613
|
+
};
|
|
2614
|
+
export type RemoveOrganizationMemberErrors = {
|
|
2615
|
+
/**
|
|
2616
|
+
* リクエストが不正な場合のエラーレスポンス。
|
|
2617
|
+
*/
|
|
2618
|
+
400: ProblemDetails;
|
|
2619
|
+
/**
|
|
2620
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2621
|
+
*/
|
|
2622
|
+
401: ProblemDetails;
|
|
2623
|
+
/**
|
|
2624
|
+
* 権限が不足している場合のエラーレスポンス。
|
|
2625
|
+
*/
|
|
2626
|
+
403: ProblemDetails;
|
|
2627
|
+
/**
|
|
2628
|
+
* 指定された組織またはメンバーが存在しない場合のエラーレスポンス。
|
|
2629
|
+
*/
|
|
2630
|
+
404: ProblemDetails;
|
|
2631
|
+
/**
|
|
2632
|
+
* メンバーを削除できない状態の場合のエラーレスポンス。
|
|
2633
|
+
* - 組織内で唯一の Owner であるメンバーは削除できません
|
|
2634
|
+
*/
|
|
2635
|
+
409: ProblemDetails;
|
|
2636
|
+
/**
|
|
2637
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
2638
|
+
*/
|
|
2639
|
+
429: ProblemDetails;
|
|
2640
|
+
/**
|
|
2641
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2642
|
+
*/
|
|
2643
|
+
500: ProblemDetails;
|
|
2644
|
+
};
|
|
2645
|
+
export type RemoveOrganizationMemberError = RemoveOrganizationMemberErrors[keyof RemoveOrganizationMemberErrors];
|
|
2646
|
+
export type RemoveOrganizationMemberResponses = {
|
|
2647
|
+
/**
|
|
2648
|
+
* メンバーの削除に成功した場合のレスポンス(ボディなし)。
|
|
2649
|
+
*/
|
|
2650
|
+
204: void;
|
|
2651
|
+
};
|
|
2652
|
+
export type RemoveOrganizationMemberResponse = RemoveOrganizationMemberResponses[keyof RemoveOrganizationMemberResponses];
|
|
2653
|
+
export type UpdateOrganizationMemberRoleData = {
|
|
2654
|
+
body: AdminOrganizationMemberUpdateRequest;
|
|
2655
|
+
path: {
|
|
2656
|
+
/**
|
|
2657
|
+
* 組織識別子(UUID形式)。
|
|
2658
|
+
*/
|
|
2659
|
+
organization_id: string;
|
|
2660
|
+
/**
|
|
2661
|
+
* メンバー識別子(UUID形式)。
|
|
2662
|
+
*/
|
|
2663
|
+
member_id: string;
|
|
2664
|
+
};
|
|
2665
|
+
query?: never;
|
|
2666
|
+
url: '/admin/organizations/{organization_id}/members/{member_id}';
|
|
2667
|
+
};
|
|
2668
|
+
export type UpdateOrganizationMemberRoleErrors = {
|
|
2669
|
+
/**
|
|
2670
|
+
* リクエストが不正な場合のエラーレスポンス。
|
|
2671
|
+
*/
|
|
2672
|
+
400: ProblemDetails;
|
|
2673
|
+
/**
|
|
2674
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2675
|
+
*/
|
|
2676
|
+
401: ProblemDetails;
|
|
2677
|
+
/**
|
|
2678
|
+
* 権限が不足している場合のエラーレスポンス。
|
|
2679
|
+
*/
|
|
2680
|
+
403: ProblemDetails;
|
|
2681
|
+
/**
|
|
2682
|
+
* 指定された組織またはメンバーが存在しない場合のエラーレスポンス。
|
|
2683
|
+
*/
|
|
2684
|
+
404: ProblemDetails;
|
|
2685
|
+
/**
|
|
2686
|
+
* 競合が発生した場合のエラーレスポンス。
|
|
2687
|
+
* - 組織内の最後の Owner のロールを変更しようとした場合
|
|
2688
|
+
*/
|
|
2689
|
+
409: ProblemDetails;
|
|
2690
|
+
/**
|
|
2691
|
+
* バリデーションエラーが発生した場合のエラーレスポンス。
|
|
2692
|
+
*/
|
|
2693
|
+
422: ProblemDetails;
|
|
2694
|
+
/**
|
|
2695
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
2696
|
+
*/
|
|
2697
|
+
429: ProblemDetails;
|
|
2698
|
+
/**
|
|
2699
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2700
|
+
*/
|
|
2701
|
+
500: ProblemDetails;
|
|
2702
|
+
};
|
|
2703
|
+
export type UpdateOrganizationMemberRoleError = UpdateOrganizationMemberRoleErrors[keyof UpdateOrganizationMemberRoleErrors];
|
|
2704
|
+
export type UpdateOrganizationMemberRoleResponses = {
|
|
2705
|
+
/**
|
|
2706
|
+
* メンバーロールの変更に成功した場合のレスポンス。
|
|
2707
|
+
*/
|
|
2708
|
+
200: OrganizationMember;
|
|
2709
|
+
};
|
|
2710
|
+
export type UpdateOrganizationMemberRoleResponse = UpdateOrganizationMemberRoleResponses[keyof UpdateOrganizationMemberRoleResponses];
|
|
2711
|
+
export type ListOrganizationInvitationsData = {
|
|
2712
|
+
body?: never;
|
|
2713
|
+
path: {
|
|
2714
|
+
/**
|
|
2715
|
+
* 組織識別子(UUID形式)。
|
|
2716
|
+
*/
|
|
2717
|
+
organization_id: string;
|
|
2718
|
+
};
|
|
2719
|
+
query?: {
|
|
2720
|
+
/**
|
|
2721
|
+
* 取得するページ番号(1始まり)。
|
|
2722
|
+
*/
|
|
2723
|
+
page?: number;
|
|
2724
|
+
/**
|
|
2725
|
+
* 1ページあたりの取得件数。
|
|
2726
|
+
*/
|
|
2727
|
+
per_page?: number;
|
|
2728
|
+
};
|
|
2729
|
+
url: '/admin/organizations/{organization_id}/invitations';
|
|
2730
|
+
};
|
|
2731
|
+
export type ListOrganizationInvitationsErrors = {
|
|
2732
|
+
/**
|
|
2733
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2734
|
+
*/
|
|
2735
|
+
401: ProblemDetails;
|
|
2736
|
+
/**
|
|
2737
|
+
* 権限が不足している場合のエラーレスポンス。
|
|
2738
|
+
*/
|
|
2739
|
+
403: ProblemDetails;
|
|
2740
|
+
/**
|
|
2741
|
+
* 指定された組織が存在しない場合のエラーレスポンス。
|
|
2742
|
+
*/
|
|
2743
|
+
404: ProblemDetails;
|
|
2744
|
+
/**
|
|
2745
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
2746
|
+
*/
|
|
2747
|
+
429: ProblemDetails;
|
|
2748
|
+
/**
|
|
2749
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2750
|
+
*/
|
|
2751
|
+
500: ProblemDetails;
|
|
2752
|
+
};
|
|
2753
|
+
export type ListOrganizationInvitationsError = ListOrganizationInvitationsErrors[keyof ListOrganizationInvitationsErrors];
|
|
2754
|
+
export type ListOrganizationInvitationsResponses = {
|
|
2755
|
+
/**
|
|
2756
|
+
* 招待一覧の取得に成功した場合のレスポンス。
|
|
2757
|
+
*/
|
|
2758
|
+
200: AdminOrganizationInvitationListResponse;
|
|
2759
|
+
};
|
|
2760
|
+
export type ListOrganizationInvitationsResponse = ListOrganizationInvitationsResponses[keyof ListOrganizationInvitationsResponses];
|
|
2761
|
+
export type CreateOrganizationInvitationData = {
|
|
2762
|
+
body: AdminOrganizationInvitationCreateRequest;
|
|
2763
|
+
path: {
|
|
2764
|
+
/**
|
|
2765
|
+
* 組織識別子(UUID形式)。
|
|
2766
|
+
*/
|
|
2767
|
+
organization_id: string;
|
|
2768
|
+
};
|
|
2769
|
+
query?: never;
|
|
2770
|
+
url: '/admin/organizations/{organization_id}/invitations';
|
|
2771
|
+
};
|
|
2772
|
+
export type CreateOrganizationInvitationErrors = {
|
|
2773
|
+
/**
|
|
2774
|
+
* リクエストが不正な場合のエラーレスポンス。
|
|
2775
|
+
*/
|
|
2776
|
+
400: ProblemDetails;
|
|
2777
|
+
/**
|
|
2778
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2779
|
+
*/
|
|
2780
|
+
401: ProblemDetails;
|
|
2781
|
+
/**
|
|
2782
|
+
* 権限が不足している場合のエラーレスポンス。
|
|
2783
|
+
*/
|
|
2784
|
+
403: ProblemDetails;
|
|
2785
|
+
/**
|
|
2786
|
+
* 指定された組織が存在しない場合のエラーレスポンス。
|
|
2787
|
+
*/
|
|
2788
|
+
404: ProblemDetails;
|
|
2789
|
+
/**
|
|
2790
|
+
* 競合が発生した場合のエラーレスポンス。
|
|
2791
|
+
* - 既に同じメールアドレスへの有効な招待が存在する場合
|
|
2792
|
+
* - 既に組織のメンバーである場合
|
|
2793
|
+
*/
|
|
2794
|
+
409: ProblemDetails;
|
|
2795
|
+
/**
|
|
2796
|
+
* バリデーションエラーが発生した場合のエラーレスポンス。
|
|
2797
|
+
*/
|
|
2798
|
+
422: ProblemDetails;
|
|
2799
|
+
/**
|
|
2800
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
2801
|
+
*/
|
|
2802
|
+
429: ProblemDetails;
|
|
2803
|
+
/**
|
|
2804
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2805
|
+
*/
|
|
2806
|
+
500: ProblemDetails;
|
|
2807
|
+
};
|
|
2808
|
+
export type CreateOrganizationInvitationError = CreateOrganizationInvitationErrors[keyof CreateOrganizationInvitationErrors];
|
|
2809
|
+
export type CreateOrganizationInvitationResponses = {
|
|
2810
|
+
/**
|
|
2811
|
+
* 招待の作成に成功した場合のレスポンス。
|
|
2812
|
+
*/
|
|
2813
|
+
201: AdminOrganizationInvitationCreatedResponse;
|
|
2814
|
+
};
|
|
2815
|
+
export type CreateOrganizationInvitationResponse = CreateOrganizationInvitationResponses[keyof CreateOrganizationInvitationResponses];
|
|
2816
|
+
export type RevokeOrganizationInvitationData = {
|
|
2817
|
+
body?: never;
|
|
2818
|
+
path: {
|
|
2819
|
+
/**
|
|
2820
|
+
* 組織識別子(UUID形式)。
|
|
2821
|
+
*/
|
|
2822
|
+
organization_id: string;
|
|
2823
|
+
/**
|
|
2824
|
+
* 招待識別子(UUID形式)。
|
|
2825
|
+
*/
|
|
2826
|
+
invitation_id: string;
|
|
2827
|
+
};
|
|
2828
|
+
query?: never;
|
|
2829
|
+
url: '/admin/organizations/{organization_id}/invitations/{invitation_id}';
|
|
2830
|
+
};
|
|
2831
|
+
export type RevokeOrganizationInvitationErrors = {
|
|
2832
|
+
/**
|
|
2833
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2834
|
+
*/
|
|
2835
|
+
401: ProblemDetails;
|
|
2836
|
+
/**
|
|
2837
|
+
* 権限が不足している場合のエラーレスポンス。
|
|
2838
|
+
*/
|
|
2839
|
+
403: ProblemDetails;
|
|
2840
|
+
/**
|
|
2841
|
+
* 指定された組織または招待が存在しない場合のエラーレスポンス。
|
|
2842
|
+
*/
|
|
2843
|
+
404: ProblemDetails;
|
|
2844
|
+
/**
|
|
2845
|
+
* 招待を取り消せない状態の場合のエラーレスポンス。
|
|
2846
|
+
* - 既に承諾済みの招待
|
|
2847
|
+
* - 既に期限切れの招待
|
|
2848
|
+
* - 既に取消済みの招待
|
|
2849
|
+
*/
|
|
2850
|
+
409: ProblemDetails;
|
|
2851
|
+
/**
|
|
2852
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
2853
|
+
*/
|
|
2854
|
+
429: ProblemDetails;
|
|
2855
|
+
/**
|
|
2856
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2857
|
+
*/
|
|
2858
|
+
500: ProblemDetails;
|
|
2859
|
+
};
|
|
2860
|
+
export type RevokeOrganizationInvitationError = RevokeOrganizationInvitationErrors[keyof RevokeOrganizationInvitationErrors];
|
|
2861
|
+
export type RevokeOrganizationInvitationResponses = {
|
|
2862
|
+
/**
|
|
2863
|
+
* 招待の取消に成功した場合のレスポンス(ボディなし)。
|
|
2864
|
+
*/
|
|
2865
|
+
204: void;
|
|
2866
|
+
};
|
|
2867
|
+
export type RevokeOrganizationInvitationResponse = RevokeOrganizationInvitationResponses[keyof RevokeOrganizationInvitationResponses];
|
|
2868
|
+
export type CreateAdminPortalSessionData = {
|
|
2869
|
+
body: AdminPortalSessionCreateRequest;
|
|
2870
|
+
path: {
|
|
2871
|
+
/**
|
|
2872
|
+
* 組織識別子(UUID形式)。
|
|
2873
|
+
*/
|
|
2874
|
+
organization_id: string;
|
|
2875
|
+
};
|
|
2876
|
+
query?: never;
|
|
2877
|
+
url: '/admin/organizations/{organization_id}/admin-portal-sessions';
|
|
2878
|
+
};
|
|
2879
|
+
export type CreateAdminPortalSessionErrors = {
|
|
2880
|
+
/**
|
|
2881
|
+
* リクエストが不正な場合のエラーレスポンス。
|
|
2882
|
+
*/
|
|
2883
|
+
400: ProblemDetails;
|
|
2884
|
+
/**
|
|
2885
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2886
|
+
*/
|
|
2887
|
+
401: ProblemDetails;
|
|
2888
|
+
/**
|
|
2889
|
+
* 権限が不足している場合のエラーレスポンス。
|
|
2890
|
+
*/
|
|
2891
|
+
403: ProblemDetails;
|
|
2892
|
+
/**
|
|
2893
|
+
* 指定された組織が存在しない場合のエラーレスポンス。
|
|
2894
|
+
*/
|
|
2895
|
+
404: ProblemDetails;
|
|
2896
|
+
/**
|
|
2897
|
+
* バリデーションエラーが発生した場合のエラーレスポンス。
|
|
2898
|
+
*/
|
|
2899
|
+
422: ProblemDetails;
|
|
2900
|
+
/**
|
|
2901
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
2902
|
+
*/
|
|
2903
|
+
429: ProblemDetails;
|
|
2904
|
+
/**
|
|
2905
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2906
|
+
*/
|
|
2907
|
+
500: ProblemDetails;
|
|
2908
|
+
};
|
|
2909
|
+
export type CreateAdminPortalSessionError = CreateAdminPortalSessionErrors[keyof CreateAdminPortalSessionErrors];
|
|
2910
|
+
export type CreateAdminPortalSessionResponses = {
|
|
2911
|
+
/**
|
|
2912
|
+
* Admin Portal セッションの作成に成功した場合のレスポンス。
|
|
2913
|
+
*/
|
|
2914
|
+
201: AdminPortalSessionCreatedResponse;
|
|
2915
|
+
};
|
|
2916
|
+
export type CreateAdminPortalSessionResponse = CreateAdminPortalSessionResponses[keyof CreateAdminPortalSessionResponses];
|
|
2917
|
+
export type SendInvitationData = {
|
|
2918
|
+
body: OrganizationInvitationCreateRequest;
|
|
2919
|
+
path: {
|
|
2920
|
+
/**
|
|
2921
|
+
* 組織識別子(UUID形式)。
|
|
2922
|
+
*/
|
|
2923
|
+
organization_id: string;
|
|
2924
|
+
};
|
|
2925
|
+
query?: never;
|
|
2926
|
+
url: '/organizations/{organization_id}/invitations';
|
|
2927
|
+
};
|
|
2928
|
+
export type SendInvitationErrors = {
|
|
2929
|
+
/**
|
|
2930
|
+
* リクエストが不正な場合のエラーレスポンス。
|
|
2931
|
+
*/
|
|
2932
|
+
400: ProblemDetails;
|
|
2933
|
+
/**
|
|
2934
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
2935
|
+
*/
|
|
2936
|
+
401: ProblemDetails;
|
|
2937
|
+
/**
|
|
2938
|
+
* 権限が不足している場合のエラーレスポンス。
|
|
2939
|
+
*/
|
|
2940
|
+
403: ProblemDetails;
|
|
2941
|
+
/**
|
|
2942
|
+
* 指定された組織が存在しない場合のエラーレスポンス。
|
|
2943
|
+
*/
|
|
2944
|
+
404: ProblemDetails;
|
|
2945
|
+
/**
|
|
2946
|
+
* 競合が発生した場合のエラーレスポンス。
|
|
2947
|
+
* - 既に同じメールアドレスへの有効な招待が存在する場合
|
|
2948
|
+
* - 既に組織のメンバーである場合
|
|
2949
|
+
*/
|
|
2950
|
+
409: ProblemDetails;
|
|
2951
|
+
/**
|
|
2952
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
2953
|
+
*/
|
|
2954
|
+
500: ProblemDetails;
|
|
2955
|
+
};
|
|
2956
|
+
export type SendInvitationError = SendInvitationErrors[keyof SendInvitationErrors];
|
|
2957
|
+
export type SendInvitationResponses = {
|
|
2958
|
+
/**
|
|
2959
|
+
* 招待の作成に成功した場合のレスポンス。
|
|
2960
|
+
*/
|
|
2961
|
+
201: OrganizationInvitationCreatedResponse;
|
|
2962
|
+
};
|
|
2963
|
+
export type SendInvitationResponse = SendInvitationResponses[keyof SendInvitationResponses];
|
|
2964
|
+
export type ListMembersData = {
|
|
2965
|
+
body?: never;
|
|
2966
|
+
path: {
|
|
2967
|
+
/**
|
|
2968
|
+
* 組織識別子(UUID形式)。
|
|
2969
|
+
*/
|
|
2970
|
+
organization_id: string;
|
|
2971
|
+
};
|
|
2972
|
+
query?: {
|
|
2973
|
+
/**
|
|
2974
|
+
* 取得するページ番号(1始まり)。
|
|
2975
|
+
*/
|
|
2976
|
+
page?: number;
|
|
2977
|
+
/**
|
|
2978
|
+
* 1ページあたりの取得件数。
|
|
2979
|
+
*/
|
|
2980
|
+
per_page?: number;
|
|
2981
|
+
/**
|
|
2982
|
+
* ソート基準フィールド。
|
|
2983
|
+
* - `name`: ユーザー表示名
|
|
2984
|
+
* - `email`: ユーザーメールアドレス
|
|
2985
|
+
* - `role`: 組織内ロール
|
|
2986
|
+
* - `joined_at`: 組織への参加日時
|
|
2987
|
+
* - `last_access`: 組織への最終アクセス日時
|
|
2988
|
+
*/
|
|
2989
|
+
sort_by?: 'name' | 'email' | 'role' | 'joined_at' | 'last_access';
|
|
2990
|
+
/**
|
|
2991
|
+
* ソート順。
|
|
2992
|
+
* - `asc`: 昇順
|
|
2993
|
+
* - `desc`: 降順
|
|
2994
|
+
*/
|
|
2995
|
+
sort_order?: 'asc' | 'desc';
|
|
2996
|
+
/**
|
|
2997
|
+
* ロールでメンバーを絞り込みます。カンマ区切りで複数値を指定可能(例: `?role=owner,admin`)。
|
|
2998
|
+
* 未指定時は全ロールを返却します。
|
|
2999
|
+
*/
|
|
3000
|
+
role?: Array<OrganizationRole>;
|
|
3001
|
+
/**
|
|
3002
|
+
* メンバーのメールドメインが組織の verified ドメインと一致するか (`corporate`)、しないか (`personal`) で絞り込みます。
|
|
3003
|
+
* カンマ区切りで複数値を指定可能(例: `?domain_type=corporate,personal`)。未指定時は全件返却します。
|
|
3004
|
+
*/
|
|
3005
|
+
domain_type?: Array<OrganizationMemberDomainType>;
|
|
3006
|
+
/**
|
|
3007
|
+
* メンバーの表示名またはメールアドレスに対する部分一致検索文字列。
|
|
3008
|
+
* 1〜255 文字。空文字列はバリデーションエラー(400)となります。
|
|
3009
|
+
*/
|
|
3010
|
+
search?: string;
|
|
3011
|
+
/**
|
|
3012
|
+
* `true` の場合、レスポンスのトップレベルに `role_counts` と `domain_counts`(フィルタ適用前の総件数集計)を含めて返却します。
|
|
3013
|
+
* 集計コストを避けるためデフォルトは `false`。
|
|
3014
|
+
*/
|
|
3015
|
+
include_counts?: boolean;
|
|
3016
|
+
};
|
|
3017
|
+
url: '/organizations/{organization_id}/members';
|
|
3018
|
+
};
|
|
3019
|
+
export type ListMembersErrors = {
|
|
3020
|
+
/**
|
|
3021
|
+
* クエリパラメータが不正な場合のエラーレスポンス。
|
|
3022
|
+
*/
|
|
3023
|
+
400: ProblemDetails;
|
|
3024
|
+
/**
|
|
3025
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
3026
|
+
*/
|
|
3027
|
+
401: ProblemDetails;
|
|
3028
|
+
/**
|
|
3029
|
+
* リクエストユーザーが対象組織のメンバーでない場合のエラーレスポンス。
|
|
3030
|
+
* 情報漏洩防止のため、組織そのものが存在しないケースもこのステータスで返却します。
|
|
3031
|
+
*/
|
|
3032
|
+
403: ProblemDetails;
|
|
3033
|
+
/**
|
|
3034
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
3035
|
+
*/
|
|
3036
|
+
429: ProblemDetails;
|
|
3037
|
+
/**
|
|
3038
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
3039
|
+
*/
|
|
3040
|
+
500: ProblemDetails;
|
|
3041
|
+
};
|
|
3042
|
+
export type ListMembersError = ListMembersErrors[keyof ListMembersErrors];
|
|
3043
|
+
export type ListMembersResponses = {
|
|
3044
|
+
/**
|
|
3045
|
+
* 組織メンバー一覧の取得に成功した場合のレスポンス。
|
|
3046
|
+
*/
|
|
3047
|
+
200: OrganizationMemberListResponse;
|
|
3048
|
+
};
|
|
3049
|
+
export type ListMembersResponse = ListMembersResponses[keyof ListMembersResponses];
|
|
3050
|
+
export type GetMemberMeData = {
|
|
3051
|
+
body?: never;
|
|
3052
|
+
path: {
|
|
3053
|
+
/**
|
|
3054
|
+
* 組織識別子(UUID形式)。
|
|
3055
|
+
*/
|
|
3056
|
+
organization_id: string;
|
|
3057
|
+
};
|
|
3058
|
+
query?: never;
|
|
3059
|
+
url: '/organizations/{organization_id}/members/me';
|
|
3060
|
+
};
|
|
3061
|
+
export type GetMemberMeErrors = {
|
|
3062
|
+
/**
|
|
3063
|
+
* パスパラメータ `organization_id` が UUID 形式でない場合のエラーレスポンス。
|
|
3064
|
+
*/
|
|
3065
|
+
400: ProblemDetails;
|
|
3066
|
+
/**
|
|
3067
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
3068
|
+
*/
|
|
3069
|
+
401: ProblemDetails;
|
|
3070
|
+
/**
|
|
3071
|
+
* リクエストユーザーが対象組織のメンバーでない場合のエラーレスポンス。
|
|
3072
|
+
* 情報漏洩防止のため、組織そのものが存在しないケースもこのステータスで返却します。
|
|
3073
|
+
*/
|
|
3074
|
+
403: ProblemDetails;
|
|
3075
|
+
/**
|
|
3076
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
3077
|
+
*/
|
|
3078
|
+
429: ProblemDetails;
|
|
3079
|
+
/**
|
|
3080
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
3081
|
+
*/
|
|
3082
|
+
500: ProblemDetails;
|
|
3083
|
+
};
|
|
3084
|
+
export type GetMemberMeError = GetMemberMeErrors[keyof GetMemberMeErrors];
|
|
3085
|
+
export type GetMemberMeResponses = {
|
|
3086
|
+
/**
|
|
3087
|
+
* 認証済みユーザーの組織メンバー情報の取得に成功した場合のレスポンス。
|
|
3088
|
+
*/
|
|
3089
|
+
200: OrganizationMember;
|
|
3090
|
+
};
|
|
3091
|
+
export type GetMemberMeResponse = GetMemberMeResponses[keyof GetMemberMeResponses];
|
|
3092
|
+
export type RemoveMemberData = {
|
|
3093
|
+
body?: never;
|
|
3094
|
+
path: {
|
|
3095
|
+
/**
|
|
3096
|
+
* 組織識別子(UUID形式)。
|
|
3097
|
+
*/
|
|
3098
|
+
organization_id: string;
|
|
3099
|
+
/**
|
|
3100
|
+
* メンバー識別子(UUID形式)。
|
|
3101
|
+
*/
|
|
3102
|
+
member_id: string;
|
|
3103
|
+
};
|
|
3104
|
+
query?: never;
|
|
3105
|
+
url: '/organizations/{organization_id}/members/{member_id}';
|
|
3106
|
+
};
|
|
3107
|
+
export type RemoveMemberErrors = {
|
|
3108
|
+
/**
|
|
3109
|
+
* バリデーションエラーが発生した場合のエラーレスポンス。
|
|
3110
|
+
* - パスパラメータ `organization_id` または `member_id` が UUID 形式でない
|
|
3111
|
+
*/
|
|
3112
|
+
400: ProblemDetails;
|
|
3113
|
+
/**
|
|
3114
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
3115
|
+
*/
|
|
3116
|
+
401: ProblemDetails;
|
|
3117
|
+
/**
|
|
3118
|
+
* 認可に失敗した場合のエラーレスポンス。
|
|
3119
|
+
* - リクエストユーザーが対象組織のメンバーでない(情報漏洩防止のため組織不存在も同ステータス)
|
|
3120
|
+
* - リクエストユーザーのロールが Owner / Admin のいずれでもない
|
|
3121
|
+
*/
|
|
3122
|
+
403: ProblemDetails;
|
|
3123
|
+
/**
|
|
3124
|
+
* 指定されたメンバーが組織内に存在しない場合のエラーレスポンス。
|
|
3125
|
+
*/
|
|
3126
|
+
404: ProblemDetails;
|
|
3127
|
+
/**
|
|
3128
|
+
* 競合が発生した場合のエラーレスポンス。
|
|
3129
|
+
* - リクエストユーザーが自分自身を削除しようとした場合(`cannot-delete-self`)
|
|
3130
|
+
* - 組織内の最後の Owner を削除しようとした場合(`last-owner-cannot-be-removed`)
|
|
3131
|
+
*/
|
|
3132
|
+
409: ProblemDetails;
|
|
3133
|
+
/**
|
|
3134
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
3135
|
+
*/
|
|
3136
|
+
429: ProblemDetails;
|
|
3137
|
+
/**
|
|
3138
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
3139
|
+
*/
|
|
3140
|
+
500: ProblemDetails;
|
|
3141
|
+
};
|
|
3142
|
+
export type RemoveMemberError = RemoveMemberErrors[keyof RemoveMemberErrors];
|
|
3143
|
+
export type RemoveMemberResponses = {
|
|
3144
|
+
/**
|
|
3145
|
+
* メンバーの削除に成功した場合のレスポンス(ボディなし)。
|
|
3146
|
+
*/
|
|
3147
|
+
204: void;
|
|
3148
|
+
};
|
|
3149
|
+
export type RemoveMemberResponse = RemoveMemberResponses[keyof RemoveMemberResponses];
|
|
3150
|
+
export type UpdateMemberRoleData = {
|
|
3151
|
+
body: OrganizationMemberUpdateRequest;
|
|
3152
|
+
path: {
|
|
3153
|
+
/**
|
|
3154
|
+
* 組織識別子(UUID形式)。
|
|
3155
|
+
*/
|
|
3156
|
+
organization_id: string;
|
|
3157
|
+
/**
|
|
3158
|
+
* メンバー識別子(UUID形式)。
|
|
3159
|
+
*/
|
|
3160
|
+
member_id: string;
|
|
3161
|
+
};
|
|
3162
|
+
query?: never;
|
|
3163
|
+
url: '/organizations/{organization_id}/members/{member_id}';
|
|
3164
|
+
};
|
|
3165
|
+
export type UpdateMemberRoleErrors = {
|
|
3166
|
+
/**
|
|
3167
|
+
* バリデーションエラーが発生した場合のエラーレスポンス。
|
|
3168
|
+
* - パスパラメータ `organization_id` または `member_id` が UUID 形式でない
|
|
3169
|
+
* - `role` が列挙値のいずれでもない
|
|
3170
|
+
* - リクエストユーザーが自分自身のロールを変更しようとした
|
|
3171
|
+
*/
|
|
3172
|
+
400: ProblemDetails;
|
|
3173
|
+
/**
|
|
3174
|
+
* 認証に失敗した場合のエラーレスポンス。
|
|
3175
|
+
*/
|
|
3176
|
+
401: ProblemDetails;
|
|
3177
|
+
/**
|
|
3178
|
+
* 認可に失敗した場合のエラーレスポンス。
|
|
3179
|
+
* - リクエストユーザーが対象組織のメンバーでない(情報漏洩防止のため組織不存在も同ステータス)
|
|
3180
|
+
* - リクエストユーザーのロールが Owner でない
|
|
3181
|
+
*/
|
|
3182
|
+
403: ProblemDetails;
|
|
3183
|
+
/**
|
|
3184
|
+
* 指定されたメンバーが組織内に存在しない場合のエラーレスポンス。
|
|
3185
|
+
*/
|
|
3186
|
+
404: ProblemDetails;
|
|
3187
|
+
/**
|
|
3188
|
+
* 競合が発生した場合のエラーレスポンス。
|
|
3189
|
+
* - 組織内の最後の Owner のロールを変更しようとした場合
|
|
3190
|
+
*/
|
|
3191
|
+
409: ProblemDetails;
|
|
3192
|
+
/**
|
|
3193
|
+
* レート制限超過。次のリクエストまで待機してください。
|
|
3194
|
+
*/
|
|
3195
|
+
429: ProblemDetails;
|
|
3196
|
+
/**
|
|
3197
|
+
* エラーが発生した場合の Problem Details (RFC 9457) レスポンス。
|
|
3198
|
+
*/
|
|
3199
|
+
500: ProblemDetails;
|
|
3200
|
+
};
|
|
3201
|
+
export type UpdateMemberRoleError = UpdateMemberRoleErrors[keyof UpdateMemberRoleErrors];
|
|
3202
|
+
export type UpdateMemberRoleResponses = {
|
|
3203
|
+
/**
|
|
3204
|
+
* メンバーロールの変更に成功した場合のレスポンス。
|
|
3205
|
+
*/
|
|
3206
|
+
200: OrganizationMember;
|
|
3207
|
+
};
|
|
3208
|
+
export type UpdateMemberRoleResponse = UpdateMemberRoleResponses[keyof UpdateMemberRoleResponses];
|
|
3209
|
+
export type CheckSsoEnforcementData = {
|
|
3210
|
+
body?: never;
|
|
3211
|
+
path?: never;
|
|
3212
|
+
query?: {
|
|
3213
|
+
/**
|
|
3214
|
+
* 判定対象のメールアドレス
|
|
3215
|
+
*/
|
|
3216
|
+
email?: string;
|
|
3217
|
+
/**
|
|
3218
|
+
* 判定対象のユーザーID(UUID)
|
|
3219
|
+
*/
|
|
3220
|
+
sub?: string;
|
|
3221
|
+
};
|
|
3222
|
+
url: '/api/sso-enforcement/check';
|
|
3223
|
+
};
|
|
3224
|
+
export type CheckSsoEnforcementErrors = {
|
|
3225
|
+
/**
|
|
3226
|
+
* リクエストパラメータが不正
|
|
3227
|
+
*/
|
|
3228
|
+
400: ProblemDetails;
|
|
3229
|
+
/**
|
|
3230
|
+
* クライアント認証失敗
|
|
3231
|
+
*/
|
|
3232
|
+
401: SsoEnforcementErrorResponse;
|
|
3233
|
+
/**
|
|
3234
|
+
* サーバー内部エラー
|
|
3235
|
+
*/
|
|
3236
|
+
500: ProblemDetails;
|
|
3237
|
+
};
|
|
3238
|
+
export type CheckSsoEnforcementError = CheckSsoEnforcementErrors[keyof CheckSsoEnforcementErrors];
|
|
3239
|
+
export type CheckSsoEnforcementResponses = {
|
|
3240
|
+
/**
|
|
3241
|
+
* SSO 強制判定結果
|
|
3242
|
+
*/
|
|
3243
|
+
200: CheckSsoEnforcementResponse;
|
|
3244
|
+
};
|
|
3245
|
+
export type CheckSsoEnforcementResponse2 = CheckSsoEnforcementResponses[keyof CheckSsoEnforcementResponses];
|
|
3246
|
+
//# sourceMappingURL=types.gen.d.ts.map
|