Service-Clients: API-Referenz mit Endpunkten und Beispielen

OpenAPI YAML OpenAPI JSON Probleme YAML API-Überblick

Diese Gruppe hat 9 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.

Service-Clients

GET/api/service-clients¶

Service-Clients auflisten

Die Service-Clients des Projekts (Spezifikation: ein Server, Skript oder CI-Job eines Kunden, der dem Projekt gehört), neueste zuerst, aktiv und widerrufen, mit ihren öffentlichen Schlüsseln, geheimen IDs und Nutzung; niemals ein Geheimnis oder dessen Digest. Benötigt die Projektfähigkeit.

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: keine
Operations-ID: listServiceClients

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/service-clients'

Antworten

Status	Bedeutung	Textkörper und Header
200	Der Service-Client.	ServiceClientList (application/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)

POST/api/service-clients¶

Service-Client erstellen

Erstellt einen Service-Client, der dem Projekt gehört, mit einem Namen, Fähigkeiten (weggelassen bedeutet alle sechs; jede muss vom Manager gehalten werden, sonst 403), Zugriff (lesen, Standard, oder verwalten) und einem öffentlichen JWK-Schlüssel (OKP Ed25519, EC P-256 oder RSA mit mindestens 2048 Bit) und/oder geheim true. Das Geheimnis wird einmalig zurückgegeben, nur hier. Maximal 50 aktive Clients pro Organisation.

Agenten benötigen Identitätsscope, aktive Identität Manage, ihre eigene Manage-Berechtigung mit der Projektfähigkeit im Projekt und eine aktive Administratorrolle in der Organisation; eine Person verwendet die Dashboardsitzung mit project_id und einem frischen Nachweis (Art service_client_change, Subjekt die Client-ID oder die Projekt-ID bei Erstellung) im Body. Ein Servicetoken wird mit 403 abgelehnt.

Ein auf Bildschirme beschränktes Mitglied verbindet keine Agenten, stellt keine Zugangsdaten aus und verwaltet nicht die Personen des Projekts: outside_screen_scope (den Projektinhaber fragen).

Authentifizierung: agentIdentityBearer ODER dashboardSession
Anfrageinhalt: ServiceClientChange
Operations-ID: createServiceClient

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.

Anfrageinhalt-Felder

Feld	Beschreibung
project_id (optional, Zeichenkette)	Nur Dashboard-Sitzung.
proof (optional, DashboardProof)
Name (optional, Zeichenkette)	minLength: 1 maxLength: 80
Fähigkeiten (optional, Array)
Zugriff (optional, String)	Verwalten erfordert eine Person, die Überprüfungen genehmigen kann (403 approver_required). Erlaubt: "lesen", "vorschlagen", "verwalten"
key (optional, object)	Ein öffentlicher JWK: OKP Ed25519, EC P-256 oder RSA mit mindestens 2048 Bit.
secret (optional, boolean)	Ein Geheimnis erzeugen (nur Erstellung).
upload_scope (optional, UploadScope)	Was ein Uploader verwenden darf (docs/uploaders.md): die Playlists, deren Seiten er ändert, und die Medienordner, in die er hochlädt. Ordner sind genau die aufgelisteten, nie deren Unterordner. Eine ID, die beim Schreiben kein aktives Objekt des Projekts benennt, ergibt invalid_request an ihrer Position; ein späteres Löschen hinterlässt eine tote ID, die nichts gewährt. Der Bereich wird bei jeder Anfrage gelesen, sodass eine Änderung ab der nächsten gilt.

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients'

Antworten

Status	Bedeutung	Textkörper und Header
201	Der Service-Client.	ServiceClientResult (application/json)
402	feature_not_in_plan — ein Upload-Bereich macht einen Uploader, und der Plan des Projekts enthält keine Uploader; required_plan nennt den Plan, der sie enthält. Das Einengen eines Bereichs und das Entfernen sind immer erlaubt.	Problem (application/problem+json)
403	outside_screen_scope - der Aufrufer ist auf Bildschirme beschränkt, und der Bildschirm, Bildschirmordner, Selektor oder die Zielgruppe, die die Anfrage nennt oder erreicht, liegt außerhalb davon (docs/screen-scope.md). Eine ID außerhalb des Bereichs und eine ID, die nicht existiert, erhalten dieselbe Antwort; errors[0].screen_scope trägt den Bereich des Aufrufers, und der Schreibvorgang wird vollständig abgelehnt, nie eingegrenzt.	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)

GET/api/service-clients/{id}¶

Service-Client erhalten

Einer der Service-Clients des Projekts. Benötigt die Projektfähigkeit.

Authentifizierung: projectBearer ODER dashboardSession
Anfrageinhalt: keine
Operations-ID: getServiceClient

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
id	Pfad	erforderlich

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID'

Antworten

Status	Bedeutung	Textkörper und Header
200	Der Service-Client.	ServiceClient (application/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)

PATCH/api/service-clients/{id}¶

Service-Client aktualisieren

Benennt einen Service-Client um oder ändert seine Berechtigungen (innerhalb der des Managers) oder den Zugriff. Eine Einschränkung beendet die aktuellen Tokens des Clients innerhalb von Sekunden.

Ein auf Bildschirme beschränktes Mitglied verbindet keine Agenten, stellt keine Zugangsdaten aus und verwaltet nicht die Personen des Projekts: outside_screen_scope (den Projektinhaber fragen).

Authentifizierung: agentIdentityBearer ODER dashboardSession
Anfrageinhalt: ServiceClientChange
Operations-ID: updateServiceClient

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
id	Pfad	erforderlich

Anfrageinhalt-Felder

Feld	Beschreibung
project_id (optional, Zeichenkette)	Nur Dashboard-Sitzung.
proof (optional, DashboardProof)
Name (optional, Zeichenkette)	minLength: 1 maxLength: 80
Fähigkeiten (optional, Array)
Zugriff (optional, String)	Verwalten erfordert eine Person, die Überprüfungen genehmigen kann (403 approver_required). Erlaubt: "lesen", "vorschlagen", "verwalten"
key (optional, object)	Ein öffentlicher JWK: OKP Ed25519, EC P-256 oder RSA mit mindestens 2048 Bit.
secret (optional, boolean)	Ein Geheimnis erzeugen (nur Erstellung).
upload_scope (optional, UploadScope)	Was ein Uploader verwenden darf (docs/uploaders.md): die Playlists, deren Seiten er ändert, und die Medienordner, in die er hochlädt. Ordner sind genau die aufgelisteten, nie deren Unterordner. Eine ID, die beim Schreiben kein aktives Objekt des Projekts benennt, ergibt invalid_request an ihrer Position; ein späteres Löschen hinterlässt eine tote ID, die nichts gewährt. Der Bereich wird bei jeder Anfrage gelesen, sodass eine Änderung ab der nächsten gilt.

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request PATCH --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID'

Antworten

Status	Bedeutung	Textkörper und Header
200	Der Service-Client.	ServiceClientResult (application/json)
402	feature_not_in_plan — ein Upload-Bereich macht einen Uploader, und der Plan des Projekts enthält keine Uploader; required_plan nennt den Plan, der sie enthält. Das Einengen eines Bereichs und das Entfernen sind immer erlaubt.	Problem (application/problem+json)
403	outside_screen_scope - der Aufrufer ist auf Bildschirme beschränkt, und der Bildschirm, Bildschirmordner, Selektor oder die Zielgruppe, die die Anfrage nennt oder erreicht, liegt außerhalb davon (docs/screen-scope.md). Eine ID außerhalb des Bereichs und eine ID, die nicht existiert, erhalten dieselbe Antwort; errors[0].screen_scope trägt den Bereich des Aufrufers, und der Schreibvorgang wird vollständig abgelehnt, nie eingegrenzt.	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)

POST/api/service-clients/{id}/keys¶

Service-Client-Schlüssel hinzufügen

Registriert einen zweiten öffentlichen JWK (Schlüssel im Body) für eine Rotation ohne Ausfallzeiten; ein Client hält höchstens zwei.

Ein auf Bildschirme beschränktes Mitglied verbindet keine Agenten, stellt keine Zugangsdaten aus und verwaltet nicht die Personen des Projekts: outside_screen_scope (den Projektinhaber fragen).

Authentifizierung: agentIdentityBearer ODER dashboardSession
Anfrageinhalt: ServiceClientChange
Operations-ID: addServiceClientKey

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
id	Pfad	erforderlich

Anfrageinhalt-Felder

Feld	Beschreibung
project_id (optional, Zeichenkette)	Nur Dashboard-Sitzung.
proof (optional, DashboardProof)
Name (optional, Zeichenkette)	minLength: 1 maxLength: 80
Fähigkeiten (optional, Array)
Zugriff (optional, String)	Verwalten erfordert eine Person, die Überprüfungen genehmigen kann (403 approver_required). Erlaubt: "lesen", "vorschlagen", "verwalten"
key (optional, object)	Ein öffentlicher JWK: OKP Ed25519, EC P-256 oder RSA mit mindestens 2048 Bit.
secret (optional, boolean)	Ein Geheimnis erzeugen (nur Erstellung).
upload_scope (optional, UploadScope)	Was ein Uploader verwenden darf (docs/uploaders.md): die Playlists, deren Seiten er ändert, und die Medienordner, in die er hochlädt. Ordner sind genau die aufgelisteten, nie deren Unterordner. Eine ID, die beim Schreiben kein aktives Objekt des Projekts benennt, ergibt invalid_request an ihrer Position; ein späteres Löschen hinterlässt eine tote ID, die nichts gewährt. Der Bereich wird bei jeder Anfrage gelesen, sodass eine Änderung ab der nächsten gilt.

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID/keys'

Antworten

Status	Bedeutung	Textkörper und Header
200	Der Service-Client.	ServiceClientResult (application/json)
403	outside_screen_scope - der Aufrufer ist auf Bildschirme beschränkt, und der Bildschirm, Bildschirmordner, Selektor oder die Zielgruppe, die die Anfrage nennt oder erreicht, liegt außerhalb davon (docs/screen-scope.md). Eine ID außerhalb des Bereichs und eine ID, die nicht existiert, erhalten dieselbe Antwort; errors[0].screen_scope trägt den Bereich des Aufrufers, und der Schreibvorgang wird vollständig abgelehnt, nie eingegrenzt.	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)

POST/api/service-clients/{id}/keys/{kid}/remove¶

Service-Client-Schlüssel entfernen

Entfernt einen Schlüssel; die aktuellen Tokens des Clients enden innerhalb von Sekunden. Ein Client behält mindestens einen Schlüssel oder ein Geheimnis.

Ein auf Bildschirme beschränktes Mitglied verbindet keine Agenten, stellt keine Zugangsdaten aus und verwaltet nicht die Personen des Projekts: outside_screen_scope (den Projektinhaber fragen).

Authentifizierung: agentIdentityBearer ODER dashboardSession
Anfrageinhalt: ServiceClientChange
Operations-ID: removeServiceClientKey

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
id	Pfad	erforderlich
kid	Pfad	erforderlich

Anfrageinhalt-Felder

Feld	Beschreibung
project_id (optional, Zeichenkette)	Nur Dashboard-Sitzung.
proof (optional, DashboardProof)
Name (optional, Zeichenkette)	minLength: 1 maxLength: 80
Fähigkeiten (optional, Array)
Zugriff (optional, String)	Verwalten erfordert eine Person, die Überprüfungen genehmigen kann (403 approver_required). Erlaubt: "lesen", "vorschlagen", "verwalten"
key (optional, object)	Ein öffentlicher JWK: OKP Ed25519, EC P-256 oder RSA mit mindestens 2048 Bit.
secret (optional, boolean)	Ein Geheimnis erzeugen (nur Erstellung).
upload_scope (optional, UploadScope)	Was ein Uploader verwenden darf (docs/uploaders.md): die Playlists, deren Seiten er ändert, und die Medienordner, in die er hochlädt. Ordner sind genau die aufgelisteten, nie deren Unterordner. Eine ID, die beim Schreiben kein aktives Objekt des Projekts benennt, ergibt invalid_request an ihrer Position; ein späteres Löschen hinterlässt eine tote ID, die nichts gewährt. Der Bereich wird bei jeder Anfrage gelesen, sodass eine Änderung ab der nächsten gilt.

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID/keys/KID/remove'

Antworten

Status	Bedeutung	Textkörper und Header
200	Der Service-Client.	ServiceClientResult (application/json)
403	outside_screen_scope - der Aufrufer ist auf Bildschirme beschränkt, und der Bildschirm, Bildschirmordner, Selektor oder die Zielgruppe, die die Anfrage nennt oder erreicht, liegt außerhalb davon (docs/screen-scope.md). Eine ID außerhalb des Bereichs und eine ID, die nicht existiert, erhalten dieselbe Antwort; errors[0].screen_scope trägt den Bereich des Aufrufers, und der Schreibvorgang wird vollständig abgelehnt, nie eingegrenzt.	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)

POST/api/service-clients/{id}/secrets¶

Service-Client-Geheimnis hinzufügen

Erzeugt ein zweites Geheimnis, das einmal zurückgegeben wird, für eine Rotation ohne Ausfallzeit; ein Client hält höchstens zwei.

Ein auf Bildschirme beschränktes Mitglied verbindet keine Agenten, stellt keine Zugangsdaten aus und verwaltet nicht die Personen des Projekts: outside_screen_scope (den Projektinhaber fragen).

Authentifizierung: agentIdentityBearer ODER dashboardSession
Anfrageinhalt: ServiceClientChange
Operations-ID: addServiceClientSecret

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
id	Pfad	erforderlich

Anfrageinhalt-Felder

Feld	Beschreibung
project_id (optional, Zeichenkette)	Nur Dashboard-Sitzung.
proof (optional, DashboardProof)
Name (optional, Zeichenkette)	minLength: 1 maxLength: 80
Fähigkeiten (optional, Array)
Zugriff (optional, String)	Verwalten erfordert eine Person, die Überprüfungen genehmigen kann (403 approver_required). Erlaubt: "lesen", "vorschlagen", "verwalten"
key (optional, object)	Ein öffentlicher JWK: OKP Ed25519, EC P-256 oder RSA mit mindestens 2048 Bit.
secret (optional, boolean)	Ein Geheimnis erzeugen (nur Erstellung).
upload_scope (optional, UploadScope)	Was ein Uploader verwenden darf (docs/uploaders.md): die Playlists, deren Seiten er ändert, und die Medienordner, in die er hochlädt. Ordner sind genau die aufgelisteten, nie deren Unterordner. Eine ID, die beim Schreiben kein aktives Objekt des Projekts benennt, ergibt invalid_request an ihrer Position; ein späteres Löschen hinterlässt eine tote ID, die nichts gewährt. Der Bereich wird bei jeder Anfrage gelesen, sodass eine Änderung ab der nächsten gilt.

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID/secrets'

Antworten

Status	Bedeutung	Textkörper und Header
200	Der Service-Client.	ServiceClientResult (application/json)
403	outside_screen_scope - der Aufrufer ist auf Bildschirme beschränkt, und der Bildschirm, Bildschirmordner, Selektor oder die Zielgruppe, die die Anfrage nennt oder erreicht, liegt außerhalb davon (docs/screen-scope.md). Eine ID außerhalb des Bereichs und eine ID, die nicht existiert, erhalten dieselbe Antwort; errors[0].screen_scope trägt den Bereich des Aufrufers, und der Schreibvorgang wird vollständig abgelehnt, nie eingegrenzt.	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)

POST/api/service-clients/{id}/secrets/{secret_id}/remove¶

Service-Client-Geheimnis entfernen

Entfernt ein Geheimnis; die aktuellen Tokens des Clients enden innerhalb von Sekunden.

Ein auf Bildschirme beschränktes Mitglied verbindet keine Agenten, stellt keine Zugangsdaten aus und verwaltet nicht die Personen des Projekts: outside_screen_scope (den Projektinhaber fragen).

Authentifizierung: agentIdentityBearer ODER dashboardSession
Anfrageinhalt: ServiceClientChange
Operations-ID: removeServiceClientSecret

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
id	Pfad	erforderlich
secret_id	Pfad	erforderlich

Anfrageinhalt-Felder

Feld	Beschreibung
project_id (optional, Zeichenkette)	Nur Dashboard-Sitzung.
proof (optional, DashboardProof)
Name (optional, Zeichenkette)	minLength: 1 maxLength: 80
Fähigkeiten (optional, Array)
Zugriff (optional, String)	Verwalten erfordert eine Person, die Überprüfungen genehmigen kann (403 approver_required). Erlaubt: "lesen", "vorschlagen", "verwalten"
key (optional, object)	Ein öffentlicher JWK: OKP Ed25519, EC P-256 oder RSA mit mindestens 2048 Bit.
secret (optional, boolean)	Ein Geheimnis erzeugen (nur Erstellung).
upload_scope (optional, UploadScope)	Was ein Uploader verwenden darf (docs/uploaders.md): die Playlists, deren Seiten er ändert, und die Medienordner, in die er hochlädt. Ordner sind genau die aufgelisteten, nie deren Unterordner. Eine ID, die beim Schreiben kein aktives Objekt des Projekts benennt, ergibt invalid_request an ihrer Position; ein späteres Löschen hinterlässt eine tote ID, die nichts gewährt. Der Bereich wird bei jeder Anfrage gelesen, sodass eine Änderung ab der nächsten gilt.

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID/secrets/SECRET_ID/remove'

Antworten

Status	Bedeutung	Textkörper und Header
200	Der Service-Client.	ServiceClientResult (application/json)
403	outside_screen_scope - der Aufrufer ist auf Bildschirme beschränkt, und der Bildschirm, Bildschirmordner, Selektor oder die Zielgruppe, die die Anfrage nennt oder erreicht, liegt außerhalb davon (docs/screen-scope.md). Eine ID außerhalb des Bereichs und eine ID, die nicht existiert, erhalten dieselbe Antwort; errors[0].screen_scope trägt den Bereich des Aufrufers, und der Schreibvorgang wird vollständig abgelehnt, nie eingegrenzt.	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)

POST/api/service-clients/{id}/revoke¶

Service-Client widerrufen

Widerruft einen Service-Client dauerhaft: dessen Schlüssel und geheime Digests werden gelöscht, der Datensatz bleibt zur Prüfung erhalten, und seine Tokens enden innerhalb von Sekunden (Propagation angewendet oder ausstehend).

Ein auf Bildschirme beschränktes Mitglied verbindet keine Agenten, stellt keine Zugangsdaten aus und verwaltet nicht die Personen des Projekts: outside_screen_scope (den Projektinhaber fragen).

Authentifizierung: agentIdentityBearer ODER dashboardSession
Anfrageinhalt: ServiceClientChange
Operations-ID: revokeServiceClient

Parameter

Name	Senden	Erforderlich?	Beschreibung
ScreenRig-Project	Überschrift	optional	Für eine Veröffentlichung veraltet. Muss mit den JWT-Projektberechtigungen übereinstimmen; fügt Deprecation- und Warning-Header hinzu. Kein Token-Austausch.
id	Pfad	erforderlich

Anfrageinhalt-Felder

Feld	Beschreibung
project_id (optional, Zeichenkette)	Nur Dashboard-Sitzung.
proof (optional, DashboardProof)
Name (optional, Zeichenkette)	minLength: 1 maxLength: 80
Fähigkeiten (optional, Array)
Zugriff (optional, String)	Verwalten erfordert eine Person, die Überprüfungen genehmigen kann (403 approver_required). Erlaubt: "lesen", "vorschlagen", "verwalten"
key (optional, object)	Ein öffentlicher JWK: OKP Ed25519, EC P-256 oder RSA mit mindestens 2048 Bit.
secret (optional, boolean)	Ein Geheimnis erzeugen (nur Erstellung).
upload_scope (optional, UploadScope)	Was ein Uploader verwenden darf (docs/uploaders.md): die Playlists, deren Seiten er ändert, und die Medienordner, in die er hochlädt. Ordner sind genau die aufgelisteten, nie deren Unterordner. Eine ID, die beim Schreiben kein aktives Objekt des Projekts benennt, ergibt invalid_request an ihrer Position; ein späteres Löschen hinterlässt eine tote ID, die nichts gewährt. Der Bereich wird bei jeder Anfrage gelesen, sodass eine Änderung ab der nächsten gilt.

Anfragevorlage und Antworten

Shell · Anfragevorlage

curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID/revoke'

Antworten

Status	Bedeutung	Textkörper und Header
200	Der Service-Client.	ServiceClientResult (application/json)
403	outside_screen_scope - der Aufrufer ist auf Bildschirme beschränkt, und der Bildschirm, Bildschirmordner, Selektor oder die Zielgruppe, die die Anfrage nennt oder erreicht, liegt außerhalb davon (docs/screen-scope.md). Eine ID außerhalb des Bereichs und eine ID, die nicht existiert, erhalten dieselbe Antwort; errors[0].screen_scope trägt den Bereich des Aufrufers, und der Schreibvorgang wird vollständig abgelehnt, nie eingegrenzt.	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)