Get Users Role List¶

Get the roles of users in batch. You can request up to 1000 users at one time.

Prerequisites¶

The application has been granted the permission “Obtain all user permissions in the OU”. Contact the OU administrator to get the permission if necessary.

Request Format¶

POST https://{apigw-address}/app-portal-service/v2.2/userRoles/roleList

Request Parameters (Body)¶

Name	Required/Optional	Data Type	Description
organizationId	Required	String	The OU ID. How to get organizationId >>
userIds	Required	List	The list of user IDs, supporting up to 1000 IDs. How to get userId >>

Response Parameters¶

Name	Data Type	Description
usersUserRoles	UsersUserRolesDTO Struct	The information about users and their corresponding roles. UsersUserRolesDTO Struct >>
userRoles	UsersRolesInfoDTO Struct	The role information. UsersRolesInfoDTO Struct >>

UsersUserRolesDTO Struct¶

Name	Data Type	Description
userId	String	The user ID.
roleIds	List	The list of role IDs.

UsersRolesInfoDTO Struct¶

Name	Data Type	Description
id	String	The role ID.
name	String	The role name.

Error Codes¶

Code	Description
31400	Errors such as incorrect parameters, empty parameters, character limits exceeded, and so on.
31403	The application has not been granted the “Obtain all user permissions in the OU” permission.
31404	OU not found.

Samples¶

Request Sample¶

url: https://{apigw-address}/app-portal-service/v2.2/userRoles/roleList

method: POST

requestBody:
{"organizationId":"yourOrgId","userIds": ["user1","user2","user3"]}

Return Sample¶

{
    "code": 0,
    "message": "OK",
    "data": {
        "usersUserRoles": [
            {
                "userId": "your_user_id_1",
                "roleIds": [
                    "your_role_id_1",
                    "your_role_id_2",
                    "your_role_id_3",
                    "your_role_id_4",
                    "your_role_id_5"
                ]
            },
            {
                "userId": "your_user_id_2",
                "roleIds": []
            }
        ],
        "userRoles": [
            {
                "id": "your_role_id_1",
                "name": "your_role_name_1"
            },
            {
                "id": "your_role_id_2",
                "name": "your_role_name_2"
            },
            {
                "id": "your_role_id_3",
                "name": "your_role_name_3"
            },
            {
                "id": "your_role_id_4",
                "name": "your_role_name_4"
            },
            {
                "id": "your_role_id_5",
                "name": "your_role_name_5"
            }
        ]
    }
}