Employee Identity (EIAM)
API List
API
This document introduces the API list for each module in V2 version.
# Organization Management
| API Name | API Endpoint | Request Method |
|---|---|---|
| Create Organization | /api/v2/tenant/organizations | POST |
| Modify Organization | /api/v2/tenant/organizations/{org_id} | PUT |
| Delete Organization | /api/v2/tenant/organizations/{org_id} | DELETE |
| Query Organization Info by ID | /api/v2/tenant/organizations/{org_id} | GET |
| Query Organization Info by Code | /api/v2/tenant/organizations/org-codes/{org_code} | GET |
| Get Organization List | /api/v2/tenant/organizations?org_id=&all_child=false&offset=0&limit=10 | GET |
| Save Organization Leader API | /api/v2/tenant/organizations/{org_id}/org-leader | PUT |
| Query Organization Leader by ID API | /api/v2/tenant/organizations/{org_id}/org-leader | GET |
| Enable Organization | /api/v2/tenant/organizations/{org_id}/enable | PUT |
| Disable Organization | /api/v2/tenant/organizations/{org_id}/disable | PUT |
# User Management
| Interface Name | Interface Address | Request Method |
|---|---|---|
| Add User | /api/v2/tenant/users | POST |
| Modify User | /api/v2/tenant/users/{user_id} | PUT |
| Change User Password | /api/v2/tenant/users/{user_id}/change-password | PUT |
| Change User Password (Verify Old Password) | /api/v2/tenant/users/{user_id}/change-password-verify | PUT |
| Reset User Password | /api/v2/tenant/users/{user_id}/rest-password?send_mode=EMAIL | PUT |
| Disable User | /api/v2/tenant/users/{user_id}/disable | PUT |
| Enable User | /api/v2/tenant/users/{user_id}/enable | PUT |
| Authorize Application Account for User | /api/v2/tenant/users/{user_id}/applications/{app_id}/accounts | POST |
| Delete User | /api/v2/tenant/users/{user_id} | DELETE |
| Get User Details by ID | /api/v2/tenant/users/{user_id} | GET |
| Get User Details by Phone Number | /api/v2/tenant/users/user-by-mobile | POST |
| Get User Details by Username | /api/v2/tenant/users/user-by-username | POST |
| Get User Details by User Email | /api/v2/tenant/users/user-by-email | POST |
| Get All Authorized Application Accounts for User | /api/v2/tenant/users/{user_id}/accounts | GET |
| Get User List | /api/v2/tenant/users?org_id={org_id}&offset=0&limit=10 | GET |
| Get User Social Account List | /api/v2/tenant/social?offset=0&limit=10 | GET |
| Unbind User Social Account | /api/v2/tenant/social/unbind/{id} | DELETE |
| Get User's Positions | /api/v2/tenant/users/{user_id}/jobs?type= | GET |
| Adjust User's Organization and Primary Position | /api/v2/tenant/users/{user_id}/jobs/transfer | PUT |
| Add User's Part-time/Concurrent Position | /api/v2/tenant/users/{user_id}/part-time-job | POST |
| Modify User's Part-time/Concurrent Position | /api/v2/tenant/users/{user_id}/part-time-job/{job_id} | PUT |
| Delete User's Part-time/Concurrent Position | /api/v2/tenant/users/{user_id}/part-time-job/{job_id} | DELETE |
# Job Position Management
| API Name | API Endpoint | HTTP Method |
|---|---|---|
| Add Job Position | /api/v2/tenant/job-positions | POST |
| Modify Job Position | /api/v2/tenant/job-positions/{position_id} | PUT |
| Delete Job Position | /api/v2/tenant/job-positions/{position_id} | DELETE |
| Get Job Position Details by ID | /api/v2/tenant/job-positions/{position_id} | GET |
| Get Job Position List | /api/v2/tenant/job-positions?org_id=&offset=0&limit=10 | GET |
# Job Title Management
| API Name | API Endpoint | HTTP Method |
|---|---|---|
| Add Job Title | /api/v2/tenant/job-titles | POST |
| Modify Job Title | /api/v2/tenant/job-titles/{title_id} | PUT |
| Delete Job Title | /api/v2/tenant/job-titles/{title_id} | DELETE |
| Get Job Title Details by ID | /api/v2/tenant/job-titles/{title_id} | GET |
| Get Job Title List | /api/v2/tenant/job-titles?offset=0&limit=10 | GET |
# Application Organization Authorization Management
| Interface Name | Interface Address | Request Method |
|---|---|---|
| Add Application Organization | /api/v2/tenant/applications/{app_id}/organizations | POST |
| Modify Application Organization | /api/v2/tenant/applications/{app_id}/organizations/{app_org_id} | PUT |
| Delete Application Organization | /api/v2/tenant/applications/{app_id}/organizations/{app_org_id} | DELETE |
| Get Application Organization Information | /api/v2/tenant/applications/{app_id}/organizations/{app_org_id} | GET |
| Get Application Organization List | /api/v2/tenant/applications/{app_id}/organizations?&offset=0&limit=10 | GET |
# Application Account Authorization Management
| Interface Name | Interface Address | Request Method |
|---|---|---|
| Add Compliant Account | /api/v2/tenant/applications/{app_id}/accounts/basic-account | POST |
| Add Public Account | /api/v2/tenant/applications/{app_id}/accounts/public-account | POST |
| Add Orphan Account | /api/v2/tenant/applications/{app_id}/accounts/orphan-account | POST |
| Update Application Account | /api/v2/tenant/applications/{app_id}/accounts/{app_user_id} | PUT |
| Delete Application Account | /api/v2/tenant/applications/{app_id}/accounts/{app_user_id} | DELETE |
| Disable Application Account | /api/v2/tenant/applications/{app_id}/accounts/{app_user_id}/disable | PUT |
| Enable Application Account | /api/v2/tenant/applications/{app_id}/accounts/{app_user_id}/enable | PUT |
| Add User for Public Account | /api/v2/tenant/applications/{app_id}/accounts/public-account/{app_user_id}/users/bind | POST |
| Remove User from Public Account | /api/v2/tenant/applications/{app_id}/accounts/public-account/{app_user_id}/users/unbind | POST |
| Bind Public Account Owner | /api/v2/tenant/applications/{app_id}/accounts/public-account/{app_user_id}/owner | POST |
| Add Application Account Role | /api/v2/tenant/applications/{app_id}/accounts/{account_id}/member-role | POST |
| Delete Application Account Role | /api/v2/tenant/applications/{app_id}/accounts/{account_id}/member-role | DELETE |
| Get Application Account List | /api/v2/tenant/applications/{app_id}/accounts?account_type=&offset=0&limit=10 | GET |
| Get Application Account Information | /api/v2/tenant/applications/{app_id}/accounts/{app_user_id} | GET |
| Query Public Account Users | /api/v2/tenant/applications/{app_id}/accounts/public-account/{app_user_id}/users?offset=0&limit=10 | GET |
| Query Public Account Owner | /api/v2/tenant/applications/{app_id}/accounts/public-account/{app_user_id}/owner | GET |
| Query Single Application Account's Application-side Permissions | /api/v2/tenant/applications/{application_id}/account/{account_id}/permissions | GET |
| Page Query Application Accounts' Application-side Permissions | /api/v2/tenant/applications/{application_id}/accounts/permissions/page | GET |
# Log Audit
| Interface Name | Interface Address | Request Method |
|---|---|---|
| Query User Operation Logs | /api/v2/tenant/logs/users-log?start_time=2022-04-14 00:00:00&end_time=2022-04-18 23:59:59&offset=0&limit=50 | GET |
| Query Authentication Count | /api/v2/tenant/logs/auth-num?start_time=2022-03-25 00:00:00&end_time=2022-04-19 10:50:59&offset=0&limit=50&target_type=&target_name= | GET |
# Application-Side Role Management
| Interface Name | Interface Address | Request Method |
|---|---|---|
| Query Application-Side Role List | /api/v2/tenant/applications/{app_id}/role-list?offset=0&limit=10 | GET |
| Query Application-Side Permissions for a Single Role | /api/v2/tenant/applications/{application_id}/app-role/{role_id}/permissions | GET |
| Paginated Query of Application-Side Permissions for Roles | /api/v2/tenant/applications/{application_id}/app-roles/permissions/page | GET |
# Application-Side Message Notification Management
| Interface Name | Interface Address | Request Method |
|---|---|---|
| Send In-Site Notification | /api/v2/tenant/notice/insite/asyncSend | POST |
| Query In-Site Notification Sending Result | /api/v2/tenant/notice/insite/{notice_id}/getSendResult | GET |
# Application Side To-Do Task Management
| Interface Name | Interface Address | Request Method |
|---|---|---|
| Add To-Do | /api/v2/tenant/todo/task | POST |
| Update To-Do | /api/v2/tenant/todo/task/{todo_id} | PUT |
| Delete To-Do | /api/v2/tenant/todo/task/{todo_id} | DELETE |
| Query Single To-Do | /api/v2/tenant/todo/task/{todo_id} | GET |
| Query To-Do by External ID | /api/v2/tenant/todo/task/sources/{external_id} | GET |
| Modify To-Do Processing Status | /api/v2/tenant/todo/task/{todo_id}/todoStatus | PUT |
# Application Side Permission Management
| Interface Name | Interface Address | Request Method |
|---|---|---|
| Query Application Side Functional Permissions | /api/v2/tenant/applications/{application_id}/func-perms | GET |
| Query Application Side Data Permission Models | /api/v2/tenant/applications/{application_id}/func-perm-models | GET |
| Query Application Side Data Permissions | /api/v2/tenant/applications/{application_id}/data-perms | GET |
Please provide the Markdown content you need translated.