ユーザー一覧取得API
ユーザー情報更新API
1. API 概要
API名: ユーザー一覧取得API
目的: 企業内の全ユーザーの基本情報を取得
概要: このAPIは、企業内の全ユーザーの基本情報を取得します。
2. リクエスト
2.1 リクエストURL
メソッド：GET
ドメイン：お問い合わせください。
エンドポイント：お問い合わせください。
2.2 リクエストヘッダー
| ヘッダー名 | 値 | 説明 |
|---|---|---|
| Content-Type | application/json | リクエストボディのフォーマット。 |
| Authorization | Bearer {access_token} | 認証トークン。 |
3. レスポンス
3.1 レスポンス成功時
ステータスコード: 200 OK
レスポンス例
{
"users": [
{
"userName": "test-user-1",
"mailAddress": "test-user-1@example.com",
"firstName": "user-1",
"lastName": "test",
"firstNameKana": "ゆーざーいち",
"lastNameKana": "てすと",
"employeeCode": "001",
"departmentPositions": [
{
"departmentName": "部署A",
"departmentCode": "A",
"positionName": "役職A",
"positionCode": "A",
"isPrimaryAssignment": true
}
],
"roles": [
{
"roleCategoryName": "基本カテゴリー",
"roleName": "企業担当"
},
{
"roleCategoryName": "契約ライフサイクル管理",
"roleName": "管理"
}
]
},
{
"userName": "test-user-2",
"mailAddress": "test-user-2@example.com",
"firstName": "user-2",
"lastName": "test",
"firstNameKana": "ゆーざーに",
"lastNameKana": "てすと",
"employeeCode": "002",
"departmentPositions": [
{
"departmentName": "部署B",
"departmentCode": "B",
"positionName": "役職B",
"positionCode": "B",
"isPrimaryAssignment": true
},
{
"departmentName": "部署C",
"departmentCode": "C",
"positionName": "役職C",
"positionCode": "C",
"isPrimaryAssignment": false
}
],
"roles": [
{
"roleCategoryName": "基本カテゴリー",
"roleName": "ユーザー"
}
]
}
],
"totalCount": 2
}
3.2 レスポンス失敗時
ステータスコード: 403 Forbidden (Keycloakの認証エラー)
レスポンス例(権限エラー)
なし
ステータスコード: 500 Internal Server Error (サーバーエラーが発生した場合)
レスポンス例(サーバーエラー)
{
"code": "RUNTIME_ERROR",
"title": "予期せぬエラーが発生",
"cause": "予期せぬエラーが発生しました。",
"requestId": "0699939e"
}
失敗レスポンス説明
| パラメーター名 | Jsonキー | 型 | 説明 |
|---|---|---|---|
| コード | code |
string |
発生したエラーを種類ごとに識別するためのコード |
| タイトル | title |
string |
エラーやイベントの概要を示す短い見出し |
| 原因 | cause |
string |
問題の根本的な要因を説明 |
| リクエストID | requestId |
string |
リクエストで一意に振り分けられるID。問い合わせの際に送信してください。 |
4. エラーハンドリング
| ステータスコード | エラーの種類 | 説明 |
|---|---|---|
| 403 | Forbidden | レスポンスが存在しない場合、Keycloakの認証エラー(全API共通)。 |
| 500 | Internal Server Error | サーバー側の問題 |
5. 認証
このAPIには、認証が必要です。リクエストのヘッダーにBearerトークンを含めてください。
- Authorizationヘッダー:
Bearer {access_token}ここで、access_tokenは認証を通過したユーザーのアクセストークンです。
6. その他の注意点
- なし
