Aller au contenu

API de gestion

Utilisez des clés API à portée limitée pour gérer les ressources de l'organisation depuis votre serveur.

Afficher en Markdown

Authentification

Les appels à la Management API utilisent Authorization: Bearer sk_live_* ou Authorization: Bearer sk_test_*. Les clés sont limitées au Tenant résolu. Les ressources Organization vérifient également que l’Organization demandée appartient à ce Tenant.

curl https://xid.dev/v1/users \
  -H 'Authorization: Bearer sk_live_xxx'

Ressources

Ressource Capacités Statut
/v1/users Créer, lire, mettre à jour, suspendre, réactiver, exporter et supprimer des utilisateurs. Implémenté
/v1/organizations Gérer les organisations, domaines, marque et paramètres. Implémenté
/v1/organizations/:orgId/memberships Lister, créer, mettre à jour le rôle et supprimer des membres. Implémenté
/v1/organizations/:orgId/invitations Créer (avec limite de lot), révoquer et lister les invitations. Implémenté
/v1/sessions Lister, obtenir et révoquer les sessions utilisateur. Implémenté
/v1/applications Enregistrer des clients OAuth, des URI de redirection, des autorisations, la politique de jetons et les secrets. Implémenté
/v1/connections Gerer les connexions SSO entreprise upstream. Implémenté
/v1/directories Créer des annuaires SCIM et renouveler les jetons d’annuaire. Implémenté
/v1/roles Créer, lire, mettre à jour et supprimer des rôles personnalisés. Implémenté
/v1/permissions Créer, lire, mettre à jour et supprimer des permissions. Implémenté
/v1/project-grants Créer, lister, consulter, révoquer et supprimer des autorisations de projet. Implémenté
/v1/user-grants Attribuez, répertoriez, obtenez, révoquez et supprimez les autorisations d’utilisateur limitées. Implémenté
/v1/organizations/:orgId/domains Répertoriez, créez et supprimez des domaines d’organisation. Implémenté
/v1/organizations/:orgId/custom-hostnames Créez, inspectez, actualisez et supprimez des noms d’hôte personnalisés. Implémenté
/v1/organizations/:orgId/audit-events Consulter les événements d’audit de l’organisation avec une pagination par curseur. Implémenté
/v1/webhooks Créer, lister, mettre à jour et supprimer des points de terminaison webhook. Implémenté
/v1/api-keys Créer, lister et révoquer les clés API de l’organisation. Implémenté
/v1/organizations/:orgId/scim-targets Créez, mettez à jour, synchronisez et supprimez les cibles SCIM sortantes. Implémenté

Pagination et erreurs

Les points de terminaison de liste renvoient un tableau de données et des métadonnées de curseur. Les erreurs utilisent du JSON structuré avec un code stable, un message lisible et des métadonnées facultatives pour la validation des champs.

Navigation

Saisissez votre recherche...

Utilisez les touches fléchées pour naviguerAppuyez sur Entrée pour sélectionnerAppuyez sur Échap pour fermer