IDaaS Open Platform
Employee Identity (EIAM)

Query Application-side Role Member List

API

# Permissions

The Identity Management API is authorized on an application dimension. Before calling an interface, you need to set API permissions for different applications. For details, please refer to API Permissions.

Permission Code Description
app_role_read Read permission for application-side role interfaces
read Permission for all read interfaces
all Full read and write permission for all interfaces

# Request Specification

GET https://{your_domain}/api/v2/tenant/applications/{app_id}/role-member-list/{role_id}?offset=0&limit=10

# Request Headers

Parameter Name Chinese Name Required Type Description
Authorization Authorization Yes String Format: Bearer {access_token}
Content-Type Content-Type Yes String Fixed value: application/json; charset=utf-8

# Request Example

None

# Request Parameters

Parameter Name Chinese Name Required Type Description
app_id Application ID Yes String Target application ID
role_id Role ID Yes String Target role ID
offset Page Number Yes Int Starts from page 0
limit Items Per Page Yes Int Items per page, between 1 and 50

# Return Example

Correct Example:
HTTP/1.1 200 OK
{
    "total": 1,
    "offset": 0,
    "limit": 10,
    "role_members": [
        {
            "id": "20220415171558023-84A4-ED5C390B8",
            "account_name": "test1",
            "name": null,
            "org_id": "20220414152016409-6146-2B006A262",
            "disabled": false,
            "account_type": "PUBLIC_ACCOUNT",
            "extension": {}
        }
    ]
}


Error Example:
HTTP/1.1 400 Bad Request
{
    "error_code": " APP.ROLE.0002",
    "error_msg": "Application-side role does not exist"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

# Return Parameters

Parameter Name Chinese Name Type Description
total Total Count Int
offset Page Number Int
limit Page Size Int
role_members Role Collection List
--id Application Account ID String
--account_name Application Account String
--name Application Account Name String
--org_id Application Organization ID String
--disabled Disabled Status Boolean
--account_type Application Account Type String
-- extension Extension Attributes Object

# Error Codes

Status Code Error Code Error Message Action
400 APP.ROLE.0002 Application-side role does not exist Please check if the application-side role has been deleted
The application side role does not exist
400 APP.OBJECTMODEL.0006 Application role model is not enabled Please check if the application role model is enabled
The application role model is not opened
400 APP.0001 Application does not exist Please check if the application has been deleted
App does not exist

Send Internal Notification