Roles

List roles

GET/v1/organization/membership/roles

curl --request GET \
  --url https://api.serverside.com/v1/organization/membership/roles \
  --header 'X-API-KEY: <api-key>'

{
  "success": true,
  "message": "<string>",
  "exception": "<string>",
  "code": "<string>",
  "errors": {},
  "traceId": "<string>",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "permissions": [
        "<string>"
      ]
    }
  ],
  "pagination": {
    "totalRecords": 123,
    "currentPage": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

Autorisations

X-API-KEYstringheaderobligatoire
Organization API key. Create one in the cloud console at https://cloud.serverside.com; the key is shown once, when it is created.

Paramètres de requête

searchstring
filterobject
pageinteger<int32>
Limites :x >= 1
page_sizeinteger<int32>
Limites :1 <= x <= 1000
sort_columnstring
ascendingboolean
custom_roles_onlyboolean
Par défaut :false

Réponse

200 · application/json

OK

successboolean
messagestring | null
exceptionstring | null
codestring | null
errorsobject | null
traceIdstring | null
dataobject[] | null
paginationobject