ユーザー無効有効API
ユーザー無効有効API
1. API 概要
API名: ユーザー無効有効API
目的: 指定されたユーザーのレコードを更新して、ユーザーを無効化または有効化する。
概要:
このAPIは、クライアントで指定されたユーザーのレコードを更新して、ユーザーを無効化または有効化します。
無効化したユーザーはiPCにログインできなくなります。また、他のユーザーが案件を作成する際のユーザーリストに表示されなくなります。
有効化したユーザーはiPCにログインできます。また、他のユーザーが案件を作成する際のユーザーリストに表示されます。
2. リクエスト
2.1 リクエストURL
メソッド：PUT
ドメイン：お問い合わせください。
エンドポイント：お問い合わせください。
2.2 リクエストヘッダー
| ヘッダー名 | 値 | 説明 |
|---|---|---|
| Content-Type | application/json | リクエストボディのフォーマット。 |
| Authorization | Bearer {access_token} | 認証トークン。 |
2.3 リクエストボディ
リクエストボディにはJSON形式でデータを含めます。以下はその例です。
例
{
"isActive": true
}
2.4 パラメータ説明
| パラメータ名 | JSONキー | 型 | 必須 | 制約 | 説明 | ||
|---|---|---|---|---|---|---|---|
| 有効/無効 | isActive |
boolean |
○ | true/false | true: 有効, false: 無効。 |
3. レスポンス
3.1 レスポンス成功時
ステータスコード: 204 NO CONTENT
レスポンス例
なし
3.2 レスポンス失敗時
ステータスコード: 400 Bad Request (入力が不正な場合)
レスポンス例(バリデーションエラー)
{
"code": "METHOD_ARGUMENT_NOT_VALID",
"title": "リクエストの入力データが無効",
"cause": "有効/無効の内容が不正です。",
"requestId": "0699939e"
}
{
"code": "HTTP_MESSAGE_NOT_READABLE",
"title": "リクエストの形式が不正",
"cause": "リクエストの形式が不正です。",
"requestId": "0699939e"
}
ステータスコード: 403 Forbidden (Keycloakの認証エラー)
レスポンス例(権限エラー)
なし
ステータスコード: 404 Not Found (指定したユーザーが見つからない)
レスポンス例(ユーザーが見つからない)
{
"code": "RESOURCE_NOT_FOUND",
"title": "指定されたリソースが不明",
"cause": "ユーザーが見つかりません。XXX",
"requestId": "0699939e"
}
ステータスコード: 500 Internal Server Error (サーバーエラーが発生した場合)
レスポンス例(サーバーエラー)
{
"code": "RUNTIME_ERROR",
"title": "予期せぬエラーが発生",
"cause": "予期せぬエラーが発生しました。",
"requestId": "0699939e"
}
失敗レスポンス説明
| パラメーター名 | Jsonキー | 型 | 説明 |
|---|---|---|---|
| コード | code |
string |
発生したエラーを種類ごとに識別するためのコード |
| タイトル | title |
string |
エラーやイベントの概要を示す短い見出し |
| 原因 | cause |
string |
問題の根本的な要因を説明 |
| リクエストID | requestId |
string |
リクエストで一意に振り分けられるID。問い合わせの際に送信してください。 |
4. エラーハンドリング
| ステータスコード | エラーの種類 | 説明 |
|---|---|---|
| 400 | Bad Request | リクエストが不正な場合(例えば、必須パラメータの欠如、フォーマットエラーなど)。 |
| 403 | Forbidden | レスポンスが存在しない場合、Keycloakの認証エラー(全API共通)。 |
| 404 | Not Found | 指定されたユーザーが見つからない |
| 500 | Internal Server Error | サーバー側の問題 |
5. 認証
このAPIには、認証が必要です。リクエストのヘッダーにBearerトークンを含めてください。
- Authorizationヘッダー:
Bearer {access_token}ここで、access_tokenは認証を通過したユーザーのアクセストークンです。
6. その他の注意点
- なし
