List all system roles

GET

/api/v1/system-roles

const url = 'http://localhost:3000/api/v1/system-roles?role=SUPERUSER';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:3000/api/v1/system-roles?role=SUPERUSER' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer

Parameters

Query Parameters

userId

string

Filter by user ID

role

string

Allowed values: SUPERUSER SUPPORT

Filter by role type

activeOnly

boolean

Filter by active status

limit

number

Number of items to return

offset

number

Number of items to skip

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

200

application/json

object

items

required

List of system roles

Array<object>

object

required

System role record ID

string

userId

required

User ID who has this role

string

userEmail

required

User email

string

userName

User name

string

role

required

Role type

string

Allowed values: SUPERUSER SUPPORT

grantedAt

required

When the role was granted

string format: date-time

grantedById

User ID who granted the role (null if granter was deleted)

string

grantedByEmail

Email of user who granted the role (null if granter was deleted)

string

reason

Reason for granting

string

revokedAt

When the role was revoked (null if active)

string format: date-time

revokedById

User ID who revoked the role

string

revokedByEmail

Email of user who revoked the role

string

isActive

required

Whether the role is currently active

boolean

total

required

Total count

number

hasMore

required

Whether there are more items

boolean

Example

{
  "items": [
    {
      "role": "SUPERUSER"
    }
  ]
}