Lister les rôles

curl --request GET \
  --url 'https://management.scanova.io/multi-users/access-levels/' \
  --header 'Authorization: YOUR_API_KEY'

{
  "count": 6,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 3,
      "name": "Viewer",
      "slug": "viewer",
      "permissions": [
        {
          "id": 23,
          "code": "QR_CODE_CAN_VIEW",
          "name": "Can view QR Code",
          "description": "Allows viewing QR code details.",
          "is_boolean": true
        }
      ],
      "is_custom": false
    },
    {
      "id": 4,
      "name": "Analyst",
      "slug": "analyst",
      "permissions": ["..."],
      "is_custom": false
    },
    {
      "id": 5,
      "name": "Billing Manager",
      "slug": "billing-manager",
      "permissions": ["..."],
      "is_custom": false
    },
    {
      "id": 6,
      "name": "Manager",
      "slug": "manager",
      "permissions": ["..."],
      "is_custom": false
    },
    {
      "id": 7,
      "name": "Admin",
      "slug": "admin",
      "permissions": ["..."],
      "is_custom": false
    },
    {
      "id": 8,
      "name": "Full Access",
      "slug": "full-access",
      "permissions": ["..."],
      "is_custom": false
    }
  ]
}

GET

multi-users

access-levels

curl --request GET \
  --url 'https://management.scanova.io/multi-users/access-levels/' \
  --header 'Authorization: YOUR_API_KEY'

{
  "count": 6,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 3,
      "name": "Viewer",
      "slug": "viewer",
      "permissions": [
        {
          "id": 23,
          "code": "QR_CODE_CAN_VIEW",
          "name": "Can view QR Code",
          "description": "Allows viewing QR code details.",
          "is_boolean": true
        }
      ],
      "is_custom": false
    },
    {
      "id": 4,
      "name": "Analyst",
      "slug": "analyst",
      "permissions": ["..."],
      "is_custom": false
    },
    {
      "id": 5,
      "name": "Billing Manager",
      "slug": "billing-manager",
      "permissions": ["..."],
      "is_custom": false
    },
    {
      "id": 6,
      "name": "Manager",
      "slug": "manager",
      "permissions": ["..."],
      "is_custom": false
    },
    {
      "id": 7,
      "name": "Admin",
      "slug": "admin",
      "permissions": ["..."],
      "is_custom": false
    },
    {
      "id": 8,
      "name": "Full Access",
      "slug": "full-access",
      "permissions": ["..."],
      "is_custom": false
    }
  ]
}

Chaque utilisateur partagé se voit attribuer un rôle — le tableau de bord de Scanova appelle cela en interne des « access levels » (niveaux d’accès), et ce même terme apparaît tout au long de cet endpoint. Utilisez cet endpoint pour consulter les rôles disponibles avant d’inviter un coéquipier via POST /multi-users/, ou pour créer un rôle personnalisé depuis vos propres systèmes.

Cet endpoint n’était pas documenté auparavant. Il nécessite une clé Management API avec le quota MANAGEMENT_API (ou MANAGEMENT_API_SANDBOX) — voir la vue d’ensemble de la Management API. Pour ce que chaque rôle accorde réellement à un coéquipier, voir le guide destiné aux utilisateurs Rôles et permissions — cette page ne documente que le format d’échange (wire format).

curl --request GET \
  --url 'https://management.scanova.io/multi-users/access-levels/' \
  --header 'Authorization: YOUR_API_KEY'

{
  "count": 6,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 3,
      "name": "Viewer",
      "slug": "viewer",
      "permissions": [
        {
          "id": 23,
          "code": "QR_CODE_CAN_VIEW",
          "name": "Can view QR Code",
          "description": "Allows viewing QR code details.",
          "is_boolean": true
        }
      ],
      "is_custom": false
    },
    {
      "id": 4,
      "name": "Analyst",
      "slug": "analyst",
      "permissions": ["..."],
      "is_custom": false
    },
    {
      "id": 5,
      "name": "Billing Manager",
      "slug": "billing-manager",
      "permissions": ["..."],
      "is_custom": false
    },
    {
      "id": 6,
      "name": "Manager",
      "slug": "manager",
      "permissions": ["..."],
      "is_custom": false
    },
    {
      "id": 7,
      "name": "Admin",
      "slug": "admin",
      "permissions": ["..."],
      "is_custom": false
    },
    {
      "id": 8,
      "name": "Full Access",
      "slug": "full-access",
      "permissions": ["..."],
      "is_custom": false
    }
  ]
}

Vérifié en conditions réelles : un compte tout juste créé renvoie exactement ces 6 rôles système (Viewer, Analyst, Billing Manager, Manager, Admin, Full Access) — correspondant au sélecteur Rôles et permissions du tiroir Invite Users du tableau de bord. Les IDs montrés ci-dessus sont indicatifs ; les tableaux de permissions sont tronqués par souci de concision dans cet exemple — une réponse réelle inclut chaque permission accordée par le rôle, en intégralité.

Les résultats sont paginés (taille de page 10 par défaut) et peuvent inclure des rôles personnalisés créés par le compte, en plus des 6 rôles système par défaut.

string

Filtrer sur system (les rôles intégrés, user est nul sur ceux-ci) ou custom (rôles créés par ce compte).

string

Correspondance de sous-chaîne par rapport au nom du rôle.

string

name ou -name.

Champs de réponse (par rôle)

integer

ID du rôle — à transmettre comme access_level lors de l’invitation ou de la mise à jour d’un utilisateur partagé.

string

Nom affiché du rôle, par ex. Manager.

string | null

Slug stable pour les rôles système (par ex. manager) ; null pour les rôles personnalisés.

boolean

false pour les 6 rôles système intégrés, true pour un rôle créé par ce compte lui-même.

array

Chaque permission accordée par ce rôle.

Afficher propriétés de permission

integer

ID de la permission — à transmettre dans permissions lors de la création d’un rôle personnalisé ci-dessous.

string

Code de permission stable, par ex. QR_CODE_CAN_VIEW.

string

Nom de permission lisible.

string

Description plus détaillée de ce que permet cette permission.

boolean

Indique si cette permission est un simple indicateur activé/désactivé (true) plutôt qu’un quota numérique.

Voir aussi

Créer un rôle personnalisé — l’autre opération de ce même endpoint.
Inviter un utilisateur partagé — attribuez un ID de rôle de cette liste lors de l’invitation ou de la mise à jour d’un coéquipier.
Mettre à jour un utilisateur partagé — attribuez un ID de rôle de cette liste lors de l’invitation ou de la mise à jour d’un coéquipier.
Rôles et permissions — l’explication destinée aux utilisateurs de ce que chaque rôle accorde, y compris la restriction de plan sur les rôles personnalisés.
Utilisateurs partagés — le tableau Users du tableau de bord où ces rôles sont attribués via l’interface.

Autorisations

Authorization

string

header

requis

Send your Management API key as the raw value of the Authorization header — no "Bearer " or "Token " prefix, and no other characters. Example: Authorization: 401f7ac837da42b97f613d789819ff93537bee6a. A header containing more than one space-separated part is rejected outright. Requests also require the request's Host header to be the management API host (e.g. management.scanova.io) — the same key sent to the regular API host will not authenticate.

Paramètres de requête

type

enum<string>

Options disponibles:

system,

custom

string

ordering

string

Réponse

200 - application/json

Paginated list of roles, each with its permission set.

Premiers pas

API de gestion — Jetons et utilisation

API de gestion — Codes QR

API de gestion — Dossiers et tags

API de gestion — Utilisateurs partagés et rôles

API de gestion — Prospects et formulaires

API de gestion — Analytique et forfaits

Champs de réponse (par rôle)

Voir aussi

Autorisations

Paramètres de requête

Réponse

​Champs de réponse (par rôle)

​Voir aussi

Autorisations

Paramètres de requête

Réponse

Champs de réponse (par rôle)

Voir aussi