OpenAPI YAMLOpenAPI JSONproblèmes YAMLVue d’ensemble de l’API
Ce groupe compte 24 opérations, générées à partir de api/openapi.yaml. Filtrez par chemin, action ou authentification. Chaque point de terminaison liste ses entrées ; développez-le pour voir un modèle de requête et les codes de réponse. Les modèles demandent vos propres valeurs et un corps conforme au schéma.
Remplacez les espaces réservés en majuscules par vos valeurs. Pour une requête JSON, enregistrez un corps correspondant au schéma dans request.json. Les exemples de cookies utilisent un pot à cookies local issu d’une session authentifiée.
Provisionnement des utilisateurs : SCIM 2.0, jetons et liaisons de groupe
Tableau de bord Organisations Obtenir SCIM
Un administrateur désigné lit les paramètres de provisionnement SCIM de l’organisation : s’il est activé, l’URL de base à saisir chez le fournisseur d’identité (sur l’origine de l’API), les jetons de provisionnement actifs sans leurs secrets, et le nombre d’utilisateurs et de groupes provisionnés. Uniquement des personnes; les agents et les identifiants porteurs n’ont pas de route.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| org_id | chemin | obligatoire |
Modèle de requête et réponses
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/scim'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Les paramètres SCIM de l’organisation. | SCIMSettings (application/json); en-têtes : Cache-Control |
| 401 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 403 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Tableau de bord Organisations Définir SCIM
Un administrateur désigné active ou désactive le provisionnement SCIM après une preuve récente : une preuve par clé d’accès ou mot de passe liée à une réauthentification de kind scim_change avec l’ID de l’organisation comme subject_id, ou {type: sso} d’une session ouverte par authentification unique il y a 10 minutes au plus.
La désactivation ne change l’accès de personne : les personnes et les groupes déjà provisionnés conservent leurs droits, et les routes /scim/v2 répondent 403 jusqu’à ce que SCIM soit de nouveau activé. Renvoie les paramètres.
Uniquement des personnes ; les agents et les identifiants porteurs n’ont pas de route. enabled true relève du provisionnement SCIM, que le forfait Enterprise inclut ; une organisation dont le forfait n’inclut pas cette fonctionnalité est refusée avec feature_not_in_plan (402). enabled false est toujours accepté, et les points de terminaison /scim/v2 d’une organisation qui a activé SCIM continuent de répondre.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| org_id | chemin | obligatoire |
Champs du corps de la requête
| Champ | Description |
|---|---|
| activé (obligatoire, booléen) | |
| preuve (requise, DashboardProof) |
Modèle de requête et réponses
curl --request PUT --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/scim'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Les paramètres SCIM de l’organisation. | SCIMSettings (application/json); en-têtes : Cache-Control |
| 400 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 401 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 402 | feature_not_in_plan — Le provisionnement SCIM fait partie du forfait Enterprise ; le problème nomme la fonctionnalité, le forfait du compte et required_plan. | Problème (application/problem+json) |
| 403 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Tableau de bord Organisations Créer un jeton SCIM
Un administrateur désigné émet un jeton de provisionnement après une preuve récente (comme pour PUT .../scim). Le jeton, srscim_ suivi de 43 caractères base64url, est renvoyé une seule fois, ici seulement; le serveur conserve un condensé SHA-256 et un préfixe pour le reconnaître. Une organisation détient au plus 5 jetons actifs, sinon resource_conflict.
Uniquement des personnes ; les agents et les identifiants porteurs n’ont pas de route. L’émission d’un jeton relève du provisionnement SCIM, que le forfait Enterprise inclut ; une organisation dont le forfait n’inclut pas cette fonctionnalité est refusée avec feature_not_in_plan (402). Les jetons déjà émis continuent de fonctionner et peuvent être révoqués.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| org_id | chemin | obligatoire |
Champs du corps de la requête
| Champ | Description |
|---|---|
| nom (obligatoire, chaîne) | minLength : 1 maxLength : 80 |
| preuve (requise, DashboardProof) |
Modèle de requête et réponses
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/organizations/ORG_ID/scim/tokens'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 201 | Le nouveau jeton, avec son secret. | SCIMTokenCreated (application/json); en-têtes : Cache-Control |
| 400 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 401 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 402 | feature_not_in_plan — Le provisionnement SCIM fait partie du forfait Enterprise ; le problème nomme la fonctionnalité, le forfait du compte et required_plan. | Problème (application/problem+json) |
| 403 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 409 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Tableau de bord Organisations Révoquer un jeton SCIM
Un administrateur désigné révoque un jeton de provisionnement; les requêtes qui le présentent sont dès lors refusées avec 401. Un jeton déjà révoqué renvoie 204; un id que l’organisation ne détient pas est not_found. Uniquement des personnes; les agents et les identifiants porteurs n’ont pas de route.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| org_id | chemin | obligatoire | |
| token_id | chemin | obligatoire |
Modèle de requête et réponses
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/scim/tokens/TOKEN_ID'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 204 | Le jeton est révoqué. | pas de corps |
| 401 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 403 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 404 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Tableau de bord Organisations Lister les groupes SCIM
Un administrateur désigné liste les groupes que le fournisseur d’identité a provisionnés, avec leur nombre de membres et les projets auxquels chacun est lié. La liaison se fait dans le projet (createDashboardGroupBinding) par une personne qui peut y approuver; un administrateur ne voit que les liaisons et les noms de projet, ce qui ne donne aucun accès au projet.
Uniquement des personnes; les agents et les identifiants porteurs n’ont pas de route.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| org_id | chemin | obligatoire |
Modèle de requête et réponses
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/scim/groups'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Les groupes provisionnés de l’organisation. | SCIMGroupList (application/json); en-têtes : Cache-Control |
| 401 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 403 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Tableau de bord Organisations Lister les événements SCIM
Un administrateur désigné lit les 500 dernières requêtes faites par les clients SCIM de l’organisation, les plus récentes d’abord, échecs compris, conservées 30 jours. Chaque ligne nomme l’opération, la ressource et le statut, et porte un détail lorsque la requête a échoué. Uniquement des personnes; les agents et les identifiants porteurs n’ont pas de route.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| org_id | chemin | obligatoire |
Modèle de requête et réponses
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/scim/events'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Les derniers événements SCIM de l’organisation. | SCIMEventList (application/json); en-têtes : Cache-Control |
| 401 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 403 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Lister les liaisons de groupe du tableau de bord
Les liaisons de groupe du projet de la session, et les groupes que le fournisseur d’identité de son organisation a provisionnés (nom et nombre de membres) parmi lesquels choisir.
Une liaison donne à chaque membre du groupe une adhésion à ce projet : role member est une adhésion simple et role approver permet aussi à la personne d’approuver les révisions, pour le projet entier ou pour le screen_scope de la liaison. Une personne que plusieurs liaisons du projet atteignent détient l’union de leurs périmètres, et une liaison sans périmètre donne le projet entier.
La personne n’approuve les révisions que si l’union des périmètres de ses liaisons Approbateur (avec celui d’un droit d’approbation accordé à la main) couvre l’union complète de ses périmètres, et elle est simplement membre sinon; SCIM ne réduit jamais un droit accordé à la main : une liaison qui le ferait n’est pas appliquée à la personne et est consignée comme un événement SCIM en échec.
Tout membre du projet peut lire, sauf un appelant limité à des écrans (outside_screen_scope).
Modèle de requête et réponses
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/project/group-bindings'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Les liaisons du projet et les groupes de l’organisation. | GroupBindingList (application/json); en-têtes : Cache-Control |
| 401 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 409 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Créer une liaison de groupe du tableau de bord
Lie un groupe provisionné au projet de la session avec un rôle et, facultativement, un screen_scope qui le limite à des dossiers d’écrans et à des écrans (fixe une fois créé; invalid_request nomme le champ d’un id que le projet ne détient pas).
Réservé au propriétaire du projet ou à un membre qui peut approuver (approver_required sinon ; un appelant limité à des écrans reçoit outside_screen_scope) ; un administrateur de l’organisation du projet effectue la liaison en tant que tel membre, de sorte que celui qui ne peut pas approuver rejoint d’abord le projet (POST /api/organizations/{org_id}/projects/{project_id}/access en fait un approbateur), puis la liaison est enregistrée dans l’audit de l’organisation, marquée by_organization_admin dans l’audit du projet, et le propriétaire du projet reçoit un courriel ; une session fantôme du personnel est en lecture seule.
Le groupe doit être l’un des groupes provisionnés de l’organisation du projet, sinon not_found, et un groupe n’est lié qu’une fois à un projet, sinon resource_conflict. La liaison prend effet immédiatement pour les membres actuels du groupe et suit chaque changement apporté aux membres du groupe.
La limite de 200 membres du projet s’applique : une personne qu’elle refuse est consignée comme événement en échec dans les événements SCIM de l’organisation, et rien d’autre ne change ; il en va de même pour une personne qui serait un invité externe que la politique relative aux invités de l’organisation n’admet pas (guest_not_allowed).
Un changement de périmètre que fait une liaison ajoute project.member_screen_scope_changed (détails user_id, screen_scope, previous, via scim, changed_by_user_id vide). Lier un groupe relève du provisionnement SCIM, que le forfait Enterprise inclut ; un projet dont le forfait n’inclut pas cette fonctionnalité est refusé avec feature_not_in_plan (402). Les liaisons existantes continuent d’accorder des droits et peuvent être retirées.
Champs du corps de la requête
| Champ | Description |
|---|---|
| group_id (obligatoire, chaîne) | minLength : 1 maxLength : 200 |
| role (obligatoire, chaîne) | Autorisés : « approver », « member » |
| screen_scope (facultatif, ScreenScope) | Ce sur quoi un membre ou un agent à périmètre peut agir (docs/screen-scope.md) : les écrans des dossiers d’écrans listés et de chaque dossier qu’ils contiennent, et les écrans listés. Au moins un ID dans l’ensemble. Un ID qui ne nomme aucun dossier ou écran actif du projet au moment de l’écriture est invalid_request à sa position ; une suppression ultérieure laisse un ID mort, qui n’accorde rien. Le périmètre est lu à chaque requête, de sorte qu’une modification s’applique à la suivante. Les étiquettes ne sont jamais un périmètre. |
Modèle de requête et réponses
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/project/group-bindings'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 201 | La nouvelle liaison. | GroupBinding (application/json); en-têtes : Cache-Control |
| 400 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 401 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 402 | feature_not_in_plan — Le provisionnement SCIM fait partie du forfait Enterprise ; le problème nomme la fonctionnalité, le forfait du compte et required_plan. | Problème (application/problem+json) |
| 403 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 404 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 409 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Supprimer une liaison de groupe du tableau de bord
Délie un groupe du projet de la session. Réservé au propriétaire du projet ou à un membre qui peut approuver (approver_required sinon) ; un administrateur de l’organisation du projet délie en tant que tel membre, enregistré comme l’est une liaison.
Les personnes qui n’avaient accès que par la liaison le perdent ; une adhésion accordée à la main reste, et un droit accordé à la main que la liaison avait relevé ou élargi revient à ce qu’il était, périmètre d’écrans compris. Un id que le projet ne détient pas est not_found.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| binding_id | chemin | obligatoire |
Modèle de requête et réponses
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/project/group-bindings/BINDING_ID'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 204 | La liaison est supprimée et l’accès qu’elle donnait est retiré. | pas de corps |
| 401 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 403 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 404 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| 409 | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
| par défaut | Réponse stable RFC 9457 à un problème. Un 421 server_draining porte un Retry-After de 1 seconde, un 500 not_ready ou dependency_unavailable porte 5, et un 500 manifest_degraded porte 60, sauf si le gestionnaire a défini une valeur plus spécifique. | Problème (application/problem+json) |
Obtenir la configuration du fournisseur de services SCIM
Le ServiceProviderConfig de la RFC 7643 du service SCIM de l’organisation : patch et filter (200 résultats au plus) sont pris en charge; bulk, sort, etag et changePassword ne le sont pas. Les requêtes et les réponses sont en application/scim+json; application/json est accepté dans les requêtes.
Modèle de requête et réponses
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/ServiceProviderConfig'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | La configuration du fournisseur de services. | SCIMResource (application/scim+json) |
| 401 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 403 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 429 | Le budget de requêtes de l’organisation (600 par minute) est épuisé. Une erreur SCIM avec le statut "429"; réessayez après l’intervalle Retry-After. | SCIMError (application/scim+json); en-têtes : Retry-After |
| par défaut | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
Lister les types de ressources SCIM
Les types de ressources de la RFC 7643 que le service provisionne : User et Group.
Modèle de requête et réponses
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/ResourceTypes'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Une ListResponse des types de ressources. | SCIMResource (application/scim+json) |
| 401 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 403 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 429 | Le budget de requêtes de l’organisation (600 par minute) est épuisé. Une erreur SCIM avec le statut "429"; réessayez après l’intervalle Retry-After. | SCIMError (application/scim+json); en-têtes : Retry-After |
| par défaut | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
Lister les schémas SCIM
Les définitions de schéma de la RFC 7643 des ressources que le service provisionne.
Modèle de requête et réponses
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Schemas'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Une ListResponse des schémas. | SCIMResource (application/scim+json) |
| 401 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 403 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 429 | Le budget de requêtes de l’organisation (600 par minute) est épuisé. Une erreur SCIM avec le statut "429"; réessayez après l’intervalle Retry-After. | SCIMError (application/scim+json); en-têtes : Retry-After |
| par défaut | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
Lister les utilisateurs SCIM
Liste les utilisateurs provisionnés de l’organisation sous forme de ListResponse de la RFC 7644. filter est composé de un à quatre termes attr eq value joints par and; une valeur est une chaîne JSON entre guillemets, ou true ou false pour active.
Les utilisateurs se filtrent sur userName (insensible à la casse), externalId (exact), id, emails et emails.value, displayName et active; tout autre filtre donne 400 invalidFilter. startIndex est en base 1. count vaut 100 par défaut et au plus 200; count=0 ne renvoie que totalResults. attributes et excludedAttributes réduisent les membres renvoyés.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| filter | requête | optionnel | De un à quatre termes attr eq value joints par and. Une valeur est une chaîne JSON entre guillemets, ou true ou false pour active. Un attribut, un opérateur ou une forme non pris en charge donne 400 invalidFilter. |
| startIndex | requête | optionnel | L’index, en base 1, du premier résultat. Une valeur inférieure à 1 est lue comme 1. |
| count | requête | optionnel | La taille de page, 200 au plus. 0 ne renvoie que totalResults. Une valeur plus grande est lue comme 200. |
| attributes | requête | optionnel | Une liste d’attributs à renvoyer, séparés par des virgules; les autres sont exclus, sauf id et schemas. |
| excludedAttributes | requête | optionnel | Une liste d’attributs à exclure, séparés par des virgules. |
Modèle de requête et réponses
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Users'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Une ListResponse d’utilisateurs. | SCIMResource (application/scim+json) |
| 400 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 401 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 403 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 429 | Le budget de requêtes de l’organisation (600 par minute) est épuisé. Une erreur SCIM avec le statut "429"; réessayez après l’intervalle Retry-After. | SCIMError (application/scim+json); en-têtes : Retry-After |
| par défaut | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
Créer un utilisateur SCIM
Provisionne un utilisateur et répond 201 avec la ressource et son en-tête Location. La personne est identifiée par son courriel professionnel, sinon son courriel principal, sinon userName, et l’adresse doit appartenir à l’un des domaines vérifiés de l’organisation.
Une personne qui ne détient aucun identifiant de connexion, ou que l’organisation gère déjà, devient gérée par elle et se connecte au moyen de la connexion; une personne qui est déjà membre de l’un de ses projets et conserve sa propre ouverture de session est liée pour l’accès seulement, de sorte que SCIM gère ses droits dans les projets de l’organisation et jamais la personne.
Une adresse que l’organisation ne peut pas provisionner, comme celle d’un autre domaine ou d’un membre du personnel de screenRIG, est refusée avec une erreur SCIM dont detail indique la raison. Une personne dont l’utilisateur a été supprimé par cette organisation alors qu’elle ne la gérait pas est provisionnée à nouveau, avec l’accès que la suppression a retiré. Un userName déjà provisionné donne 409 uniqueness.
Champs du corps de la requête
| Champ | Description |
|---|---|
| schemas (facultatif, tableau) | Les URN des schémas que suit le document. |
Modèle de requête et réponses
curl --request POST --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Users'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 201 | L’utilisateur provisionné. | SCIMResource (application/scim+json); en-têtes : Location |
| 400 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 401 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 403 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 409 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 429 | Le budget de requêtes de l’organisation (600 par minute) est épuisé. Une erreur SCIM avec le statut "429"; réessayez après l’intervalle Retry-After. | SCIMError (application/scim+json); en-têtes : Retry-After |
| par défaut | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
Obtenir un utilisateur SCIM
Lit un utilisateur provisionné. attributes et excludedAttributes réduisent les membres renvoyés.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| id | chemin | obligatoire | L’id d’une ressource provisionnée, tel que le service SCIM l’a renvoyé. |
| attributes | requête | optionnel | Une liste d’attributs à renvoyer, séparés par des virgules; les autres sont exclus, sauf id et schemas. |
| excludedAttributes | requête | optionnel | Une liste d’attributs à exclure, séparés par des virgules. |
Modèle de requête et réponses
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Users/RESOURCE_ID'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | L’utilisateur. | SCIMResource (application/scim+json) |
| 401 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 403 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 404 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 429 | Le budget de requêtes de l’organisation (600 par minute) est épuisé. Une erreur SCIM avec le statut "429"; réessayez après l’intervalle Retry-After. | SCIMError (application/scim+json); en-têtes : Retry-After |
| par défaut | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
Remplacer un utilisateur SCIM
Remplace un utilisateur provisionné par le document envoyé. active false désactive la personne.
Une personne que l’organisation gère est désactivée comme dans le tableau de bord : ses sessions et jetons du tableau de bord prennent fin, ses adhésions aux projets et ses agents responsables sont suspendus, et le dernier administrateur de l’organisation est refusé avec 400 mutability; active true la rétablit avec ces adhésions et ces agents.
Une personne que l’organisation ne gère pas perd son accès aux projets de l’organisation (jamais un projet dont elle est propriétaire) et ses sessions prennent fin; active true rétablit cet accès. Un utilisateur qui représente un membre du personnel de screenRIG n’est jamais modifié : 400 mutability.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| id | chemin | obligatoire | L’id d’une ressource provisionnée, tel que le service SCIM l’a renvoyé. |
Champs du corps de la requête
| Champ | Description |
|---|---|
| schemas (facultatif, tableau) | Les URN des schémas que suit le document. |
Modèle de requête et réponses
curl --request PUT --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Users/RESOURCE_ID'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | L’utilisateur tel qu’il est stocké. | SCIMResource (application/scim+json) |
| 400 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 401 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 403 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 404 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 409 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 429 | Le budget de requêtes de l’organisation (600 par minute) est épuisé. Une erreur SCIM avec le statut "429"; réessayez après l’intervalle Retry-After. | SCIMError (application/scim+json); en-têtes : Retry-After |
| par défaut | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
Modifier partiellement un utilisateur SCIM
Applique un message PatchOp de la RFC 7644 à un utilisateur provisionné et répond 200 avec l’utilisateur.
Les opérations sont lues comme les envoient Microsoft Entra ID et Okta, avec ou sans ?aadOptscim062020 : les noms d’opération (op) ne tiennent pas compte de la casse; les booléens sont true ou false, ou "True" ou "False"; une opération peut omettre path ou utiliser des clés à points comme name.givenName; les chemins incluent emails[type eq "work"].value, members (add, replace et remove avec un tableau de valeurs) et members[value eq "<id>"] (remove); les attributs que screenRIG n’utilise pas sont acceptés et ignorés. active false désactive la personne.
Une personne que l’organisation gère est désactivée comme dans le tableau de bord : ses sessions et jetons du tableau de bord prennent fin, ses adhésions aux projets et ses agents responsables sont suspendus, et le dernier administrateur de l’organisation est refusé avec 400 mutability; active true la rétablit avec ces adhésions et ces agents.
Une personne que l’organisation ne gère pas perd son accès aux projets de l’organisation (jamais un projet dont elle est propriétaire) et ses sessions prennent fin; active true rétablit cet accès. Un utilisateur qui représente un membre du personnel de screenRIG n’est jamais modifié : 400 mutability.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| id | chemin | obligatoire | L’id d’une ressource provisionnée, tel que le service SCIM l’a renvoyé. |
Champs du corps de la requête
| Champ | Description |
|---|---|
| schemas (facultatif, tableau) | Les URN des schémas que suit le document. |
Modèle de requête et réponses
curl --request PATCH --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Users/RESOURCE_ID'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | L’utilisateur tel qu’il est stocké. | SCIMResource (application/scim+json) |
| 400 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 401 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 403 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 404 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 409 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 429 | Le budget de requêtes de l’organisation (600 par minute) est épuisé. Une erreur SCIM avec le statut "429"; réessayez après l’intervalle Retry-After. | SCIMError (application/scim+json); en-têtes : Retry-After |
| par défaut | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
Supprimer un utilisateur SCIM
Désactive l’utilisateur comme le fait active false, après quoi l’id est not_found et l’utilisateur disparaît de toute liste et de tout filtre. Pour une personne que l’organisation ne gère pas, l’accès que la désactivation a retiré est conservé, et une création ultérieure de la même personne le rétablit. Un utilisateur qui représente un membre du personnel de screenRIG n’est jamais modifié : 400 mutability.
N’efface jamais une personne; l’effacement est la suppression de son propre compte par la personne.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| id | chemin | obligatoire | L’id d’une ressource provisionnée, tel que le service SCIM l’a renvoyé. |
Modèle de requête et réponses
curl --request DELETE --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Users/RESOURCE_ID'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 204 | L’utilisateur est désactivé et n’est plus provisionné. | pas de corps |
| 400 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 401 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 403 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 404 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 429 | Le budget de requêtes de l’organisation (600 par minute) est épuisé. Une erreur SCIM avec le statut "429"; réessayez après l’intervalle Retry-After. | SCIMError (application/scim+json); en-têtes : Retry-After |
| par défaut | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
Lister les groupes SCIM
Liste les groupes provisionnés de l’organisation sous forme de ListResponse de la RFC 7644. filter est composé de un à quatre termes attr eq value joints par and.
Les groupes se filtrent sur displayName, externalId, id, ainsi que members et members.value; tout autre filtre donne 400 invalidFilter. startIndex est en base 1. count vaut 100 par défaut et au plus 200; count=0 ne renvoie que totalResults. attributes et excludedAttributes réduisent les membres renvoyés.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| filter | requête | optionnel | De un à quatre termes attr eq value joints par and. Une valeur est une chaîne JSON entre guillemets, ou true ou false pour active. Un attribut, un opérateur ou une forme non pris en charge donne 400 invalidFilter. |
| startIndex | requête | optionnel | L’index, en base 1, du premier résultat. Une valeur inférieure à 1 est lue comme 1. |
| count | requête | optionnel | La taille de page, 200 au plus. 0 ne renvoie que totalResults. Une valeur plus grande est lue comme 200. |
| attributes | requête | optionnel | Une liste d’attributs à renvoyer, séparés par des virgules; les autres sont exclus, sauf id et schemas. |
| excludedAttributes | requête | optionnel | Une liste d’attributs à exclure, séparés par des virgules. |
Modèle de requête et réponses
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Groups'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Une ListResponse de groupes. | SCIMResource (application/scim+json) |
| 400 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 401 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 403 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 429 | Le budget de requêtes de l’organisation (600 par minute) est épuisé. Une erreur SCIM avec le statut "429"; réessayez après l’intervalle Retry-After. | SCIMError (application/scim+json); en-têtes : Retry-After |
| par défaut | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
Créer un groupe SCIM
Provisionne un groupe et répond 201 avec la ressource et son en-tête Location. displayName est unique dans l’organisation, comparé sans tenir compte de la casse; un doublon donne 409 uniqueness. Un groupe ne donne aucun accès tant qu’une personne qui peut approuver ne le lie pas à un projet dans le tableau de bord.
Champs du corps de la requête
| Champ | Description |
|---|---|
| schemas (facultatif, tableau) | Les URN des schémas que suit le document. |
Modèle de requête et réponses
curl --request POST --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Groups'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 201 | Le groupe provisionné. | SCIMResource (application/scim+json); en-têtes : Location |
| 400 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 401 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 403 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 409 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 429 | Le budget de requêtes de l’organisation (600 par minute) est épuisé. Une erreur SCIM avec le statut "429"; réessayez après l’intervalle Retry-After. | SCIMError (application/scim+json); en-têtes : Retry-After |
| par défaut | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
Obtenir un groupe SCIM
Lit un groupe provisionné. attributes et excludedAttributes réduisent les membres renvoyés.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| id | chemin | obligatoire | L’id d’une ressource provisionnée, tel que le service SCIM l’a renvoyé. |
| attributes | requête | optionnel | Une liste d’attributs à renvoyer, séparés par des virgules; les autres sont exclus, sauf id et schemas. |
| excludedAttributes | requête | optionnel | Une liste d’attributs à exclure, séparés par des virgules. |
Modèle de requête et réponses
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Groups/RESOURCE_ID'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Le groupe. | SCIMResource (application/scim+json) |
| 401 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 403 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 404 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 429 | Le budget de requêtes de l’organisation (600 par minute) est épuisé. Une erreur SCIM avec le statut "429"; réessayez après l’intervalle Retry-After. | SCIMError (application/scim+json); en-têtes : Retry-After |
| par défaut | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
Remplacer un groupe SCIM
Remplace un groupe provisionné par le document envoyé. Un document sans members conserve les membres du groupe. Les changements d’adhésion réconcilient l’accès aux projets des personnes concernées, ce qui est idempotent.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| id | chemin | obligatoire | L’id d’une ressource provisionnée, tel que le service SCIM l’a renvoyé. |
Champs du corps de la requête
| Champ | Description |
|---|---|
| schemas (facultatif, tableau) | Les URN des schémas que suit le document. |
Modèle de requête et réponses
curl --request PUT --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Groups/RESOURCE_ID'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Le groupe tel qu’il est stocké. | SCIMResource (application/scim+json) |
| 400 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 401 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 403 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 404 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 409 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 429 | Le budget de requêtes de l’organisation (600 par minute) est épuisé. Une erreur SCIM avec le statut "429"; réessayez après l’intervalle Retry-After. | SCIMError (application/scim+json); en-têtes : Retry-After |
| par défaut | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
Modifier partiellement un groupe SCIM
Applique un message PatchOp de la RFC 7644 à un groupe provisionné et répond 204, ou 200 avec le groupe lorsque attributes ou excludedAttributes sont fournis.
Les opérations sont lues comme les envoient Microsoft Entra ID et Okta, avec ou sans ?aadOptscim062020 : les noms d’opération (op) ne tiennent pas compte de la casse; les booléens sont true ou false, ou "True" ou "False"; une opération peut omettre path ou utiliser des clés à points comme name.givenName; les chemins incluent emails[type eq "work"].value, members (add, replace et remove avec un tableau de valeurs) et members[value eq "<id>"] (remove); les attributs que screenRIG n’utilise pas sont acceptés et ignorés.
Les changements d’adhésion réconcilient l’accès aux projets des personnes concernées, ce qui est idempotent.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| id | chemin | obligatoire | L’id d’une ressource provisionnée, tel que le service SCIM l’a renvoyé. |
| attributes | requête | optionnel | Une liste d’attributs à renvoyer, séparés par des virgules; les autres sont exclus, sauf id et schemas. |
| excludedAttributes | requête | optionnel | Une liste d’attributs à exclure, séparés par des virgules. |
Champs du corps de la requête
| Champ | Description |
|---|---|
| schemas (facultatif, tableau) | Les URN des schémas que suit le document. |
Modèle de requête et réponses
curl --request PATCH --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Groups/RESOURCE_ID'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 200 | Le groupe tel qu’il est stocké, lorsque attributes ou excludedAttributes ont été fournis. | SCIMResource (application/scim+json) |
| 204 | La modification est appliquée. | pas de corps |
| 400 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 401 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 403 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 404 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 409 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 429 | Le budget de requêtes de l’organisation (600 par minute) est épuisé. Une erreur SCIM avec le statut "429"; réessayez après l’intervalle Retry-After. | SCIMError (application/scim+json); en-têtes : Retry-After |
| par défaut | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
Supprimer un groupe SCIM
Supprime un groupe provisionné avec ses liaisons de projet. Les personnes qui n’avaient accès que par ces liaisons le perdent; une adhésion accordée à la main reste.
Paramètres
| Nom | Envoyer | Requis ? | Description |
|---|---|---|---|
| id | chemin | obligatoire | L’id d’une ressource provisionnée, tel que le service SCIM l’a renvoyé. |
Modèle de requête et réponses
curl --request DELETE --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Groups/RESOURCE_ID'Réponses
| Statut | Sens | Corps et en-têtes |
|---|---|---|
| 204 | Le groupe est supprimé. | pas de corps |
| 401 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 403 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 404 | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |
| 429 | Le budget de requêtes de l’organisation (600 par minute) est épuisé. Une erreur SCIM avec le statut "429"; réessayez après l’intervalle Retry-After. | SCIMError (application/scim+json); en-têtes : Retry-After |
| par défaut | Une erreur SCIM de la RFC 7644, section 3.12, application/scim+json, et non un document de problème. status répète le statut HTTP sous forme de chaîne et scimType nomme la classe (invalidFilter, uniqueness, mutability et les autres de la RFC); detail indique ce qui a été refusé. 401 est un jeton inconnu ou révoqué et 403 une organisation dont SCIM est désactivé. | SCIMError (application/scim+json) |