Retrieve Role Information

Paginated query of the list of roles created in the NineData system, supporting the retrieval of role ID, name, and type.

Request URL: /openapi/v1/role/list

Request Method: GET

Request Parameters

Parameter	Type	Required	Description	Example
current	Integer	No	Current page number, starting from 1, default is 1.	1
pageSize	Integer	No	Page size, default is 10.	10

Response Parameters

Parameter	Type	Description	Example
success	Boolean	Whether the request is successful.	true
data	Array	Role list, including the following fields: roleId: Role ID. name: Role name. type: Role type. Possible values: system: System administrator custom: Regular role	{ "roleId": "16", "name": "System Administrator", "type": "system" }
current	Integer	Current page number.	1
pageSize	Integer	Page size.	10
total	Integer	Total number of records.	2

Successful Invocation Example

{
    "success": true,
    "requestId": "Uz2t8YEJ-JPNMyCXnOLQk1DUdQKq3VFS",
    "data": [{
        "roleId": "16",
        "name": "System Administrator",
        "type": "system"
    }, {
        "roleId": "17",
        "name": "Regular Member",
        "type": "custom"
    }, {
        "roleId": "40",
        "name": "Production Environment Administrator",
        "type": "custom"
    }, {
        "roleId": "41",
        "name": "Production Environment Read-Only",
        "type": "custom"
    }, {
        "roleId": "42",
        "name": "Development Environment Administrator",
        "type": "custom"
    }, {
        "roleId": "160",
        "name": "Development Role",
        "type": "custom"
    }, {
        "roleId": "1259",
        "name": "A Business-DBA",
        "type": "custom"
    }, {
        "roleId": "1260",
        "name": "Security Auditor",
        "type": "custom"
    }, {
        "roleId": "1261",
        "name": "Test Role Permissions",
        "type": "custom"
    }, {
        "roleId": "1371",
        "name": "Test Role_new",
        "type": "custom"
    }],
    "current": 1,
    "pageSize": 10,
    "total": 16
}