For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Skip to navigation

Sare Core API Identity

List Roles

||View as Markdown|

GET

http://localhost:8080/api/v3/roles

GET

/api/v3/roles

curl -G http://localhost:8080/api/v3/roles \
     -H "Authorization: Bearer {{accessToken}}" \
     -d name=SALES_AGENT \
     -d page=0 \
     -d size=20

200Identity_listRoles_example

{
  "code": 200,
  "message": "Roles",
  "data": {
    "content": [
      {
        "id": "e4c0c3d4-6b7a-4c8d-9e0f-1a2b3c4d5e6f",
        "name": "SALES_AGENT",
        "description": "Handles field sales",
        "permissions": [
          {
            "id": "c2f8a1b2-3c4d-4e5f-8a9b-0c1d2e3f4a5b",
            "name": "users:read"
          }
        ]
      }
    ],
    "pageNumber": 1,
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "isLastPage": true
  }
}

Headers

AuthorizationstringOptional

Query parameters

namestringOptional

pageintegerOptional

sizeintegerOptional

Response

200 OK

codeintegerOptional

messagestringOptional

dataobjectOptional

Was this page helpful?

Get App Version

Sare Core API