OpenAPI YAMLOpenAPI JSONProbleme YAMLAPI-Überblick
Diese Gruppe hat 24 Operationen, generiert aus api/openapi.yaml. Filtern Sie nach Pfad, Aktion oder Authentifizierung. Jeder Endpunkt listet seine Eingaben auf; klappen Sie ihn auf, um eine Anfragevorlage und die Antwortcodes zu sehen. Die Vorlagen brauchen Ihre eigenen Werte und einen schemagültigen Anfragekörper.
Großgeschriebene Platzhalter durch Ihre Werte ersetzen. Für eine JSON-Anfrage speichern Sie einen Body, der dem Schema in request.json entspricht. Cookie-Beispiele verwenden ein lokales Cookie-Archiv aus einer authentifizierten Sitzung.
Benutzerbereitstellung: SCIM 2.0, Tokens und Gruppenbindungen
Dashboard Organisationen SCIM abrufen
Ein benannter Administrator liest die SCIM-Bereitstellungseinstellungen der Organisation: ob sie aktiviert ist, die Basis-URL, die beim Identitätsanbieter einzutragen ist (auf dem API-Origin), die aktiven Bereitstellungs-Token ohne ihre Secrets sowie die Anzahl der bereitgestellten Benutzer und Gruppen. Nur Personen; Agenten und Bearer-Anmeldeinformationen haben keine Route.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| org_id | Pfad | erforderlich |
Anfragevorlage und Antworten
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/scim'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die SCIM-Einstellungen der Organisation. | SCIMSettings (application/json); Header: Cache-Control |
| 401 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 403 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Dashboard Organisationen SCIM festlegen
Ein benannter Administrator aktiviert oder deaktiviert die SCIM-Bereitstellung nach frischem Nachweis: ein Passkey- oder Passwort-Nachweis, gebunden an eine Reauthentifizierung der Art scim_change mit der Organisations-ID als subject_id, oder {type: sso} aus einer Sitzung, die sich vor höchstens 10 Minuten über Single Sign-on angemeldet hat.
Das Deaktivieren ändert niemandes Zugriff: Die bereits bereitgestellten Personen und Gruppen behalten ihre Berechtigungen, und die Routen unter /scim/v2 antworten mit 403, bis SCIM wieder aktiviert wird. Gibt die Einstellungen zurück.
Nur Personen; Agenten und Bearer-Anmeldeinformationen haben keine Route. enabled true fällt unter die SCIM-Provisionierung, die der Enterprise-Plan enthält; eine Organisation, deren Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt. enabled false wird immer akzeptiert, und die /scim/v2-Endpunkte einer Organisation, in der SCIM aktiviert ist, antworten weiterhin.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| org_id | Pfad | erforderlich |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| aktiviert (erforderlich, Boolean) | |
| proof (erforderlich, DashboardProof) |
Anfragevorlage und Antworten
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'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die SCIM-Einstellungen der Organisation. | SCIMSettings (application/json); Header: Cache-Control |
| 400 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 401 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 402 | feature_not_in_plan — Die SCIM-Provisionierung ist Teil des Enterprise-Plans; das Problem nennt die Funktion, den Plan, den das Konto hat, und required_plan. | Problem (application/problem+json) |
| 403 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Dashboard Organisationen SCIM-Token erstellen
Ein benannter Administrator erzeugt nach frischem Nachweis (wie bei PUT .../scim) ein Bereitstellungs-Token. Das Token, srscim_ plus 43 base64url-Zeichen, wird einmalig und nur hier zurückgegeben; der Server speichert einen SHA-256-Digest und ein Präfix, an dem er es erkennt. Eine Organisation hat höchstens 5 aktive Tokens, sonst resource_conflict.
Nur Personen; Agenten und Bearer-Anmeldeinformationen haben keine Route. Das Ausstellen eines Tokens fällt unter die SCIM-Provisionierung, die der Enterprise-Plan enthält; eine Organisation, deren Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt. Bereits ausgestellte Tokens funktionieren weiter und können widerrufen werden.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| org_id | Pfad | erforderlich |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| Name (erforderlich, Zeichenkette) | minLength: 1 maxLength: 80 |
| proof (erforderlich, DashboardProof) |
Anfragevorlage und Antworten
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'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Das neue Token mit seinem Secret. | SCIMTokenCreated (application/json); Header: Cache-Control |
| 400 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 401 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 402 | feature_not_in_plan — Die SCIM-Provisionierung ist Teil des Enterprise-Plans; das Problem nennt die Funktion, den Plan, den das Konto hat, und required_plan. | Problem (application/problem+json) |
| 403 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 409 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Dashboard Organisationen SCIM-Token widerrufen
Ein benannter Administrator widerruft ein Bereitstellungs-Token; Anfragen, die es vorlegen, werden ab dann mit 401 abgelehnt. Ein bereits widerrufenes Token gibt 204 zurück; eine ID, die die Organisation nicht hat, ist not_found. Nur Personen; Agenten und Bearer-Anmeldeinformationen haben keine Route.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| org_id | Pfad | erforderlich | |
| token_id | Pfad | erforderlich |
Anfragevorlage und Antworten
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/scim/tokens/TOKEN_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 204 | Das Token wird widerrufen. | kein Körper |
| 401 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 403 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 404 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Dashboard Organisationen SCIM-Gruppen auflisten
Ein benannter Administrator listet die Gruppen auf, die der Identitätsanbieter bereitgestellt hat, mit ihren Mitgliederzahlen und den Projekten, an die jede gebunden ist. Die Bindung erfolgt im Projekt (createDashboardGroupBinding) durch eine Person, die dort genehmigen darf; ein Administrator sieht nur Bindungen und Projektnamen, was keinen Projektzugriff gewährt.
Nur Personen; Agenten und Bearer-Anmeldeinformationen haben keine Route.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| org_id | Pfad | erforderlich |
Anfragevorlage und Antworten
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/scim/groups'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die bereitgestellten Gruppen der Organisation. | SCIMGroupList (application/json); Header: Cache-Control |
| 401 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 403 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Dashboard Organisationen SCIM-Ereignisse auflisten
Ein benannter Administrator liest die letzten 500 Anfragen, die die SCIM-Clients der Organisation gestellt haben, neueste zuerst, Fehlschläge eingeschlossen, 30 Tage aufbewahrt. Jede Zeile nennt die Operation, die Ressource und den Status und enthält detail, wenn die Anfrage fehlgeschlagen ist. Nur Personen; Agenten und Bearer-Anmeldeinformationen haben keine Route.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| org_id | Pfad | erforderlich |
Anfragevorlage und Antworten
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/scim/events'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die letzten SCIM-Ereignisse der Organisation. | SCIMEventList (application/json); Header: Cache-Control |
| 401 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 403 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Dashboard-Gruppenbindungen auflisten
Die Gruppenbindungen des Projekts der Sitzung und die Gruppen, die der Identitätsanbieter seiner Organisation bereitgestellt hat (Name und Mitgliederzahl), zur Auswahl.
Eine Bindung gibt jedem Mitglied der Gruppe eine Mitgliedschaft in diesem Projekt: Rolle member ist eine einfache Mitgliedschaft, und Rolle approver erlaubt der Person zusätzlich, Reviews zu genehmigen, im gesamten Projekt oder im screen_scope der Bindung. Eine Person, die mehrere Bindungen des Projekts erreichen, hat die Vereinigung ihrer Bereiche, und eine Bindung ohne Bereich gibt das gesamte Projekt.
Die Person genehmigt Reviews nur, wenn die Vereinigung der Bereiche ihrer Genehmiger-Bindungen (zusammen mit dem Bereich einer von Hand gewährten Genehmigungsberechtigung) die gesamte Vereinigung abdeckt, und ist andernfalls Mitglied; SCIM verringert nie eine von Hand gewährte Berechtigung: Eine Bindung, die das täte, wird auf die Person nicht angewendet und als fehlgeschlagenes SCIM-Ereignis erfasst.
Jedes Mitglied des Projekts darf lesen, außer einem auf Bildschirme beschränkten Aufrufer (outside_screen_scope).
Anfragevorlage und Antworten
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/project/group-bindings'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die Bindungen des Projekts und die Gruppen der Organisation. | GroupBindingList (application/json); Header: Cache-Control |
| 401 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 409 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Dashboard-Gruppenbindung erstellen
Bindet eine bereitgestellte Gruppe mit einer Rolle und optional einem screen_scope, der sie auf Bildschirmordner und Bildschirme beschränkt, an das Projekt der Sitzung (nach dem Anlegen fest; invalid_request nennt das Feld einer ID, die das Projekt nicht hat).
Nur der Projektinhaber oder ein Mitglied, das genehmigen darf (sonst approver_required; ein auf Bildschirme beschränkter Aufrufer erhält outside_screen_scope); ein Admin der Organisation des Projekts bindet als ein solches Mitglied, sodass einer, der nicht genehmigen darf, dem Projekt zuerst beitritt (POST /api/organizations/{org_id}/projects/{project_id}/access macht ihn zum Genehmiger), und die Bindung wird dann im Organisations-Audit protokolliert, im Audit des Projekts mit by_organization_admin markiert, und der Inhaber des Projekts erhält eine E-Mail; eine Mitarbeiter-Schattensitzung ist schreibgeschützt.
Die Gruppe muss eine der bereitgestellten Gruppen der Organisation des Projekts sein, sonst not_found, und eine Gruppe wird nur einmal an ein Projekt gebunden, sonst resource_conflict. Die Bindung gilt sofort für die aktuellen Mitglieder der Gruppe und folgt jeder Änderung der Mitgliedschaft der Gruppe.
Das Limit des Projekts von 200 Mitgliedern gilt: Eine Person, die es ablehnt, wird als fehlgeschlagenes Ereignis in den SCIM-Ereignissen der Organisation festgehalten, und sonst ändert sich nichts; ebenso eine Person, die ein externer Gast wäre, den die Gastrichtlinie der Organisation nicht zulässt (guest_not_allowed).
Eine Änderung des Bereichs durch eine Bindung hängt project.member_screen_scope_changed an (Details user_id, screen_scope, previous, via scim, changed_by_user_id leer). Das Zuordnen einer Gruppe fällt unter die SCIM-Provisionierung, die der Enterprise-Plan enthält; ein Projekt, dessen Plan dies nicht enthält, wird mit feature_not_in_plan (402) abgelehnt. Bestehende Bindungen gewähren weiterhin Zugriff und können entfernt werden.
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| group_id (erforderlich, Zeichenfolge) | minLength: 1 maxLength: 200 |
| role (erforderlich, Zeichenfolge) | Erlaubt: "approver", "member" |
| screen_scope (optional, ScreenScope) | Worauf ein Mitglied oder Agent mit Bereich handeln darf (docs/screen-scope.md): die Bildschirme in den aufgeführten Bildschirmordnern und in jedem Ordner darin sowie die aufgeführten Bildschirme. Insgesamt mindestens eine ID. Eine ID, die beim Schreiben keinen aktiven Ordner oder Bildschirm des Projekts nennt, ist invalid_request an ihrer Position; eine spätere Löschung hinterlässt eine tote ID, die nichts gewährt. Der Bereich wird bei jeder Anfrage gelesen, sodass eine Änderung bei der nächsten gilt. Tags sind nie ein Bereich. |
Anfragevorlage und Antworten
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'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Die neue Bindung. | GroupBinding (application/json); Header: Cache-Control |
| 400 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 401 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 402 | feature_not_in_plan — Die SCIM-Provisionierung ist Teil des Enterprise-Plans; das Problem nennt die Funktion, den Plan, den das Konto hat, und required_plan. | Problem (application/problem+json) |
| 403 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 404 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 409 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
Dashboard-Gruppenbindung löschen
Hebt die Bindung einer Gruppe an das Projekt der Sitzung auf. Nur der Projektinhaber oder ein Mitglied, das genehmigen darf (sonst approver_required); ein Admin der Organisation des Projekts hebt sie als ein solches Mitglied auf, und der Vorgang wird protokolliert wie eine Bindung.
Personen, die den Zugriff nur über die Bindung hatten, verlieren ihn; eine von Hand gewährte Mitgliedschaft bleibt bestehen, und eine von Hand gewährte Berechtigung, die die Bindung angehoben oder erweitert hat, kehrt auf ihren früheren Stand zurück, einschließlich ihres Bildschirmbereichs. Eine ID, die das Projekt nicht hat, ist not_found.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| binding_id | Pfad | erforderlich |
Anfragevorlage und Antworten
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/project/group-bindings/BINDING_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 204 | Die Bindung wird entfernt und der Zugriff, den sie gewährte, wird entzogen. | kein Körper |
| 401 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 403 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 404 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| 409 | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
| Standard | Stabile RFC 9457-Fehlerantwort. Ein 421 server_draining enthält Retry-After von 1 Sekunde, ein 500 not_ready oder dependency_unavailable enthält 5, und ein 500 manifest_degraded enthält 60, sofern der Handler keinen spezifischeren Wert gesetzt hat. | Problem (application/problem+json) |
SCIM-Service-Provider-Konfiguration abrufen
Die ServiceProviderConfig nach RFC 7643 des SCIM-Dienstes der Organisation: patch und filter (höchstens 200 Ergebnisse) werden unterstützt; bulk, sort, etag und changePassword nicht. Anfragen und Antworten sind application/scim+json; application/json wird bei Anfragen akzeptiert.
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/ServiceProviderConfig'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die Service-Provider-Konfiguration. | SCIMResource (application/scim+json) |
| 401 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 403 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 429 | Das Anfragebudget der Organisation (600 pro Minute) ist aufgebraucht. Ein SCIM-Fehler mit status "429"; nach dem Intervall aus Retry-After erneut versuchen. | SCIMError (application/scim+json); Header: Retry-After |
| Standard | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
SCIM-Ressourcentypen auflisten
Die Ressourcentypen nach RFC 7643, die der Dienst bereitstellt: User und Group.
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/ResourceTypes'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Eine ListResponse mit den Ressourcentypen. | SCIMResource (application/scim+json) |
| 401 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 403 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 429 | Das Anfragebudget der Organisation (600 pro Minute) ist aufgebraucht. Ein SCIM-Fehler mit status "429"; nach dem Intervall aus Retry-After erneut versuchen. | SCIMError (application/scim+json); Header: Retry-After |
| Standard | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
SCIM-Schemas auflisten
Die Schema-Definitionen nach RFC 7643 der Ressourcen, die der Dienst bereitstellt.
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Schemas'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Eine ListResponse mit den Schemas. | SCIMResource (application/scim+json) |
| 401 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 403 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 429 | Das Anfragebudget der Organisation (600 pro Minute) ist aufgebraucht. Ein SCIM-Fehler mit status "429"; nach dem Intervall aus Retry-After erneut versuchen. | SCIMError (application/scim+json); Header: Retry-After |
| Standard | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
SCIM-Benutzer auflisten
Listet die bereitgestellten Benutzer der Organisation als ListResponse nach RFC 7644 auf. filter besteht aus ein bis vier Termen der Form attr eq value, verbunden durch and; ein value ist eine in Anführungszeichen gesetzte JSON-Zeichenfolge oder true bzw. false für active.
Benutzer werden nach userName (ohne Beachtung der Groß-/Kleinschreibung), externalId (exakt), id, emails und emails.value, displayName und active gefiltert; jeder andere Filter ist 400 invalidFilter. startIndex ist 1-basiert. count ist standardmäßig 100 und höchstens 200; count=0 gibt nur totalResults zurück. attributes und excludedAttributes kürzen die zurückgegebenen Felder.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| filter | Abfrage | optional | Ein bis vier Terme der Form attr eq value, verbunden durch and. Ein value ist eine in Anführungszeichen gesetzte JSON-Zeichenfolge oder true bzw. false für active. Ein nicht unterstütztes Attribut, ein nicht unterstützter Operator oder eine nicht unterstützte Form ist 400 invalidFilter. |
| startIndex | Abfrage | optional | Der 1-basierte Index des ersten Ergebnisses. Ein Wert unter 1 wird als 1 gelesen. |
| count | Abfrage | optional | Die Seitengröße, höchstens 200. 0 gibt nur totalResults zurück. Ein größerer Wert wird als 200 gelesen. |
| attributes | Abfrage | optional | Eine durch Kommas getrennte Liste von Attributen, die zurückgegeben werden; die übrigen werden ausgelassen, außer id und schemas. |
| excludedAttributes | Abfrage | optional | Eine durch Kommas getrennte Liste von Attributen, die ausgelassen werden. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Users'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Eine ListResponse mit Benutzern. | SCIMResource (application/scim+json) |
| 400 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 401 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 403 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 429 | Das Anfragebudget der Organisation (600 pro Minute) ist aufgebraucht. Ein SCIM-Fehler mit status "429"; nach dem Intervall aus Retry-After erneut versuchen. | SCIMError (application/scim+json); Header: Retry-After |
| Standard | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
SCIM-Benutzer erstellen
Stellt einen Benutzer bereit und antwortet mit 201, der Ressource und ihrer Location. Die Person wird anhand ihrer geschäftlichen E-Mail-Adresse identifiziert, sonst ihrer primären E-Mail-Adresse, sonst userName, und die Adresse muss an einer der verifizierten Domains der Organisation liegen.
Eine Person, die keine Anmeldeinformation besitzt oder die die Organisation bereits verwaltet, wird von ihr verwaltet und meldet sich über die Verbindung an; eine Person, die bereits Mitglied eines ihrer Projekte ist und ihre eigene Anmeldung behält, wird nur für den Zugriff verknüpft, sodass SCIM ihre Berechtigungen in den Projekten der Organisation verwaltet und nie die Person.
Eine Adresse, die die Organisation nicht bereitstellen darf, etwa eine an einer anderen Domain oder die eines Mitarbeiters von screenRIG, wird mit einem SCIM-Fehler abgelehnt, dessen detail den Grund nennt. Eine Person, deren Benutzer diese Organisation gelöscht hat, solange sie die Person nicht verwaltete, wird erneut bereitgestellt, mit dem Zugriff, den die Löschung entfernt hat. Ein userName, der bereits bereitgestellt ist, ist 409 uniqueness.
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| schemas (optional, Array) | Die URNs der Schemas, denen das Dokument folgt. |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Users'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Der bereitgestellte Benutzer. | SCIMResource (application/scim+json); Header: Location |
| 400 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 401 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 403 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 409 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 429 | Das Anfragebudget der Organisation (600 pro Minute) ist aufgebraucht. Ein SCIM-Fehler mit status "429"; nach dem Intervall aus Retry-After erneut versuchen. | SCIMError (application/scim+json); Header: Retry-After |
| Standard | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
SCIM-Benutzer abrufen
Liest einen bereitgestellten Benutzer. attributes und excludedAttributes kürzen die zurückgegebenen Felder.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| id | Pfad | erforderlich | Die ID einer bereitgestellten Ressource, wie der SCIM-Dienst sie zurückgegeben hat. |
| attributes | Abfrage | optional | Eine durch Kommas getrennte Liste von Attributen, die zurückgegeben werden; die übrigen werden ausgelassen, außer id und schemas. |
| excludedAttributes | Abfrage | optional | Eine durch Kommas getrennte Liste von Attributen, die ausgelassen werden. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Users/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Der Benutzer. | SCIMResource (application/scim+json) |
| 401 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 403 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 404 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 429 | Das Anfragebudget der Organisation (600 pro Minute) ist aufgebraucht. Ein SCIM-Fehler mit status "429"; nach dem Intervall aus Retry-After erneut versuchen. | SCIMError (application/scim+json); Header: Retry-After |
| Standard | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
SCIM-Benutzer ersetzen
Ersetzt einen bereitgestellten Benutzer durch das gesendete Dokument. active false deaktiviert die Person.
Eine Person, die die Organisation verwaltet, wird deaktiviert wie im Dashboard: Ihre Sitzungen und Dashboard-Tokens enden, ihre Projektmitgliedschaften und verantwortlichen Agenten werden ausgesetzt, und der letzte Organisationsadministrator wird mit 400 mutability abgelehnt; active true setzt sie mit diesen Mitgliedschaften und Agenten wieder ein.
Eine Person, die die Organisation nicht verwaltet, verliert ihren Zugriff auf die Projekte der Organisation (nie auf ein Projekt, das ihr gehört), und ihre Sitzungen enden; active true stellt diesen Zugriff wieder her. Ein Benutzer, der einen Mitarbeiter von screenRIG darstellt, wird nie geändert: 400 mutability.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| id | Pfad | erforderlich | Die ID einer bereitgestellten Ressource, wie der SCIM-Dienst sie zurückgegeben hat. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| schemas (optional, Array) | Die URNs der Schemas, denen das Dokument folgt. |
Anfragevorlage und Antworten
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'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Der Benutzer wie gespeichert. | SCIMResource (application/scim+json) |
| 400 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 401 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 403 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 404 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 409 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 429 | Das Anfragebudget der Organisation (600 pro Minute) ist aufgebraucht. Ein SCIM-Fehler mit status "429"; nach dem Intervall aus Retry-After erneut versuchen. | SCIMError (application/scim+json); Header: Retry-After |
| Standard | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
SCIM-Benutzer patchen
Wendet eine PatchOp-Nachricht nach RFC 7644 auf einen bereitgestellten Benutzer an und antwortet mit 200 und dem Benutzer.
Die Operationen werden so gelesen, wie Microsoft Entra ID und Okta sie senden, mit oder ohne ?aadOptscim062020: op-Namen unterscheiden nicht zwischen Groß- und Kleinschreibung; Booleans sind true oder false, oder "True" oder "False"; eine Operation darf path weglassen oder Schlüssel mit Punkten wie name.givenName verwenden; Pfade umfassen emails[type eq "work"].value, members (add, replace und remove mit einem value-Array) und members[value eq "<id>"] (remove); Attribute, die screenRIG nicht verwendet, werden akzeptiert und ignoriert. active false deaktiviert die Person.
Eine Person, die die Organisation verwaltet, wird deaktiviert wie im Dashboard: Ihre Sitzungen und Dashboard-Tokens enden, ihre Projektmitgliedschaften und verantwortlichen Agenten werden ausgesetzt, und der letzte Organisationsadministrator wird mit 400 mutability abgelehnt; active true setzt sie mit diesen Mitgliedschaften und Agenten wieder ein.
Eine Person, die die Organisation nicht verwaltet, verliert ihren Zugriff auf die Projekte der Organisation (nie auf ein Projekt, das ihr gehört), und ihre Sitzungen enden; active true stellt diesen Zugriff wieder her. Ein Benutzer, der einen Mitarbeiter von screenRIG darstellt, wird nie geändert: 400 mutability.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| id | Pfad | erforderlich | Die ID einer bereitgestellten Ressource, wie der SCIM-Dienst sie zurückgegeben hat. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| schemas (optional, Array) | Die URNs der Schemas, denen das Dokument folgt. |
Anfragevorlage und Antworten
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'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Der Benutzer wie gespeichert. | SCIMResource (application/scim+json) |
| 400 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 401 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 403 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 404 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 409 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 429 | Das Anfragebudget der Organisation (600 pro Minute) ist aufgebraucht. Ein SCIM-Fehler mit status "429"; nach dem Intervall aus Retry-After erneut versuchen. | SCIMError (application/scim+json); Header: Retry-After |
| Standard | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
SCIM-Benutzer löschen
Deaktiviert den Benutzer wie active false, wonach die ID not_found ist und der Benutzer aus jeder Auflistung und jedem Filter verschwindet. Bei einer Person, die die Organisation nicht verwaltet, wird der Zugriff, den die Deaktivierung entfernt hat, aufbewahrt, und ein späteres Anlegen derselben Person stellt ihn wieder her. Ein Benutzer, der einen Mitarbeiter von screenRIG darstellt, wird nie geändert: 400 mutability.
Es löscht nie eine Person; das Löschen ist die eigene Kontolöschung der Person.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| id | Pfad | erforderlich | Die ID einer bereitgestellten Ressource, wie der SCIM-Dienst sie zurückgegeben hat. |
Anfragevorlage und Antworten
curl --request DELETE --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Users/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 204 | Der Benutzer wird deaktiviert und ist nicht mehr bereitgestellt. | kein Körper |
| 400 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 401 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 403 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 404 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 429 | Das Anfragebudget der Organisation (600 pro Minute) ist aufgebraucht. Ein SCIM-Fehler mit status "429"; nach dem Intervall aus Retry-After erneut versuchen. | SCIMError (application/scim+json); Header: Retry-After |
| Standard | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
SCIM-Gruppen auflisten
Listet die bereitgestellten Gruppen der Organisation als ListResponse nach RFC 7644 auf. filter besteht aus ein bis vier Termen der Form attr eq value, verbunden durch and.
Gruppen werden nach displayName, externalId, id sowie members und members.value gefiltert; jeder andere Filter ist 400 invalidFilter. startIndex ist 1-basiert. count ist standardmäßig 100 und höchstens 200; count=0 gibt nur totalResults zurück. attributes und excludedAttributes kürzen die zurückgegebenen Felder.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| filter | Abfrage | optional | Ein bis vier Terme der Form attr eq value, verbunden durch and. Ein value ist eine in Anführungszeichen gesetzte JSON-Zeichenfolge oder true bzw. false für active. Ein nicht unterstütztes Attribut, ein nicht unterstützter Operator oder eine nicht unterstützte Form ist 400 invalidFilter. |
| startIndex | Abfrage | optional | Der 1-basierte Index des ersten Ergebnisses. Ein Wert unter 1 wird als 1 gelesen. |
| count | Abfrage | optional | Die Seitengröße, höchstens 200. 0 gibt nur totalResults zurück. Ein größerer Wert wird als 200 gelesen. |
| attributes | Abfrage | optional | Eine durch Kommas getrennte Liste von Attributen, die zurückgegeben werden; die übrigen werden ausgelassen, außer id und schemas. |
| excludedAttributes | Abfrage | optional | Eine durch Kommas getrennte Liste von Attributen, die ausgelassen werden. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Groups'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Eine ListResponse mit Gruppen. | SCIMResource (application/scim+json) |
| 400 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 401 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 403 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 429 | Das Anfragebudget der Organisation (600 pro Minute) ist aufgebraucht. Ein SCIM-Fehler mit status "429"; nach dem Intervall aus Retry-After erneut versuchen. | SCIMError (application/scim+json); Header: Retry-After |
| Standard | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
SCIM-Gruppe erstellen
Stellt eine Gruppe bereit und antwortet mit 201, der Ressource und ihrer Location. displayName ist in der Organisation eindeutig, ohne Beachtung der Groß-/Kleinschreibung verglichen; ein Duplikat ist 409 uniqueness. Eine Gruppe gewährt keinen Zugriff, bis eine Person, die genehmigen darf, sie im Dashboard an ein Projekt bindet.
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| schemas (optional, Array) | Die URNs der Schemas, denen das Dokument folgt. |
Anfragevorlage und Antworten
curl --request POST --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Groups'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 201 | Die bereitgestellte Gruppe. | SCIMResource (application/scim+json); Header: Location |
| 400 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 401 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 403 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 409 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 429 | Das Anfragebudget der Organisation (600 pro Minute) ist aufgebraucht. Ein SCIM-Fehler mit status "429"; nach dem Intervall aus Retry-After erneut versuchen. | SCIMError (application/scim+json); Header: Retry-After |
| Standard | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
SCIM-Gruppe abrufen
Liest eine bereitgestellte Gruppe. attributes und excludedAttributes kürzen die zurückgegebenen Felder.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| id | Pfad | erforderlich | Die ID einer bereitgestellten Ressource, wie der SCIM-Dienst sie zurückgegeben hat. |
| attributes | Abfrage | optional | Eine durch Kommas getrennte Liste von Attributen, die zurückgegeben werden; die übrigen werden ausgelassen, außer id und schemas. |
| excludedAttributes | Abfrage | optional | Eine durch Kommas getrennte Liste von Attributen, die ausgelassen werden. |
Anfragevorlage und Antworten
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Groups/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die Gruppe. | SCIMResource (application/scim+json) |
| 401 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 403 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 404 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 429 | Das Anfragebudget der Organisation (600 pro Minute) ist aufgebraucht. Ein SCIM-Fehler mit status "429"; nach dem Intervall aus Retry-After erneut versuchen. | SCIMError (application/scim+json); Header: Retry-After |
| Standard | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
SCIM-Gruppe ersetzen
Ersetzt eine bereitgestellte Gruppe durch das gesendete Dokument. Ein Dokument ohne Mitglieder behält die Mitglieder der Gruppe bei. Mitgliedschaftsänderungen gleichen den Projektzugriff der betroffenen Personen ab, was idempotent ist.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| id | Pfad | erforderlich | Die ID einer bereitgestellten Ressource, wie der SCIM-Dienst sie zurückgegeben hat. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| schemas (optional, Array) | Die URNs der Schemas, denen das Dokument folgt. |
Anfragevorlage und Antworten
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'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die Gruppe wie gespeichert. | SCIMResource (application/scim+json) |
| 400 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 401 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 403 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 404 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 409 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 429 | Das Anfragebudget der Organisation (600 pro Minute) ist aufgebraucht. Ein SCIM-Fehler mit status "429"; nach dem Intervall aus Retry-After erneut versuchen. | SCIMError (application/scim+json); Header: Retry-After |
| Standard | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
SCIM-Gruppe patchen
Wendet eine PatchOp-Nachricht nach RFC 7644 auf eine bereitgestellte Gruppe an und antwortet mit 204, oder mit 200 und der Gruppe, wenn attributes oder excludedAttributes angegeben sind.
Die Operationen werden so gelesen, wie Microsoft Entra ID und Okta sie senden, mit oder ohne ?aadOptscim062020: op-Namen unterscheiden nicht zwischen Groß- und Kleinschreibung; Booleans sind true oder false, oder "True" oder "False"; eine Operation darf path weglassen oder Schlüssel mit Punkten wie name.givenName verwenden; Pfade umfassen emails[type eq "work"].value, members (add, replace und remove mit einem value-Array) und members[value eq "<id>"] (remove); Attribute, die screenRIG nicht verwendet, werden akzeptiert und ignoriert.
Mitgliedschaftsänderungen gleichen den Projektzugriff der betroffenen Personen ab, was idempotent ist.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| id | Pfad | erforderlich | Die ID einer bereitgestellten Ressource, wie der SCIM-Dienst sie zurückgegeben hat. |
| attributes | Abfrage | optional | Eine durch Kommas getrennte Liste von Attributen, die zurückgegeben werden; die übrigen werden ausgelassen, außer id und schemas. |
| excludedAttributes | Abfrage | optional | Eine durch Kommas getrennte Liste von Attributen, die ausgelassen werden. |
Anfrageinhalt-Felder
| Feld | Beschreibung |
|---|---|
| schemas (optional, Array) | Die URNs der Schemas, denen das Dokument folgt. |
Anfragevorlage und Antworten
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'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 200 | Die Gruppe wie gespeichert, wenn attributes oder excludedAttributes angegeben wurden. | SCIMResource (application/scim+json) |
| 204 | Der Patch wird angewendet. | kein Körper |
| 400 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 401 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 403 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 404 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 409 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 429 | Das Anfragebudget der Organisation (600 pro Minute) ist aufgebraucht. Ein SCIM-Fehler mit status "429"; nach dem Intervall aus Retry-After erneut versuchen. | SCIMError (application/scim+json); Header: Retry-After |
| Standard | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
SCIM-Gruppe löschen
Löscht eine bereitgestellte Gruppe samt ihren Projektbindungen. Personen, die den Zugriff nur über diese Bindungen hatten, verlieren ihn; eine von Hand gewährte Mitgliedschaft bleibt bestehen.
Parameter
| Name | Senden | Erforderlich? | Beschreibung |
|---|---|---|---|
| id | Pfad | erforderlich | Die ID einer bereitgestellten Ressource, wie der SCIM-Dienst sie zurückgegeben hat. |
Anfragevorlage und Antworten
curl --request DELETE --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Groups/RESOURCE_ID'Antworten
| Status | Bedeutung | Textkörper und Header |
|---|---|---|
| 204 | Die Gruppe wird gelöscht. | kein Körper |
| 401 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 403 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 404 | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |
| 429 | Das Anfragebudget der Organisation (600 pro Minute) ist aufgebraucht. Ein SCIM-Fehler mit status "429"; nach dem Intervall aus Retry-After erneut versuchen. | SCIMError (application/scim+json); Header: Retry-After |
| Standard | Ein SCIM-Fehler nach RFC 7644 Abschnitt 3.12, application/scim+json, kein Problem-Dokument. status wiederholt den HTTP-Status als Zeichenfolge, und scimType benennt die Klasse (invalidFilter, uniqueness, mutability und die übrigen des RFC); detail sagt, was abgelehnt wurde. 401 ist ein unbekanntes oder widerrufenes Token und 403 eine Organisation mit ausgeschaltetem SCIM. | SCIMError (application/scim+json) |