List roles

GET /v1/security/roles

Query parameters

  • filter string

    Return only roles whose names match this substring

  • principal string

    Return only roles which are assigned to this user

  • principal_type string

    Applies to principal parameter. Ignored if principal is not set

    Value is User.

Responses

  • 200 application/json

    OK

    Hide response attribute Show response attribute object
    • roles array[object]
      Hide roles attribute Show roles attribute object
      • name string
GET /v1/security/roles 
curl \
 --request GET 'http://localhost:9644/v1/security/roles'
Response examples (200) 
{
  "roles": [
    {
      "name": "string"
    }
  ]
}