> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/system-bo-api/user-information-management.md).
# User Information Management
## Retrieve User List
> \## Function Description\
> \* Retrieves the user list according to the conditions selected on the screen.\
> \---\
> \## Detailed Description\
> \* Retrieves the user list according to the conditions selected on the screen.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UserListRequest":{"type":"object","description":"User Information Management Request DTO","properties":{"jobGrpCd":{"type":"string","description":"Work Group Code","enum":["SYSTEM_MANAGER","MD","MARKETING","LGST_CNTR","CUST_CNTR","COOP_CORP","AFCR"]},"userId":{"type":"string","description":"User ID"},"userNm":{"type":"string","description":"User ID"},"sysGbCd":{"type":"string","description":"System Type Code (UR005)"},"useYn":{"type":"string","description":"Usage Status"},"userInfoSearchTgt":{"type":"string","description":"User Information Search Type"},"userInfo":{"type":"string","description":"User Information (Name or ID)"},"workStatCd":{"type":"string","description":"Work Status Code (UR004)"},"indInfoDealYn":{"type":"string","description":"Personal Information Handling Status"},"pwdLockYn":{"type":"string","description":"Account Lock Status"},"rtGrpNo":{"type":"string","description":"Permission Group No."}}},"ResponseRealGridListResponseUserListResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"$ref":"#/components/schemas/RealGridListResponseUserListResponse","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"RealGridListResponseUserListResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/UserListResponse"}}}},"UserListResponse":{"type":"object","description":"User Information Management Response DTO","properties":{"userId":{"type":"string","description":"User ID"},"userNm":{"type":"string","description":"User Name"},"rcntUseDtm":{"type":"string","description":"Last Used Date/Time"},"orgTypNm":{"type":"string","description":"Task Group Code (UR002)","enum":["SYSTEM_MANAGER","MD","MARKETING","LGST_CNTR","CUST_CNTR","COOP_CORP","AFCR"]},"deptNm":{"type":"string","description":"Department Name"},"ocpNm":{"type":"string","description":"Position Code (UR003)"},"workStatNm":{"type":"string","description":"Work Status Code (UR004)"},"pwdLockYn":{"type":"string","description":"Account Lock Status"},"indInfoDealYn":{"type":"string","description":"Personal Information Handling Status"},"useYn":{"type":"string","description":"Usage Status"},"sysGbCdNm":{"type":"string","description":"System Classification Name"},"rtGrpNm":{"type":"string","description":"Authorization Group Name"},"totalCount":{"type":"integer","format":"int32","description":"List Count"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v2/system/userMgmt":{"get":{"tags":["User Information Management"],"summary":"Retrieve User List","description":"## Function Description\n* Retrieves the user list according to the conditions selected on the screen.\n---\n## Detailed Description\n* Retrieves the user list according to the conditions selected on the screen.\n","operationId":"getUserListInUserMenu","parameters":[{"name":"userListRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/UserListRequest"}},{"name":"sysGbCd","in":"query","description":"System Classification Code","schema":{"type":"string"}},{"name":"jobGrpCd","in":"query","description":"Work Group Code","schema":{"type":"string"}},{"name":"userInfoSearchTgt","in":"query","description":"User Information Search Type","schema":{"type":"string"}},{"name":"userInfo","in":"query","description":"User Information (Name or ID)","schema":{"type":"string"}},{"name":"useYn","in":"query","description":"Usage Status","schema":{"type":"string"}},{"name":"workStatCd","in":"query","description":"Department Code","schema":{"type":"string"}},{"name":"indInfoDealYn","in":"query","description":"Work Status Code","schema":{"type":"string"}},{"name":"pwdLockYn","in":"query","description":"Account Lock Status","schema":{"type":"string"}},{"name":"pageIdx","in":"query","description":"Current Page","required":true,"schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"Rows per Page","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseRealGridListResponseUserListResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Save User
> \## Function Description\
> \* Saves user information.\
> \---\
> \## Detailed Description\
> \* Registers a new user or modifies existing user information.\
> \* An alert message is sent to the user's mobile phone number for changed values.\
> \* Required Value List\
> \* User ID\
> \* User Name\
> \* Mobile Phone No.\
> \* Permission Group No.\
> \* Email Address\
> \* Work Group Code\
> \* Job Title Code\
> \* Work Status Code
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UserDetailRequest":{"type":"object","description":"User Save Request DTO","properties":{"userInfo":{"$ref":"#/components/schemas/UserCudRequest","description":"User Information"},"individualInfoRightList":{"type":"array","description":"Personal Data Handling Permission","items":{"$ref":"#/components/schemas/IndividualInfoRightCudRequest"}},"changeRtGrpNoYn":{"type":"string","description":"Permission Group Change Status","minLength":1},"createYn":{"type":"string","description":"New Registration Status","minLength":1},"beforeRtGrpNo":{"type":"string","description":"Permission Group No. Before Change"},"rtGrpChgCausCont":{"type":"string"}},"required":["changeRtGrpNoYn","createYn"]},"UserCudRequest":{"type":"object","description":"User Modification Request DTO","properties":{"userId":{"type":"string","description":"User ID","minLength":1},"userNm":{"type":"string","description":"User Name","minLength":1},"empNo":{"type":"string","description":"Employee No."},"pwd":{"type":"string","description":"Password"},"userGbCd":{"type":"string","description":"User Type Code (UR001)","minLength":1},"rtGrpNo":{"type":"string","description":"Permission Group No.","minLength":1},"jobGrpCd":{"type":"string","description":"Work Group Code","enum":["SYSTEM_MANAGER","MD","MARKETING","LGST_CNTR","CUST_CNTR","COOP_CORP","AFCR"],"minLength":1},"ocpCd":{"type":"string","description":"Organization Role Code (UR003)","minLength":1},"workStatCd":{"type":"string","description":"Work Status Code (UR004)","minLength":1},"deptCd":{"type":"string","description":"Department Code"},"entrNo":{"type":"string","description":"Vendor No."},"telRgnNo":{"type":"string","description":"Phone Area Code"},"telTxnoNo":{"type":"string","description":"Phone Exchange Number"},"telEndNo":{"type":"string","description":"Phone Subscriber Number"},"cellSctNo":{"type":"string","description":"Mobile Carrier Code","minLength":1},"cellTxnoNo":{"type":"string","description":"Mobile Exchange Number","minLength":1},"cellEndNo":{"type":"string","description":"Mobile Subscriber Number","minLength":1},"cnslEntpNm":{"type":"string","description":"Consultation Company Name"},"ctiNo":{"type":"string","description":"CTI No."},"itelNo":{"type":"string","description":"Extension Number"},"emailAddr":{"type":"string","description":"Email Address","minLength":1},"indInfoDealYn":{"type":"string","description":"Personal Information Handling Status","minLength":1},"useYn":{"type":"string","description":"Usage Status","minLength":1},"atchFileRouteNm":{"type":"string","description":"Attachment File Path (Currently Unused)"},"atchFileNm":{"type":"string","description":"Attachment File Name (Currently Unused)"},"indInfoDealCausCont":{"type":"string","description":"Personal Data Handling Reason Content"},"userIpAddr":{"type":"string","description":"Allowed Access IP"}},"required":["cellEndNo","cellSctNo","cellTxnoNo","emailAddr","indInfoDealYn","jobGrpCd","ocpCd","rtGrpNo","useYn","userGbCd","userId","userNm","workStatCd"]},"IndividualInfoRightCudRequest":{"type":"object","properties":{"userId":{"type":"string","minLength":1},"indInfoGbCd":{"type":"string","minLength":1},"useYn":{"type":"string","minLength":1}},"required":["indInfoGbCd","useYn","userId"]},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v2/system/userMgmt":{"post":{"tags":["User Information Management"],"summary":"Save User","description":"## Function Description\n* Saves user information.\n---\n## Detailed Description\n* Registers a new user or modifies existing user information.\n* An alert message is sent to the user's mobile phone number for changed values.\n* Required Value List\n * User ID\n * User Name\n * Mobile Phone No.\n * Permission Group No.\n * Email Address\n * Work Group Code\n * Job Title Code\n * Work Status Code\n","operationId":"saveUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDetailRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Password Reset
> \## Function Description\
> \* Resets the user's password.\
> \---\
> \## Detailed Description\
> \* The password is changed to a random value.\
> \* The changed value is sent to the user's mobile phone number via AlimTalk notification
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v2/system/userMgmt/{userId}/password/reset":{"post":{"tags":["User Information Management"],"summary":"Password Reset","description":"## Function Description\n* Resets the user's password.\n---\n## Detailed Description\n* The password is changed to a random value.\n* The changed value is sent to the user's mobile phone number via AlimTalk notification\n","operationId":"modifyInitializePassword","parameters":[{"name":"userId","in":"query","description":"User ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Password Reset
> \## Function Description\
> \* Resets the user's password.\
> \---\
> \## Detailed Description\
> \* The password is changed to a random value.\
> \* The changed value is sent to the user's mobile phone number via AlimTalk notification
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/userMgmt/modifyInitializePassword":{"post":{"tags":["User Information Management"],"summary":"Password Reset","description":"## Function Description\n* Resets the user's password.\n---\n## Detailed Description\n* The password is changed to a random value.\n* The changed value is sent to the user's mobile phone number via AlimTalk notification\n","operationId":"modifyInitializePassword_1","parameters":[{"name":"userId","in":"query","description":"User ID","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Unlock Password
> \## Function Description\
> \* Processes the unlocking of a locked password.\
> \---\
> \## Detailed Description\
> \* Unlocks the password for a user whose password is locked.\
> \* Resets the password failure count to 0.\
> \* Returns the updated user information.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UserDetailResponse":{"type":"object","description":"User Information Response DTO","properties":{"userInfo":{"$ref":"#/components/schemas/StUserBase","description":"User Information"},"individualInfoRightList":{"type":"array","description":"Personal Data Handling Permission","items":{"$ref":"#/components/schemas/PrivacyPolicyInfo"}}}},"StUserBase":{"type":"object","description":"User Information Entity","properties":{"userId":{"type":"string","description":"User ID"},"userGbCd":{"type":"string","description":"User Type Code (UR001)"},"deptCd":{"type":"string","description":"Department Code"},"deptNm":{"type":"string","description":"Department Name"},"entrNo":{"type":"string","description":"Vendor No."},"entrNm":{"type":"string","description":"Vendor Name"},"userNm":{"type":"string","description":"User Name"},"pwd":{"type":"string","description":"Password"},"sysGbCd":{"type":"string","description":"System Group No."},"rtGrpNo":{"type":"string","description":"Permission Group No."},"rtGrpNm":{"type":"string","description":"Permission Group Name"},"useYn":{"type":"string","description":"Usage Status"},"telRgnNo":{"type":"string","description":"Phone Area Code"},"telTxnoNo":{"type":"string","description":"Phone Exchange Number"},"telEndNo":{"type":"string","description":"Phone Subscriber Number"},"cellSctNo":{"type":"string","description":"Mobile Carrier Code"},"cellTxnoNo":{"type":"string","description":"Mobile Exchange Number"},"cellEndNo":{"type":"string","description":"Mobile Subscriber Number"},"emailAddr":{"type":"string","description":"Email Address"},"indInfoDealYn":{"type":"string","description":"Personal Information Handling Status"},"indInfoDealCausCont":{"type":"string","description":"Personal Data Handling Reason Content"},"empNo":{"type":"string","description":"Employee No."},"jobGrpCd":{"type":"string","description":"Task Group Code (UR002)","enum":["SYSTEM_MANAGER","MD","MARKETING","LGST_CNTR","CUST_CNTR","COOP_CORP","AFCR"]},"ocpCd":{"type":"string","description":"Position Code (UR003)"},"workStatCd":{"type":"string","description":"Employment Status Code (UR004)"},"atchFileRouteNm":{"type":"string","description":"Attachment File Path Name (Currently Unused)"},"atchFileNm":{"type":"string","description":"Attachment File Name (Currently Unused)"},"useStrtDt":{"type":"string","description":"Usage Start Date"},"useEndDt":{"type":"string","description":"Usage End Date"},"cnslEntpNm":{"type":"string","description":"Consultation Company Name"},"itelNo":{"type":"string","description":"Extension Number"},"ctiNo":{"type":"string","description":"CTI No."},"rcntUseDtm":{"type":"string","format":"date-time","description":"Last Used Date/Time"},"pwdLockRvcmnId":{"type":"string","description":"Unlock Processor"},"pwdLockRvcDtm":{"type":"string","format":"date-time","description":"Unlock Processing Date/Time"},"pwdCntnFailCnt":{"type":"integer","format":"int64","description":"Consecutive Password Failure Count"},"lstPwdChgDtm":{"type":"string","format":"date-time","description":"Last Password Change Date/Time"},"pwdLockYn":{"type":"string","description":"Password Locked Status"},"pwdIniYn":{"type":"string","description":"Password Reset Status"},"userIpAddr":{"type":"string","description":"Allowed Access IP"}}},"PrivacyPolicyInfo":{"type":"object","description":"Personal Information Handling Authorization DTO","properties":{"userId":{"type":"string","description":"User ID"},"indInfoGbCd":{"type":"string","description":"Personal Information Type Code (UR008)"},"useYn":{"type":"string","description":"Usage Status"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/system/userMgmt/modifyUpdatePwdUnlock":{"get":{"tags":["User Information Management"],"summary":"Unlock Password","description":"## Function Description\n* Processes the unlocking of a locked password.\n---\n## Detailed Description\n* Unlocks the password for a user whose password is locked.\n* Resets the password failure count to 0.\n* Returns the updated user information.\n","operationId":"modifyUpdatePwdUnlock","parameters":[{"name":"userId","in":"query","description":"User ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserDetailResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve User Authorization Group List
> \## Function Description\
> \* Retrieves the permission group list according to the conditions selected on the screen.\
> \---\
> \## Detailed Description\
> \* Retrieves the permission group list according to the conditions selected on the screen.\
> \---\
> \## Revision History\
> \* Release v2.00\_240927 : New creation of user permission group list inquiry v2
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UserRightGroupRequest":{"type":"object","description":"Permission Group Retrieval Request DTO","properties":{"sysGbCd":{"type":"string","description":"System Type Code (UR005)"},"rtGrpNo":{"type":"string","description":"Permission Group No."},"rtGrpNm":{"type":"string","description":"Permission Group Name"},"argSelectType":{"type":"string","description":"Selection Type"}}},"RealGridListResponseUserRightGroupResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/UserRightGroupResponse"}}}},"UserRightGroupResponse":{"type":"object","description":"Permission Group Information Response DTO","properties":{"rtGrpNo":{"type":"string","description":"Authorization Group No."},"sysGbNm":{"type":"string","description":"System Classification Name"},"rtGrpNm":{"type":"string","description":"Authorization Group Name"},"sysGbCd":{"type":"string","description":"System Classification Code (UR005)"},"aplyStrDt":{"type":"string","description":"Application Start Date"},"aplyEndDt":{"type":"string","description":"Application End Date"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/system/userMgmt/getUserRightGroupInfo":{"get":{"tags":["User Information Management"],"summary":"Retrieve User Authorization Group List","description":"## Function Description\n* Retrieves the permission group list according to the conditions selected on the screen.\n---\n## Detailed Description\n* Retrieves the permission group list according to the conditions selected on the screen.\n---\n## Revision History\n* Release v2.00_240927 : New creation of user permission group list inquiry v2\n","operationId":"getUserRightGroupInfo","parameters":[{"name":"userRightGroupRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/UserRightGroupRequest"}},{"name":"sysGbCd","in":"query","description":"System Type Code","schema":{"type":"string"}},{"name":"rtGrpNm","in":"query","description":"Permission Group Name","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseUserRightGroupResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve User Details
> \## Function Description\
> \* Retrieves user information.\
> \---\
> \## Detailed Description\
> \* Retrieves the information of the currently logged-in user.\
> \* Retrieves the personal information handling permission of the currently logged-in user.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ResponseUserDetailResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"$ref":"#/components/schemas/UserDetailResponse","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"UserDetailResponse":{"type":"object","description":"User Information Response DTO","properties":{"userInfo":{"$ref":"#/components/schemas/StUserBase","description":"User Information"},"individualInfoRightList":{"type":"array","description":"Personal Data Handling Permission","items":{"$ref":"#/components/schemas/PrivacyPolicyInfo"}}}},"StUserBase":{"type":"object","description":"User Information Entity","properties":{"userId":{"type":"string","description":"User ID"},"userGbCd":{"type":"string","description":"User Type Code (UR001)"},"deptCd":{"type":"string","description":"Department Code"},"deptNm":{"type":"string","description":"Department Name"},"entrNo":{"type":"string","description":"Vendor No."},"entrNm":{"type":"string","description":"Vendor Name"},"userNm":{"type":"string","description":"User Name"},"pwd":{"type":"string","description":"Password"},"sysGbCd":{"type":"string","description":"System Group No."},"rtGrpNo":{"type":"string","description":"Permission Group No."},"rtGrpNm":{"type":"string","description":"Permission Group Name"},"useYn":{"type":"string","description":"Usage Status"},"telRgnNo":{"type":"string","description":"Phone Area Code"},"telTxnoNo":{"type":"string","description":"Phone Exchange Number"},"telEndNo":{"type":"string","description":"Phone Subscriber Number"},"cellSctNo":{"type":"string","description":"Mobile Carrier Code"},"cellTxnoNo":{"type":"string","description":"Mobile Exchange Number"},"cellEndNo":{"type":"string","description":"Mobile Subscriber Number"},"emailAddr":{"type":"string","description":"Email Address"},"indInfoDealYn":{"type":"string","description":"Personal Information Handling Status"},"indInfoDealCausCont":{"type":"string","description":"Personal Data Handling Reason Content"},"empNo":{"type":"string","description":"Employee No."},"jobGrpCd":{"type":"string","description":"Task Group Code (UR002)","enum":["SYSTEM_MANAGER","MD","MARKETING","LGST_CNTR","CUST_CNTR","COOP_CORP","AFCR"]},"ocpCd":{"type":"string","description":"Position Code (UR003)"},"workStatCd":{"type":"string","description":"Employment Status Code (UR004)"},"atchFileRouteNm":{"type":"string","description":"Attachment File Path Name (Currently Unused)"},"atchFileNm":{"type":"string","description":"Attachment File Name (Currently Unused)"},"useStrtDt":{"type":"string","description":"Usage Start Date"},"useEndDt":{"type":"string","description":"Usage End Date"},"cnslEntpNm":{"type":"string","description":"Consultation Company Name"},"itelNo":{"type":"string","description":"Extension Number"},"ctiNo":{"type":"string","description":"CTI No."},"rcntUseDtm":{"type":"string","format":"date-time","description":"Last Used Date/Time"},"pwdLockRvcmnId":{"type":"string","description":"Unlock Processor"},"pwdLockRvcDtm":{"type":"string","format":"date-time","description":"Unlock Processing Date/Time"},"pwdCntnFailCnt":{"type":"integer","format":"int64","description":"Consecutive Password Failure Count"},"lstPwdChgDtm":{"type":"string","format":"date-time","description":"Last Password Change Date/Time"},"pwdLockYn":{"type":"string","description":"Password Locked Status"},"pwdIniYn":{"type":"string","description":"Password Reset Status"},"userIpAddr":{"type":"string","description":"Allowed Access IP"}}},"PrivacyPolicyInfo":{"type":"object","description":"Personal Information Handling Authorization DTO","properties":{"userId":{"type":"string","description":"User ID"},"indInfoGbCd":{"type":"string","description":"Personal Information Type Code (UR008)"},"useYn":{"type":"string","description":"Usage Status"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v2/system/userMgmt/detail":{"get":{"tags":["User Information Management"],"summary":"Retrieve User Details","description":"## Function Description\n* Retrieves user information.\n---\n## Detailed Description\n* Retrieves the information of the currently logged-in user.\n* Retrieves the personal information handling permission of the currently logged-in user.\n","operationId":"getUserDetail","parameters":[{"name":"userId","in":"query","description":"User ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseUserDetailResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Check Duplicate User ID
> \## Function Description\
> \* Retrieves the count of user IDs.\
> \---\
> \## Detailed Description\
> \* Compares the parameter value against the currently saved user IDs and returns the matching count.\
> \* Used to check for duplicate IDs.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ResponseInteger":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"integer","format":"int32","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v2/system/userMgmt/check":{"get":{"tags":["User Information Management"],"summary":"Check Duplicate User ID","description":"## Function Description\n* Retrieves the count of user IDs.\n---\n## Detailed Description\n* Compares the parameter value against the currently saved user IDs and returns the matching count.\n* Used to check for duplicate IDs.\n","operationId":"getCheckUserId","parameters":[{"name":"userId","in":"query","description":"User ID","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseInteger"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve User Permission Group List Count
> \## Function Description\
> \* Retrieves the permission group list count according to the conditions selected on the screen.\
> \---\
> \## Detailed Description\
> \* Retrieves the permission group list count according to the conditions selected on the screen.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UserRightGroupRequest":{"type":"object","description":"Permission Group Retrieval Request DTO","properties":{"sysGbCd":{"type":"string","description":"System Type Code (UR005)"},"rtGrpNo":{"type":"string","description":"Permission Group No."},"rtGrpNm":{"type":"string","description":"Permission Group Name"},"argSelectType":{"type":"string","description":"Selection Type"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/userMgmt/getUserRightGroupListCount":{"get":{"tags":["User Information Management"],"summary":"Retrieve User Permission Group List Count","description":"## Function Description\n* Retrieves the permission group list count according to the conditions selected on the screen.\n---\n## Detailed Description\n* Retrieves the permission group list count according to the conditions selected on the screen.\n","operationId":"getUserRightGroupListCount","parameters":[{"name":"userRightGroupRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/UserRightGroupRequest"}},{"name":"sysGbCd","in":"query","description":"System Type Code","schema":{"type":"string"}},{"name":"rtGrpNm","in":"query","description":"Permission Group Name","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"integer","format":"int32"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve User Authorization Group List
> \## Function Description\
> \* Retrieves the permission group list according to the conditions selected on the screen.\
> \---\
> \## Detailed Description\
> \* Retrieves the permission group list according to the conditions selected on the screen.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UserRightGroupRequest":{"type":"object","description":"Permission Group Retrieval Request DTO","properties":{"sysGbCd":{"type":"string","description":"System Type Code (UR005)"},"rtGrpNo":{"type":"string","description":"Permission Group No."},"rtGrpNm":{"type":"string","description":"Permission Group Name"},"argSelectType":{"type":"string","description":"Selection Type"}}},"UserRightGroupResponse":{"type":"object","description":"Permission Group Information Response DTO","properties":{"rtGrpNo":{"type":"string","description":"Authorization Group No."},"sysGbNm":{"type":"string","description":"System Classification Name"},"rtGrpNm":{"type":"string","description":"Authorization Group Name"},"sysGbCd":{"type":"string","description":"System Classification Code (UR005)"},"aplyStrDt":{"type":"string","description":"Application Start Date"},"aplyEndDt":{"type":"string","description":"Application End Date"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/userMgmt/getUserRightGroupInfo":{"get":{"tags":["User Information Management"],"summary":"Retrieve User Authorization Group List","description":"## Function Description\n* Retrieves the permission group list according to the conditions selected on the screen.\n---\n## Detailed Description\n* Retrieves the permission group list according to the conditions selected on the screen.\n","operationId":"getUserRightGroupInfo_1","parameters":[{"name":"userRightGroupRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/UserRightGroupRequest"}},{"name":"sysGbCd","in":"query","description":"System Type Code","schema":{"type":"string"}},{"name":"rtGrpNm","in":"query","description":"Permission Group Name","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserRightGroupResponse"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve User List Count
> \## Function Description\
> \* Retrieves the user list count according to the conditions selected on the screen.\
> \---\
> \## Detailed Description\
> \* Retrieves the user list count according to the conditions selected on the screen.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UserListRequest":{"type":"object","description":"User Information Management Request DTO","properties":{"jobGrpCd":{"type":"string","description":"Work Group Code","enum":["SYSTEM_MANAGER","MD","MARKETING","LGST_CNTR","CUST_CNTR","COOP_CORP","AFCR"]},"userId":{"type":"string","description":"User ID"},"userNm":{"type":"string","description":"User ID"},"sysGbCd":{"type":"string","description":"System Type Code (UR005)"},"useYn":{"type":"string","description":"Usage Status"},"userInfoSearchTgt":{"type":"string","description":"User Information Search Type"},"userInfo":{"type":"string","description":"User Information (Name or ID)"},"workStatCd":{"type":"string","description":"Work Status Code (UR004)"},"indInfoDealYn":{"type":"string","description":"Personal Information Handling Status"},"pwdLockYn":{"type":"string","description":"Account Lock Status"},"rtGrpNo":{"type":"string","description":"Permission Group No."}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/userMgmt/getUserListInUserMenuCount":{"get":{"tags":["User Information Management"],"summary":"Retrieve User List Count","description":"## Function Description\n* Retrieves the user list count according to the conditions selected on the screen.\n---\n## Detailed Description\n* Retrieves the user list count according to the conditions selected on the screen.\n","operationId":"getUserListInUserMenuCount","parameters":[{"name":"userListRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/UserListRequest"}},{"name":"sysGbCd","in":"query","description":"System Classification Code","schema":{"type":"string"}},{"name":"jobGrpCd","in":"query","description":"Work Group Code","schema":{"type":"string"}},{"name":"userInfoSearchTgt","in":"query","description":"User Information Search Type","schema":{"type":"string"}},{"name":"userInfo","in":"query","description":"User Information (Name or ID)","schema":{"type":"string"}},{"name":"useYn","in":"query","description":"Usage Status","schema":{"type":"string"}},{"name":"workStatCd","in":"query","description":"Department Code","schema":{"type":"string"}},{"name":"indInfoDealYn","in":"query","description":"Work Status Code","schema":{"type":"string"}},{"name":"pwdLockYn","in":"query","description":"Account Lock Status","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"integer","format":"int32"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve User Personal Data Handling Permission
> \## Function Description\
> \* Retrieves the user's personal data handling permission list.\
> \---\
> \## Detailed Description\
> \* Retrieves the personal data handling permission list of the currently logged-in user.\
> \* Retrieves the list where the usage status is Y.\
> \--\
> \## Revision History\
> \* Release v2.00\_240912: Initial development
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PrivacyPolicyInfoV2":{"type":"object","description":"Personal Information Handling Authorization DTO","properties":{"userId":{"type":"string","description":"User ID"},"indInfoGbCd":{"type":"string","description":"Personal Information Type Code (UR008)"},"useYn":{"type":"string","description":"Usage Status"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/userMgmt/getIndividualInfoRightList":{"get":{"tags":["User Information Management"],"summary":"Retrieve User Personal Data Handling Permission","description":"## Function Description\n* Retrieves the user's personal data handling permission list.\n---\n## Detailed Description\n* Retrieves the personal data handling permission list of the currently logged-in user.\n* Retrieves the list where the usage status is Y.\n--\n## Revision History\n* Release v2.00_240912: Initial development\n","operationId":"getIndividualInfoRightList","responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PrivacyPolicyInfoV2"}}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```