Skip to main content
POST
Geteilte Benutzer sind die Teammitglieder, die Sie in Ihr Scanova-Konto einladen — dieselbe Liste, die in der Benutzer-Tabelle des Dashboards angezeigt wird. Mit diesem Endpunkt können Sie sie programmatisch auflisten, einladen, aktualisieren oder entfernen.
Dieser Endpunkt war bisher nicht dokumentiert. Er erfordert einen Management-API-Schlüssel mit MANAGEMENT_API- (oder MANAGEMENT_API_SANDBOX-)Quota, gesendet als roher Authorization-Header-Wert — siehe die Management-API-Übersicht — sowie die eigene Team-Quota des Kontos für geteilte Benutzer. Was jede Rolle tatsächlich gewährt, erfahren Sie unter Rollen & Berechtigungen; das Wire-Format der Rollen selbst finden Sie unter Rollen (Zugriffsebenen).
string
erforderlich
E-Mail-Adresse für das neue Teammitglied. Darf noch keinem anderen Scanova-Benutzer gehören — ein Duplikat gibt einen 400-Fehler mit {"email": ["Email address is already used."]} zurück.
string
erforderlich
Anzeigename, bis zu 20 Zeichen.
integer
erforderlich
ID einer Rolle aus GET /multi-users/access-levels/ — entweder eine Standard-Systemrolle oder eine benutzerdefinierte Rolle, die dieses Konto erstellt hat.
array
Tag-IDs, auf die der Zugriff dieses Benutzers beschränkt werden soll. Erfordert die CUSTOM_TAG-/Tag-Berechtigungs-Quota des Kontos — andernfalls mit 403 abgelehnt.
boolean
Standard:"false"
Beschränkt die für diesen Benutzer sichtbaren QR-Codes auf tags.
boolean
Standard:"true"
Wenn enable_tag_permission wahr ist: ob nicht getaggte QR-Codes weiterhin sichtbar sind.
Das Einladen eines Teammitglieds sendet immer eine Einladungs-E-Mail — das Erstellen des Datensatzes hier hat denselben Effekt wie das Klicken auf Benutzer einladen in der Benutzer-Tabelle des Dashboards. Es gibt keine Möglichkeit, die E-Mail über diesen Endpunkt zu überspringen.

Verwandte Themen

Autorisierungen

Authorization
string
header
erforderlich

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.

Body

application/json
email
string<email>
erforderlich
name
string
erforderlich
Maximum string length: 20
access_level
integer
erforderlich

Role ID from GET /multi-users/access-levels/.

tags
integer[]
enable_tag_permission
boolean
Standard:false
include_untagged
boolean
Standard:true

Antwort

201 - application/json

Invitation created — sends an invitation email to the shared user.