Passer au contenu principal
GET
/
v1
/
users
/
roles
/
{id}
Get user role
curl --request GET \
  --url https://api.hyperline.co/v1/users/roles/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "rol_DKL4Xcb5VSa8CQ",
  "name": "Admin",
  "description": null,
  "is_default": false
}

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id
string
requis

Réponse

id
string
requis

Role ID.

Exemple:

"rol_DKL4Xcb5VSa8CQ"

name
string
requis

Role name.

Exemple:

"Admin"

description
string | null
requis

Role description.

Exemple:

null

is_default
boolean
requis

Whether this is the default role assigned to new users.

Exemple:

false