Passer au contenu principal
POST
Créer une portée

Créer une portée

POST /v1/scopes Crée une portée de permission personnalisée pour le locataire authentifié. Les portées personnalisées étendent le registre de portées intégré avec des permissions spécifiques au locataire. La chaîne de portée est automatiquement composée à partir des champs resource et action au format resource:action. Les étendues personnalisées sont validées par rapport aux règles de format d’étendue MAIP : caractères alphanumériques, points, underscores, tirets et astérisques uniquement.
Les étendues personnalisées sont isolées par locataire. Elles n’apparaissent pas dans l’étendue des autres locataires registres. Les portées de plateforme intégrées ne peuvent pas être outrepassées ou dupliquées.

Authentification

Nécessite l’en-tête X-API-Key ou un jeton JWT Bearer. L’espace de travail est dérivé de l’identifiant authentifié ; n’envoyez pas X-Tenant-ID.

Réponse

string
UUID de la définition d’étendue nouvellement créée.
string
UUID du locataire propriétaire.
string
La chaîne de portée composée au format resource:action.
string
Le composant ressource.
string
Le composant d’action.
string
Nom de la portée lisible par l’homme.
string
Description de la portée.
string
Catégorie de portée.
boolean
Toujours false pour les étendues créées par le locataire.
string
Horodatage de création ISO 8601.

Exemple


Attribution de portées personnalisées aux agents

Après avoir créé une portée personnalisée, attribuez-la aux agents lors de l’enregistrement ou via la délégation :

Autorisations

X-API-Key
string
header
requis

Clé API pour l'authentification machine-à-machine

Corps

application/json
action
string
requis

Composant d'action de la portée (par exemple, "lire", "approuver", "*")

resource
string
requis

Composant de ressource de la portée (par exemple, "crm", "payment")

category
string

Catégorie organisationnelle (par défaut "custom")

description
string

Description détaillée de ce que le scope accorde

display_name
string

Nom lisible par l'homme pour la portée

Réponse

Portée créée

id
string<uuid>
tenant_id
string<uuid>
scope
string
resource
string
action
string
display_name
string
description
string
category
string
is_builtin
boolean
created_at
string<date-time>