OpenAPI YAMLOpenAPI JSONproblemi YAMLPanoramica dell’API
Questo gruppo ha 9 operazioni, generate da api/openapi.yaml. Filtra per percorso, azione o autenticazione. Ogni endpoint elenca i suoi input; espandilo per vedere un modello di richiesta e i codici di risposta. I modelli richiedono i tuoi valori e un corpo valido secondo lo schema.
Sostituisci i segnaposto maiuscoli con i tuoi valori. Per una richiesta JSON, salva un corpo che corrisponde allo schema in request.json. Gli esempi di cookie usano un cookie jar locale da una sessione autenticata.
Client di servizio
Elenca i client di servizio
I client di servizio del progetto (spec: server, script o job CI di un cliente posseduti dal progetto), dal più recente, attivi e revocati, con le loro chiavi pubbliche, id segreti e uso; mai un segreto o il suo digest. Richiede la capacità del progetto.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
Modello richiesta e risposte
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/service-clients'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Il client di servizio. | ServiceClientList (application/json) |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
Crea client di servizio
Crea un client di servizio di proprietà del progetto con un nome, capacità (omesse significano tutte e sei; ciascuna deve essere posseduta dal gestore, altrimenti 403), accesso (lettura, predefinito, o gestione) e una chiave JWK pubblica (OKP Ed25519, EC P-256 o RSA di almeno 2048 bit) e/o segreto vero. Il segreto è restituito una sola volta, solo qui. Al massimo 50 client attivi per organizzazione.
Gli agenti necessitano di ambito identità, identità live Gestisci, la propria concessione Gestisci con la capacità progetto sul progetto, e un ruolo amministratore live nell’organizzazione; una persona usa la sessione dashboard con project_id e una prova fresca (tipo service_client_change, soggetto l’id client o l’id progetto alla creazione) nel corpo. Un token di servizio è rifiutato con 403.
Un membro limitato agli schermi non collega agenti, non emette credenziali e non gestisce le persone del progetto: outside_screen_scope (chiedi al proprietario del progetto).
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
Campi del corpo della richiesta
| Campo | Descrizione |
|---|---|
| project_id (opzionale, stringa) | Solo sessione dashboard. |
| proof (opzionale, DashboardProof) | |
| nome (opzionale, stringa) | minLength: 1 maxLength: 80 |
| capacità (opzionale, array) | |
| accesso (opzionale, stringa) | Gestire richiede una persona che possa approvare revisioni (403 approver_required). Consentito: "read", "propose", "manage" |
| key (opzionale, oggetto) | Una JWK pubblica: OKP Ed25519, EC P-256 o RSA di almeno 2048 bit. |
| segreto (opzionale, booleano) | Genera un segreto (solo creazione). |
| upload_scope (opzionale, UploadScope) | Ciò che un uploader può usare (docs/uploaders.md): le playlist di cui modifica le pagine e le cartelle media in cui carica. Le cartelle sono esattamente quelle elencate, mai le loro sottocartelle. Un id che al momento della scrittura non indica alcun oggetto attivo del progetto è invalid_request alla sua posizione; una successiva eliminazione lascia un id morto, che non concede nulla. L’ambito viene letto a ogni richiesta, quindi una modifica si applica alla successiva. |
Modello richiesta e risposte
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'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 201 | Il client di servizio. | ServiceClientResult (application/json) |
| 402 | feature_not_in_plan — un ambito di upload crea un uploader, e il piano del progetto non include gli uploader; required_plan indica il piano che li include. Restringere un ambito e rimuoverlo sono sempre consentiti. | Problema (application/problem+json) |
| 403 | outside_screen_scope - il chiamante è limitato agli schermi e lo schermo, la cartella di schermi, il selettore o il pubblico che la richiesta nomina o raggiunge è fuori da essi (docs/screen-scope.md). Un id fuori dall’ambito e un id che non esiste ricevono la stessa risposta; errors[0].screen_scope riporta l’ambito del chiamante, e la scrittura viene rifiutata per intero, mai ridotta. | Problema (application/problem+json) |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
Ottieni client servizio
Uno dei client di servizio del progetto. Richiede la capacità progetto.
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| id | path | obbligatorio |
Modello richiesta e risposte
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Il client di servizio. | ServiceClient (application/json) |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
Aggiorna cliente servizio
Rinomina un client di servizio o modifica le sue capacità (entro quelle del manager) o l’accesso. Restringere uno dei due termina i token correnti del client entro pochi secondi.
Gli agenti necessitano di ambito identità, identità live Gestisci, la propria concessione Gestisci con la capacità progetto sul progetto, e un ruolo amministratore live nell’organizzazione; una persona usa la sessione dashboard con project_id e una prova fresca (tipo service_client_change, soggetto l’id client o l’id progetto alla creazione) nel corpo. Un token di servizio è rifiutato con 403.
Un membro limitato agli schermi non collega agenti, non emette credenziali e non gestisce le persone del progetto: outside_screen_scope (chiedi al proprietario del progetto).
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| id | path | obbligatorio |
Campi del corpo della richiesta
| Campo | Descrizione |
|---|---|
| project_id (opzionale, stringa) | Solo sessione dashboard. |
| proof (opzionale, DashboardProof) | |
| nome (opzionale, stringa) | minLength: 1 maxLength: 80 |
| capacità (opzionale, array) | |
| accesso (opzionale, stringa) | Gestire richiede una persona che possa approvare revisioni (403 approver_required). Consentito: "read", "propose", "manage" |
| key (opzionale, oggetto) | Una JWK pubblica: OKP Ed25519, EC P-256 o RSA di almeno 2048 bit. |
| segreto (opzionale, booleano) | Genera un segreto (solo creazione). |
| upload_scope (opzionale, UploadScope) | Ciò che un uploader può usare (docs/uploaders.md): le playlist di cui modifica le pagine e le cartelle media in cui carica. Le cartelle sono esattamente quelle elencate, mai le loro sottocartelle. Un id che al momento della scrittura non indica alcun oggetto attivo del progetto è invalid_request alla sua posizione; una successiva eliminazione lascia un id morto, che non concede nulla. L’ambito viene letto a ogni richiesta, quindi una modifica si applica alla successiva. |
Modello richiesta e risposte
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'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Il client di servizio. | ServiceClientResult (application/json) |
| 402 | feature_not_in_plan — un ambito di upload crea un uploader, e il piano del progetto non include gli uploader; required_plan indica il piano che li include. Restringere un ambito e rimuoverlo sono sempre consentiti. | Problema (application/problem+json) |
| 403 | outside_screen_scope - il chiamante è limitato agli schermi e lo schermo, la cartella di schermi, il selettore o il pubblico che la richiesta nomina o raggiunge è fuori da essi (docs/screen-scope.md). Un id fuori dall’ambito e un id che non esiste ricevono la stessa risposta; errors[0].screen_scope riporta l’ambito del chiamante, e la scrittura viene rifiutata per intero, mai ridotta. | Problema (application/problem+json) |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
Aggiungi chiave client di servizio
Registra una seconda JWK pubblica (chiave nel corpo) per una rotazione senza interruzioni; un client ne detiene al massimo due.
Gli agenti necessitano di ambito identità, identità live Gestisci, la propria concessione Gestisci con la capacità progetto sul progetto, e un ruolo amministratore live nell’organizzazione; una persona usa la sessione dashboard con project_id e una prova fresca (tipo service_client_change, soggetto l’id client o l’id progetto alla creazione) nel corpo. Un token di servizio è rifiutato con 403.
Un membro limitato agli schermi non collega agenti, non emette credenziali e non gestisce le persone del progetto: outside_screen_scope (chiedi al proprietario del progetto).
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| id | path | obbligatorio |
Campi del corpo della richiesta
| Campo | Descrizione |
|---|---|
| project_id (opzionale, stringa) | Solo sessione dashboard. |
| proof (opzionale, DashboardProof) | |
| nome (opzionale, stringa) | minLength: 1 maxLength: 80 |
| capacità (opzionale, array) | |
| accesso (opzionale, stringa) | Gestire richiede una persona che possa approvare revisioni (403 approver_required). Consentito: "read", "propose", "manage" |
| key (opzionale, oggetto) | Una JWK pubblica: OKP Ed25519, EC P-256 o RSA di almeno 2048 bit. |
| segreto (opzionale, booleano) | Genera un segreto (solo creazione). |
| upload_scope (opzionale, UploadScope) | Ciò che un uploader può usare (docs/uploaders.md): le playlist di cui modifica le pagine e le cartelle media in cui carica. Le cartelle sono esattamente quelle elencate, mai le loro sottocartelle. Un id che al momento della scrittura non indica alcun oggetto attivo del progetto è invalid_request alla sua posizione; una successiva eliminazione lascia un id morto, che non concede nulla. L’ambito viene letto a ogni richiesta, quindi una modifica si applica alla successiva. |
Modello richiesta e risposte
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'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Il client di servizio. | ServiceClientResult (application/json) |
| 403 | outside_screen_scope - il chiamante è limitato agli schermi e lo schermo, la cartella di schermi, il selettore o il pubblico che la richiesta nomina o raggiunge è fuori da essi (docs/screen-scope.md). Un id fuori dall’ambito e un id che non esiste ricevono la stessa risposta; errors[0].screen_scope riporta l’ambito del chiamante, e la scrittura viene rifiutata per intero, mai ridotta. | Problema (application/problem+json) |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
Rimuovi chiave client servizio
Rimuove una chiave; i token correnti del client terminano in pochi secondi. Un client mantiene almeno una chiave o un segreto.
Gli agenti necessitano di ambito identità, identità live Gestisci, la propria concessione Gestisci con la capacità progetto sul progetto, e un ruolo amministratore live nell’organizzazione; una persona usa la sessione dashboard con project_id e una prova fresca (tipo service_client_change, soggetto l’id client o l’id progetto alla creazione) nel corpo. Un token di servizio è rifiutato con 403.
Un membro limitato agli schermi non collega agenti, non emette credenziali e non gestisce le persone del progetto: outside_screen_scope (chiedi al proprietario del progetto).
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| id | path | obbligatorio | |
| kid | path | obbligatorio |
Campi del corpo della richiesta
| Campo | Descrizione |
|---|---|
| project_id (opzionale, stringa) | Solo sessione dashboard. |
| proof (opzionale, DashboardProof) | |
| nome (opzionale, stringa) | minLength: 1 maxLength: 80 |
| capacità (opzionale, array) | |
| accesso (opzionale, stringa) | Gestire richiede una persona che possa approvare revisioni (403 approver_required). Consentito: "read", "propose", "manage" |
| key (opzionale, oggetto) | Una JWK pubblica: OKP Ed25519, EC P-256 o RSA di almeno 2048 bit. |
| segreto (opzionale, booleano) | Genera un segreto (solo creazione). |
| upload_scope (opzionale, UploadScope) | Ciò che un uploader può usare (docs/uploaders.md): le playlist di cui modifica le pagine e le cartelle media in cui carica. Le cartelle sono esattamente quelle elencate, mai le loro sottocartelle. Un id che al momento della scrittura non indica alcun oggetto attivo del progetto è invalid_request alla sua posizione; una successiva eliminazione lascia un id morto, che non concede nulla. L’ambito viene letto a ogni richiesta, quindi una modifica si applica alla successiva. |
Modello richiesta e risposte
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'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Il client di servizio. | ServiceClientResult (application/json) |
| 403 | outside_screen_scope - il chiamante è limitato agli schermi e lo schermo, la cartella di schermi, il selettore o il pubblico che la richiesta nomina o raggiunge è fuori da essi (docs/screen-scope.md). Un id fuori dall’ambito e un id che non esiste ricevono la stessa risposta; errors[0].screen_scope riporta l’ambito del chiamante, e la scrittura viene rifiutata per intero, mai ridotta. | Problema (application/problem+json) |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
Aggiungi segreto client di servizio
Genera un secondo segreto, restituito una sola volta, per una rotazione a zero interruzioni; un client detiene al massimo due segreti.
Gli agenti necessitano di ambito identità, identità live Gestisci, la propria concessione Gestisci con la capacità progetto sul progetto, e un ruolo amministratore live nell’organizzazione; una persona usa la sessione dashboard con project_id e una prova fresca (tipo service_client_change, soggetto l’id client o l’id progetto alla creazione) nel corpo. Un token di servizio è rifiutato con 403.
Un membro limitato agli schermi non collega agenti, non emette credenziali e non gestisce le persone del progetto: outside_screen_scope (chiedi al proprietario del progetto).
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| id | path | obbligatorio |
Campi del corpo della richiesta
| Campo | Descrizione |
|---|---|
| project_id (opzionale, stringa) | Solo sessione dashboard. |
| proof (opzionale, DashboardProof) | |
| nome (opzionale, stringa) | minLength: 1 maxLength: 80 |
| capacità (opzionale, array) | |
| accesso (opzionale, stringa) | Gestire richiede una persona che possa approvare revisioni (403 approver_required). Consentito: "read", "propose", "manage" |
| key (opzionale, oggetto) | Una JWK pubblica: OKP Ed25519, EC P-256 o RSA di almeno 2048 bit. |
| segreto (opzionale, booleano) | Genera un segreto (solo creazione). |
| upload_scope (opzionale, UploadScope) | Ciò che un uploader può usare (docs/uploaders.md): le playlist di cui modifica le pagine e le cartelle media in cui carica. Le cartelle sono esattamente quelle elencate, mai le loro sottocartelle. Un id che al momento della scrittura non indica alcun oggetto attivo del progetto è invalid_request alla sua posizione; una successiva eliminazione lascia un id morto, che non concede nulla. L’ambito viene letto a ogni richiesta, quindi una modifica si applica alla successiva. |
Modello richiesta e risposte
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'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Il client di servizio. | ServiceClientResult (application/json) |
| 403 | outside_screen_scope - il chiamante è limitato agli schermi e lo schermo, la cartella di schermi, il selettore o il pubblico che la richiesta nomina o raggiunge è fuori da essi (docs/screen-scope.md). Un id fuori dall’ambito e un id che non esiste ricevono la stessa risposta; errors[0].screen_scope riporta l’ambito del chiamante, e la scrittura viene rifiutata per intero, mai ridotta. | Problema (application/problem+json) |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
Rimuovi segreto client servizio
Rimuove un segreto; i token correnti del client terminano in pochi secondi.
Gli agenti necessitano di ambito identità, identità live Gestisci, la propria concessione Gestisci con la capacità progetto sul progetto, e un ruolo amministratore live nell’organizzazione; una persona usa la sessione dashboard con project_id e una prova fresca (tipo service_client_change, soggetto l’id client o l’id progetto alla creazione) nel corpo. Un token di servizio è rifiutato con 403.
Un membro limitato agli schermi non collega agenti, non emette credenziali e non gestisce le persone del progetto: outside_screen_scope (chiedi al proprietario del progetto).
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| id | path | obbligatorio | |
| secret_id | path | obbligatorio |
Campi del corpo della richiesta
| Campo | Descrizione |
|---|---|
| project_id (opzionale, stringa) | Solo sessione dashboard. |
| proof (opzionale, DashboardProof) | |
| nome (opzionale, stringa) | minLength: 1 maxLength: 80 |
| capacità (opzionale, array) | |
| accesso (opzionale, stringa) | Gestire richiede una persona che possa approvare revisioni (403 approver_required). Consentito: "read", "propose", "manage" |
| key (opzionale, oggetto) | Una JWK pubblica: OKP Ed25519, EC P-256 o RSA di almeno 2048 bit. |
| segreto (opzionale, booleano) | Genera un segreto (solo creazione). |
| upload_scope (opzionale, UploadScope) | Ciò che un uploader può usare (docs/uploaders.md): le playlist di cui modifica le pagine e le cartelle media in cui carica. Le cartelle sono esattamente quelle elencate, mai le loro sottocartelle. Un id che al momento della scrittura non indica alcun oggetto attivo del progetto è invalid_request alla sua posizione; una successiva eliminazione lascia un id morto, che non concede nulla. L’ambito viene letto a ogni richiesta, quindi una modifica si applica alla successiva. |
Modello richiesta e risposte
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'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Il client di servizio. | ServiceClientResult (application/json) |
| 403 | outside_screen_scope - il chiamante è limitato agli schermi e lo schermo, la cartella di schermi, il selettore o il pubblico che la richiesta nomina o raggiunge è fuori da essi (docs/screen-scope.md). Un id fuori dall’ambito e un id che non esiste ricevono la stessa risposta; errors[0].screen_scope riporta l’ambito del chiamante, e la scrittura viene rifiutata per intero, mai ridotta. | Problema (application/problem+json) |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |
Revoca client di servizio
Revoca permanentemente un client di servizio: le sue chiavi e i digest segreti sono cancellati, il record resta per audit e i suoi token terminano entro secondi (propagazione applicata o in sospeso).
Gli agenti necessitano di ambito identità, identità live Gestisci, la propria concessione Gestisci con la capacità progetto sul progetto, e un ruolo amministratore live nell’organizzazione; una persona usa la sessione dashboard con project_id e una prova fresca (tipo service_client_change, soggetto l’id client o l’id progetto alla creazione) nel corpo. Un token di servizio è rifiutato con 403.
Un membro limitato agli schermi non collega agenti, non emette credenziali e non gestisce le persone del progetto: outside_screen_scope (chiedi al proprietario del progetto).
Parametri
| Nome | Invia | Obbligatorio? | Descrizione |
|---|---|---|---|
| ScreenRig-Project | intestazione | opzionale | Deprecato per una release. Deve essere coerente con le concessioni JWT dei progetti; aggiunge intestazioni Deprecation e Warning. Nessuno scambio di token. |
| id | path | obbligatorio |
Campi del corpo della richiesta
| Campo | Descrizione |
|---|---|
| project_id (opzionale, stringa) | Solo sessione dashboard. |
| proof (opzionale, DashboardProof) | |
| nome (opzionale, stringa) | minLength: 1 maxLength: 80 |
| capacità (opzionale, array) | |
| accesso (opzionale, stringa) | Gestire richiede una persona che possa approvare revisioni (403 approver_required). Consentito: "read", "propose", "manage" |
| key (opzionale, oggetto) | Una JWK pubblica: OKP Ed25519, EC P-256 o RSA di almeno 2048 bit. |
| segreto (opzionale, booleano) | Genera un segreto (solo creazione). |
| upload_scope (opzionale, UploadScope) | Ciò che un uploader può usare (docs/uploaders.md): le playlist di cui modifica le pagine e le cartelle media in cui carica. Le cartelle sono esattamente quelle elencate, mai le loro sottocartelle. Un id che al momento della scrittura non indica alcun oggetto attivo del progetto è invalid_request alla sua posizione; una successiva eliminazione lascia un id morto, che non concede nulla. L’ambito viene letto a ogni richiesta, quindi una modifica si applica alla successiva. |
Modello richiesta e risposte
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'Risposte
| Stato | Significato | Corpo e intestazioni |
|---|---|---|
| 200 | Il client di servizio. | ServiceClientResult (application/json) |
| 403 | outside_screen_scope - il chiamante è limitato agli schermi e lo schermo, la cartella di schermi, il selettore o il pubblico che la richiesta nomina o raggiunge è fuori da essi (docs/screen-scope.md). Un id fuori dall’ambito e un id che non esiste ricevono la stessa risposta; errors[0].screen_scope riporta l’ambito del chiamante, e la scrittura viene rifiutata per intero, mai ridotta. | Problema (application/problem+json) |
| predefinito | Risposta problema stabile RFC 9457. Un 421 server_draining ha Retry-After di 1 secondo, un 500 not_ready o dependency_unavailable ha 5, e un 500 manifest_degraded ha 60, salvo valore più specifico impostato dal gestore. | Problema (application/problem+json) |