Role information

This endpoint retrieves the details of a role, allowing you to see the permissions contained within it.

Endpoint

GET /user/v1/roles/{role}

Parameters

Name	Location	Required	Type	Default value	Description
role	URL	Yes	String		The role you want details on

Response

A Role object.

Example Request

GET /user/v1/roles/CLIENTNMS_WEBSERVICE_DNS_RW

Example Response

{
    "message": "OK",
    "data": {
        "id": "CLIENTNMS_WEBSERVICE_DNS_RW",
        "description": "Read-write access to the DNS Zones management API",
        "permissions": [
            {
                "id": "API_DNS",
                "description": "DNS API (read only)"
            },
            {
                "id": "API_DNS_WRITE",
                "description": "DNS API (management)"
            },
            {
                "id": "WEBSERVICES_REST",
                "description": "REST API access"
            }
        ]
    }
}