List roles

GET /api/service/roles

List all the roles defined in Atlan.

Query parameters

  • limit integer(int32)

    Maximum number of records to be returned.

  • offset integer(int32)

    Starting point for records to return, for paging.

  • sort string

    Property by which to sort the records.

    Values are description or memberCount.

  • count boolean

    Whether to return the total count of records or not. If set to false both totalRecord and filterRecord will return 0.

    Default value is true.

  • filter object

    Filter data by specifying filters based on RQL

Responses

GET /api/service/roles 
curl \
 -X GET https://tenant.atlan.com/api/service/roles \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200) 
{
  "totalRecord": 3,
  "filterRecord": 3,
  "records": [
    {
      "id": "620172e0-81df-4d30-a8b3-f92a69badd04",
      "description": "Member",
      "name": "$member",
      "clientRole": false,
      "level": "workspace",
      "memberCount": "10"
    }
  ]
}