Skip to main content

List roles

This endpoint lists the roles assigned to you, which you can also assign to other accesses.

Endpoint​

GET /user/v1/roles

Parameters​

This endpoint does not take any parameters

Response​

A RoleListResult object.

Example Request​

GET /user/v1/roles

Example Response​

{
    "message": "OK",
    "data": {
        "total": 4,
        "results": [
            {
                "id": "CLIENTNMS_WEBSERVICE_NDD_RW",
                "description": "Read-write access to the Domain name management API"
            },
            {
                "id": "CLIENTNMS_WEBSERVICE_DNS_RW",
                "description": "Read-write access to the DNS Zones management API"
            },
            {
                "id": "CLIENTNMS_WEBSERVICE_SSL_RW",
                "description": "Read-write access to the Certificates management API"
            },
            {
                "id": "CLIENTNMS_WEBSERVICE_EVENT_R",
                "description": "Read access to the Event retrieval API"
            }
        ]
    }
}