Provisioning utenti: riferimento API, endpoint ed esempi

OpenAPI YAML OpenAPI JSON problemi YAML Panoramica dell’API

Questo gruppo ha 24 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.

Provisioning utenti: SCIM 2.0, token e associazioni di gruppo

GET/api/organizations/{org_id}/scim¶

Dashboard Organizzazioni Ottieni SCIM

Un amministratore designato legge le impostazioni di provisioning SCIM dell’organizzazione: se è abilitato, il base URL da inserire nel provider di identità (sull’origine dell’API), i token di provisioning attivi senza i loro segreti e il numero di utenti e gruppi provisionati. Solo persone; agenti e credenziali bearer non hanno alcuna rotta.

Autenticazione: dashboardSession
Corpo della richiesta: nessuno
ID operazione: dashboardOrganizationsGetSCIM

Parametri

Nome	Invia	Obbligatorio?	Descrizione
org_id	path	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/scim'

Risposte

Stato	Significato	Corpo e intestazioni
200	Le impostazioni SCIM dell’organizzazione.	SCIMSettings (application/json); intestazioni: Cache-Control
401	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)
403	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)
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)

PUT/api/organizations/{org_id}/scim¶

Dashboard Organizzazioni Imposta SCIM

Un amministratore designato abilita o disabilita il provisioning SCIM dopo una prova recente: una prova recente con passkey o password legata a una riautenticazione di tipo scim_change con l’id dell’organizzazione come subject_id, oppure {type: sso} da una sessione che ha effettuato l’accesso tramite single sign-on al massimo 10 minuti fa.

La disabilitazione non cambia l’accesso di nessuno: le persone e i gruppi già provisionati mantengono le proprie concessioni, e le rotte /scim/v2 rispondono 403 finché SCIM non viene abilitato di nuovo. Restituisce le impostazioni.

Solo persone; agenti e credenziali bearer non hanno alcuna rotta. enabled true rientra nel provisioning SCIM, che il piano Enterprise include; un’organizzazione il cui piano ne è privo viene rifiutata con feature_not_in_plan (402). enabled false è sempre accettato, e le rotte /scim/v2 di un’organizzazione che ha SCIM attivo continuano a rispondere.

Autenticazione: dashboardSession
Corpo della richiesta: SCIMSettingsWrite
ID operazione: dashboardOrganizationsSetSCIM

Parametri

Nome	Invia	Obbligatorio?	Descrizione
org_id	path	obbligatorio

Campi del corpo della richiesta

Campo	Descrizione
abilitato (obbligatorio, booleano)
proof (obbligatorio, DashboardProof)

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Le impostazioni SCIM dell’organizzazione.	SCIMSettings (application/json); intestazioni: Cache-Control
400	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)
401	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)
402	feature_not_in_plan — Il provisioning SCIM fa parte del piano Enterprise; il problema indica la funzione, il piano dell’account e required_plan.	Problema (application/problem+json)
403	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)
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)

POST/api/organizations/{org_id}/scim/tokens¶

Dashboard Organizzazioni Crea Token SCIM

Un amministratore designato emette un token di provisioning dopo una prova recente (come per PUT .../scim). Il token, srscim_ più 43 caratteri base64url, è restituito una sola volta, solo qui; il server conserva un digest SHA-256 e un prefisso con cui riconoscerlo. Un’organizzazione ha al massimo 5 token attivi, altrimenti resource_conflict.

Solo persone; agenti e credenziali bearer non hanno alcuna rotta. Emettere un token rientra nel provisioning SCIM, che il piano Enterprise include; un’organizzazione il cui piano ne è privo viene rifiutata con feature_not_in_plan (402). I token già emessi continuano a funzionare e possono essere revocati.

Autenticazione: dashboardSession
Corpo della richiesta: SCIMTokenCreate
ID operazione: dashboardOrganizationsCreateSCIMToken

Parametri

Nome	Invia	Obbligatorio?	Descrizione
org_id	path	obbligatorio

Campi del corpo della richiesta

Campo	Descrizione
nome (obbligatorio, stringa)	minLength: 1 maxLength: 80
proof (obbligatorio, DashboardProof)

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
201	Il nuovo token, con il suo segreto.	SCIMTokenCreated (application/json); intestazioni: Cache-Control
400	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)
401	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)
402	feature_not_in_plan — Il provisioning SCIM fa parte del piano Enterprise; il problema indica la funzione, il piano dell’account e required_plan.	Problema (application/problem+json)
403	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)
409	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)
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)

ELIMINA/api/organizations/{org_id}/scim/tokens/{token_id}¶

Dashboard Organizzazioni Revoca Token SCIM

Un amministratore designato revoca un token di provisioning; da quel momento le richieste che lo presentano sono rifiutate con 401. Un token già revocato restituisce 204; un id che l’organizzazione non possiede è not_found. Solo persone; agenti e credenziali bearer non hanno alcuna rotta.

Autenticazione: dashboardSession
Corpo della richiesta: nessuno
ID operazione: dashboardOrganizationsRevokeSCIMToken

Parametri

Nome	Invia	Obbligatorio?	Descrizione
org_id	path	obbligatorio
token_id	path	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/scim/tokens/TOKEN_ID'

Risposte

Stato	Significato	Corpo e intestazioni
204	Il token è revocato.	nessun corpo
401	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)
403	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)
404	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)
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)

GET/api/organizations/{org_id}/scim/groups¶

Dashboard Organizzazioni Elenca Gruppi SCIM

Un amministratore designato elenca i gruppi che il provider di identità ha provisionato, con il numero dei loro membri e i progetti a cui ciascuno è associato. L’associazione si fa nel progetto (createDashboardGroupBinding) da una persona che può approvare lì; un amministratore vede solo le associazioni e i nomi dei progetti, il che non concede alcun accesso ai progetti.

Solo persone; agenti e credenziali bearer non hanno alcuna rotta.

Autenticazione: dashboardSession
Corpo della richiesta: nessuno
ID operazione: dashboardOrganizationsListSCIMGroups

Parametri

Nome	Invia	Obbligatorio?	Descrizione
org_id	path	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/scim/groups'

Risposte

Stato	Significato	Corpo e intestazioni
200	I gruppi provisionati dell’organizzazione.	SCIMGroupList (application/json); intestazioni: Cache-Control
401	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)
403	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)
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)

GET/api/organizations/{org_id}/scim/events¶

Dashboard Organizzazioni Elenca Eventi SCIM

Un amministratore designato legge le ultime 500 richieste effettuate dai client SCIM dell’organizzazione, dalla più recente, errori inclusi, conservate per 30 giorni. Ogni riga indica l’operazione, la risorsa e lo stato, e riporta un dettaglio quando la richiesta è fallita. Solo persone; agenti e credenziali bearer non hanno alcuna rotta.

Autenticazione: dashboardSession
Corpo della richiesta: nessuno
ID operazione: dashboardOrganizationsListSCIMEvents

Parametri

Nome	Invia	Obbligatorio?	Descrizione
org_id	path	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/scim/events'

Risposte

Stato	Significato	Corpo e intestazioni
200	Gli ultimi eventi SCIM dell’organizzazione.	SCIMEventList (application/json); intestazioni: Cache-Control
401	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)
403	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)
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)

GET/api/project/group-bindings¶

Elenca associazioni di gruppo dashboard

Le associazioni di gruppo del progetto della sessione e i gruppi che il provider di identità della sua organizzazione ha provisionato (nome e numero di membri) tra cui scegliere.

Un’associazione dà a ogni membro del gruppo un’appartenenza a questo progetto: il ruolo member è un’appartenenza semplice e il ruolo approver permette inoltre alla persona di approvare le revisioni, per l’intero progetto o per lo screen_scope dell’associazione. Una persona raggiunta da più associazioni del progetto ha l’unione dei loro ambiti, e un’associazione senza ambito dà l’intero progetto.

La persona approva le revisioni solo quando l’unione degli ambiti delle sue associazioni Approvatore (con quello di una concessione manuale di approvazione) copre l’intera unione, ed è membro altrimenti; SCIM non riduce mai una concessione manuale: un’associazione che lo farebbe non viene applicata alla persona e viene registrata come evento SCIM non riuscito.

Qualsiasi membro del progetto può leggere, tranne un chiamante limitato agli schermi (outside_screen_scope).

Autenticazione: dashboardSession
Corpo della richiesta: nessuno
ID operazione: listDashboardGroupBindings

Modello richiesta e risposte

shell · modello richiesta

curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/project/group-bindings'

Risposte

Stato	Significato	Corpo e intestazioni
200	Le associazioni del progetto e i gruppi dell’organizzazione.	GroupBindingList (application/json); intestazioni: Cache-Control
401	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)
409	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)
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)

POST/api/project/group-bindings¶

Crea associazione di gruppo dashboard

Associa un gruppo provisionato al progetto della sessione con un ruolo e, facoltativamente, uno screen_scope che lo limita a cartelle di schermi e schermi (fisso una volta creato; invalid_request indica il campo di un id che il progetto non possiede).

Solo il proprietario del progetto o un membro che può approvare (altrimenti approver_required; un chiamante limitato agli schermi riceve outside_screen_scope); un amministratore dell’organizzazione del progetto associa come tale membro, quindi chi non può approvare entra prima nel progetto (POST /api/organizations/{org_id}/projects/{project_id}/access lo rende approvatore), e l’associazione viene poi registrata nell’audit dell’organizzazione, contrassegnata con by_organization_admin nell’audit del progetto, e il proprietario del progetto riceve un’email; una sessione shadow dello staff è di sola lettura.

Il gruppo deve essere uno dei gruppi provisionati dell’organizzazione del progetto, altrimenti not_found, e un gruppo è associato a un progetto una sola volta, altrimenti resource_conflict. L’associazione ha effetto subito per i membri attuali del gruppo e segue ogni modifica dell’appartenenza al gruppo.

Si applica il limite di 200 membri del progetto: una persona che esso rifiuta viene registrata come evento fallito negli eventi SCIM dell’organizzazione e nient’altro cambia; lo stesso vale per una persona che sarebbe un ospite esterno che la policy per gli ospiti dell’organizzazione non ammette (guest_not_allowed).

Una modifica dell’ambito effettuata da un’associazione aggiunge project.member_screen_scope_changed (dettagli user_id, screen_scope, previous, via scim, changed_by_user_id vuoto). Associare un gruppo rientra nel provisioning SCIM, che il piano Enterprise include; un progetto il cui piano ne è privo viene rifiutato con feature_not_in_plan (402). Le associazioni esistenti continuano a concedere e possono essere rimosse.

Autenticazione: dashboardSession
Corpo della richiesta: GroupBindingCreate
ID operazione: createDashboardGroupBinding

Campi del corpo della richiesta

Campo	Descrizione
group_id (obbligatorio, stringa)	minLength: 1 maxLength: 200
role (obbligatorio, stringa)	Consentito: "approver", "member"
screen_scope (opzionale, ScreenScope)	Su che cosa può agire un membro o un agente con ambito (docs/screen-scope.md): gli schermi nelle cartelle di schermi elencate e in ogni cartella al loro interno, e gli schermi elencati. Almeno un id in tutto. Un id che al momento della scrittura non indica alcuna cartella o schermo live del progetto è invalid_request nella sua posizione; un’eliminazione successiva lascia un id morto, che non concede nulla. L’ambito viene letto a ogni richiesta, quindi una modifica si applica alla successiva. I tag non sono mai ambito.

Campo

Descrizione

group_id (obbligatorio, stringa)

minLength: 1 maxLength: 200

role (obbligatorio, stringa)

Consentito: "approver", "member"

screen_scope (opzionale, ScreenScope)

Su che cosa può agire un membro o un agente con ambito (docs/screen-scope.md): gli schermi nelle cartelle di schermi elencate e in ogni cartella al loro interno, e gli schermi elencati. Almeno un id in tutto. Un id che al momento della scrittura non indica alcuna cartella o schermo live del progetto è invalid_request nella sua posizione; un’eliminazione successiva lascia un id morto, che non concede nulla.

L’ambito viene letto a ogni richiesta, quindi una modifica si applica alla successiva. I tag non sono mai ambito.

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
201	La nuova associazione.	GroupBinding (application/json); intestazioni: Cache-Control
400	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)
401	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)
402	feature_not_in_plan — Il provisioning SCIM fa parte del piano Enterprise; il problema indica la funzione, il piano dell’account e required_plan.	Problema (application/problem+json)
403	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)
404	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)
409	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)
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)

ELIMINA/api/project/group-bindings/{binding_id}¶

Elimina associazione di gruppo dashboard

Dissocia un gruppo dal progetto della sessione. Solo il proprietario del progetto o un membro che può approvare (altrimenti approver_required); un amministratore dell’organizzazione del progetto dissocia come tale membro, registrato come lo è un’associazione.

Le persone che avevano accesso solo tramite l’associazione lo perdono; un’appartenenza concessa manualmente resta, e una concessione manuale che l’associazione aveva elevato o ampliato torna a quella che era, ambito di schermi incluso. Un id che il progetto non possiede è not_found.

Autenticazione: dashboardSession
Corpo della richiesta: nessuno
ID operazione: deleteDashboardGroupBinding

Parametri

Nome	Invia	Obbligatorio?	Descrizione
binding_id	path	obbligatorio

Modello richiesta e risposte

shell · modello richiesta

curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/project/group-bindings/BINDING_ID'

Risposte

Stato	Significato	Corpo e intestazioni
204	L’associazione è rimossa e l’accesso che concedeva è revocato.	nessun corpo
401	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)
403	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)
404	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)
409	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)
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)

GET/scim/v2/ServiceProviderConfig¶

Ottieni configurazione service provider SCIM

Il ServiceProviderConfig RFC 7643 del servizio SCIM dell’organizzazione: patch e filter (al massimo 200 risultati) sono supportati; bulk, sort, etag e changePassword no. Richieste e risposte sono application/scim+json; application/json è accettato nelle richieste.

Autenticazione: scimBearer
Corpo della richiesta: nessuno
ID operazione: getSCIMServiceProviderConfig

Modello richiesta e risposte

shell · modello richiesta

curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/ServiceProviderConfig'

Risposte

Stato	Significato	Corpo e intestazioni
200	La configurazione del service provider.	SCIMResource (application/scim+json)
401	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
403	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
429	Il budget di richieste dell’organizzazione (600 al minuto) è esaurito. Un errore SCIM con status "429"; riprova dopo l’intervallo Retry-After.	SCIMError (application/scim+json); intestazioni: Retry-After
predefinito	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)

GET/scim/v2/ResourceTypes¶

Elenca tipi di risorsa SCIM

I tipi di risorsa RFC 7643 che il servizio provisiona: User e Group.

Autenticazione: scimBearer
Corpo della richiesta: nessuno
ID operazione: listSCIMResourceTypes

Modello richiesta e risposte

shell · modello richiesta

curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/ResourceTypes'

Risposte

Stato	Significato	Corpo e intestazioni
200	Una ListResponse dei tipi di risorsa.	SCIMResource (application/scim+json)
401	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
403	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
429	Il budget di richieste dell’organizzazione (600 al minuto) è esaurito. Un errore SCIM con status "429"; riprova dopo l’intervallo Retry-After.	SCIMError (application/scim+json); intestazioni: Retry-After
predefinito	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)

GET/scim/v2/Schemas¶

Elenca schemi SCIM

Le definizioni di schema RFC 7643 delle risorse che il servizio provisiona.

Autenticazione: scimBearer
Corpo della richiesta: nessuno
ID operazione: listSCIMSchemas

Modello richiesta e risposte

shell · modello richiesta

curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Schemas'

Risposte

Stato	Significato	Corpo e intestazioni
200	Una ListResponse degli schemi.	SCIMResource (application/scim+json)
401	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
403	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
429	Il budget di richieste dell’organizzazione (600 al minuto) è esaurito. Un errore SCIM con status "429"; riprova dopo l’intervallo Retry-After.	SCIMError (application/scim+json); intestazioni: Retry-After
predefinito	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)

GET/scim/v2/Users¶

Elenca utenti SCIM

Elenca gli utenti provisionati dell’organizzazione come ListResponse RFC 7644. filter è composto da uno a quattro termini attr eq value uniti da and; un valore è una stringa JSON tra virgolette, oppure true o false per active.

Gli utenti si filtrano su userName (senza distinzione tra maiuscole e minuscole), externalId (esatto), id, emails ed emails.value, displayName e active; qualsiasi altro filtro è 400 invalidFilter. startIndex parte da 1. count è 100 per impostazione predefinita e al massimo 200; count=0 restituisce solo totalResults. attributes ed excludedAttributes limitano i membri restituiti.

Autenticazione: scimBearer
Corpo della richiesta: nessuno
ID operazione: listSCIMUsers

Parametri

Nome	Invia	Obbligatorio?	Descrizione
filter	query	opzionale	Da uno a quattro termini attr eq value uniti da and. Un valore è una stringa JSON tra virgolette, oppure true o false per active. Un attributo, un operatore o una forma non supportati sono 400 invalidFilter.
startIndex	query	opzionale	L’indice del primo risultato, a partire da 1. Un valore inferiore a 1 è letto come 1.
count	query	opzionale	La dimensione della pagina, al massimo 200. 0 restituisce solo totalResults. Un valore maggiore è letto come 200.
attributes	query	opzionale	Un elenco di attributi da restituire, separati da virgole; gli altri sono esclusi, tranne id e schemas.
excludedAttributes	query	opzionale	Un elenco di attributi da escludere, separati da virgole.

Modello richiesta e risposte

shell · modello richiesta

curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Users'

Risposte

Stato	Significato	Corpo e intestazioni
200	Una ListResponse di utenti.	SCIMResource (application/scim+json)
400	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
401	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
403	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
429	Il budget di richieste dell’organizzazione (600 al minuto) è esaurito. Un errore SCIM con status "429"; riprova dopo l’intervallo Retry-After.	SCIMError (application/scim+json); intestazioni: Retry-After
predefinito	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)

POST/scim/v2/Users¶

Crea utente SCIM

Provisiona un utente e risponde 201 con la risorsa e il suo Location. La persona è identificata dalla sua email di lavoro, altrimenti dalla sua email principale, altrimenti da userName, e l’indirizzo deve appartenere a uno dei domini verificati dell’organizzazione.

Una persona che non ha alcuna credenziale, o che l’organizzazione gestisce già, diventa gestita da essa e accede tramite la connessione; una persona che è già membro di uno dei suoi progetti e mantiene il proprio accesso è collegata solo per l’accesso, quindi SCIM gestisce le sue concessioni nei progetti dell’organizzazione e mai la persona.

Un indirizzo che l’organizzazione non può provisionare, come uno di un altro dominio o di una persona dello staff screenRIG, è rifiutato con un errore SCIM il cui detail ne indica il motivo. Una persona il cui utente questa organizzazione ha eliminato quando non la gestiva viene provisionata di nuovo, con l’accesso che l’eliminazione aveva rimosso. Un userName già provisionato è 409 uniqueness.

Autenticazione: scimBearer
Corpo della richiesta: SCIMResource
ID operazione: createSCIMUser

Campi del corpo della richiesta

Campo	Descrizione
schemas (opzionale, array)	Gli URN degli schemi a cui si attiene il documento.

Modello richiesta e risposte

shell · modello richiesta

curl --request POST --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Users'

Risposte

Stato	Significato	Corpo e intestazioni
201	L’utente provisionato.	SCIMResource (application/scim+json); intestazioni: Location
400	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
401	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
403	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
409	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
429	Il budget di richieste dell’organizzazione (600 al minuto) è esaurito. Un errore SCIM con status "429"; riprova dopo l’intervallo Retry-After.	SCIMError (application/scim+json); intestazioni: Retry-After
predefinito	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)

GET/scim/v2/Users/{id}¶

Ottieni utente SCIM

Legge un utente provisionato. attributes ed excludedAttributes limitano i membri restituiti.

Autenticazione: scimBearer
Corpo della richiesta: nessuno
ID operazione: getSCIMUser

Parametri

Nome	Invia	Obbligatorio?	Descrizione
id	path	obbligatorio	L’id di una risorsa provisionata, come l’ha restituito il servizio SCIM.
attributes	query	opzionale	Un elenco di attributi da restituire, separati da virgole; gli altri sono esclusi, tranne id e schemas.
excludedAttributes	query	opzionale	Un elenco di attributi da escludere, separati da virgole.

Modello richiesta e risposte

shell · modello richiesta

curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Users/RESOURCE_ID'

Risposte

Stato	Significato	Corpo e intestazioni
200	L’utente.	SCIMResource (application/scim+json)
401	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
403	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
404	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
429	Il budget di richieste dell’organizzazione (600 al minuto) è esaurito. Un errore SCIM con status "429"; riprova dopo l’intervallo Retry-After.	SCIMError (application/scim+json); intestazioni: Retry-After
predefinito	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)

PUT/scim/v2/Users/{id}¶

Sostituisci utente SCIM

Sostituisce un utente provisionato con il documento inviato. active false disattiva la persona.

Una persona gestita dall’organizzazione è disattivata come nel dashboard: le sue sessioni e i token dashboard terminano, le sue appartenenze ai progetti e i suoi agenti responsabili sono sospesi, e l’ultimo amministratore dell’organizzazione è rifiutato con 400 mutability; active true la riattiva con quelle appartenenze e quegli agenti.

Una persona che non gestisce perde l’accesso ai progetti dell’organizzazione (mai a un progetto di cui è proprietaria) e le sue sessioni terminano; active true ripristina quell’accesso. Un utente che corrisponde a una persona dello staff screenRIG non viene mai modificato: 400 mutability.

Autenticazione: scimBearer
Corpo della richiesta: SCIMResource
ID operazione: replaceSCIMUser

Parametri

Nome	Invia	Obbligatorio?	Descrizione
id	path	obbligatorio	L’id di una risorsa provisionata, come l’ha restituito il servizio SCIM.

Campi del corpo della richiesta

Campo	Descrizione
schemas (opzionale, array)	Gli URN degli schemi a cui si attiene il documento.

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	L’utente come memorizzato.	SCIMResource (application/scim+json)
400	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
401	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
403	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
404	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
409	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
429	Il budget di richieste dell’organizzazione (600 al minuto) è esaurito. Un errore SCIM con status "429"; riprova dopo l’intervallo Retry-After.	SCIMError (application/scim+json); intestazioni: Retry-After
predefinito	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)

PATCH/scim/v2/Users/{id}¶

Patch utente SCIM

Applica un messaggio PatchOp RFC 7644 a un utente provisionato e risponde 200 con l’utente.

Le operazioni sono lette come le inviano Microsoft Entra ID e Okta, con o senza ?aadOptscim062020: i nomi op non distinguono maiuscole e minuscole; i booleani sono true o false, oppure "True" o "False"; un’operazione può omettere path o usare chiavi con punto come name.givenName; i percorsi includono emails[type eq "work"].value, members (add, replace e remove con un array value) e members[value eq "<id>"] (remove); gli attributi che screenRIG non usa sono accettati e ignorati. active false disattiva la persona.

Autenticazione: scimBearer
Corpo della richiesta: SCIMResource
ID operazione: patchSCIMUser

Parametri

Nome	Invia	Obbligatorio?	Descrizione
id	path	obbligatorio	L’id di una risorsa provisionata, come l’ha restituito il servizio SCIM.

Campi del corpo della richiesta

Campo	Descrizione
schemas (opzionale, array)	Gli URN degli schemi a cui si attiene il documento.

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	L’utente come memorizzato.	SCIMResource (application/scim+json)
400	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
401	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
403	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
404	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
409	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
429	Il budget di richieste dell’organizzazione (600 al minuto) è esaurito. Un errore SCIM con status "429"; riprova dopo l’intervallo Retry-After.	SCIMError (application/scim+json); intestazioni: Retry-After
predefinito	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)

ELIMINA/scim/v2/Users/{id}¶

Elimina utente SCIM

Disattiva l’utente come fa active false, dopodiché l’id è not_found e l’utente esce da ogni elenco e filtro. Per una persona che l’organizzazione non gestisce, l’accesso rimosso dalla disattivazione viene conservato, e una successiva creazione della stessa persona lo ripristina. Un utente che corrisponde a una persona dello staff screenRIG non viene mai modificato: 400 mutability.

Non cancella mai una persona; la cancellazione è l’eliminazione dell’account da parte della persona stessa.

Autenticazione: scimBearer
Corpo della richiesta: nessuno
ID operazione: deleteSCIMUser

Parametri

Nome	Invia	Obbligatorio?	Descrizione
id	path	obbligatorio	L’id di una risorsa provisionata, come l’ha restituito il servizio SCIM.

Modello richiesta e risposte

shell · modello richiesta

curl --request DELETE --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Users/RESOURCE_ID'

Risposte

Stato	Significato	Corpo e intestazioni
204	L’utente è disattivato e non più provisionato.	nessun corpo
400	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
401	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
403	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
404	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
429	Il budget di richieste dell’organizzazione (600 al minuto) è esaurito. Un errore SCIM con status "429"; riprova dopo l’intervallo Retry-After.	SCIMError (application/scim+json); intestazioni: Retry-After
predefinito	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)

GET/scim/v2/Groups¶

Elenca gruppi SCIM

Elenca i gruppi provisionati dell’organizzazione come ListResponse RFC 7644. filter è composto da uno a quattro termini attr eq value uniti da and.

I gruppi si filtrano su displayName, externalId, id, e members e members.value; qualsiasi altro filtro è 400 invalidFilter. startIndex parte da 1. count è 100 per impostazione predefinita e al massimo 200; count=0 restituisce solo totalResults. attributes ed excludedAttributes riducono i membri restituiti.

Autenticazione: scimBearer
Corpo della richiesta: nessuno
ID operazione: listSCIMGroups

Parametri

Nome	Invia	Obbligatorio?	Descrizione
filter	query	opzionale	Da uno a quattro termini attr eq value uniti da and. Un valore è una stringa JSON tra virgolette, oppure true o false per active. Un attributo, un operatore o una forma non supportati sono 400 invalidFilter.
startIndex	query	opzionale	L’indice del primo risultato, a partire da 1. Un valore inferiore a 1 è letto come 1.
count	query	opzionale	La dimensione della pagina, al massimo 200. 0 restituisce solo totalResults. Un valore maggiore è letto come 200.
attributes	query	opzionale	Un elenco di attributi da restituire, separati da virgole; gli altri sono esclusi, tranne id e schemas.
excludedAttributes	query	opzionale	Un elenco di attributi da escludere, separati da virgole.

Modello richiesta e risposte

shell · modello richiesta

curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Groups'

Risposte

Stato	Significato	Corpo e intestazioni
200	Una ListResponse di gruppi.	SCIMResource (application/scim+json)
400	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
401	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
403	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
429	Il budget di richieste dell’organizzazione (600 al minuto) è esaurito. Un errore SCIM con status "429"; riprova dopo l’intervallo Retry-After.	SCIMError (application/scim+json); intestazioni: Retry-After
predefinito	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)

POST/scim/v2/Groups¶

Crea gruppo SCIM

Provisiona un gruppo e risponde 201 con la risorsa e il suo Location. displayName è univoco nell’organizzazione, confrontato senza distinzione tra maiuscole e minuscole; un duplicato è 409 uniqueness. Un gruppo non concede alcun accesso finché una persona che può approvare non lo associa a un progetto nel dashboard.

Autenticazione: scimBearer
Corpo della richiesta: SCIMResource
ID operazione: createSCIMGroup

Campi del corpo della richiesta

Campo	Descrizione
schemas (opzionale, array)	Gli URN degli schemi a cui si attiene il documento.

Modello richiesta e risposte

shell · modello richiesta

curl --request POST --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Groups'

Risposte

Stato	Significato	Corpo e intestazioni
201	Il gruppo provisionato.	SCIMResource (application/scim+json); intestazioni: Location
400	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
401	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
403	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
409	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
429	Il budget di richieste dell’organizzazione (600 al minuto) è esaurito. Un errore SCIM con status "429"; riprova dopo l’intervallo Retry-After.	SCIMError (application/scim+json); intestazioni: Retry-After
predefinito	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)

GET/scim/v2/Groups/{id}¶

Ottieni gruppo SCIM

Legge un gruppo provisionato. attributes ed excludedAttributes limitano i membri restituiti.

Autenticazione: scimBearer
Corpo della richiesta: nessuno
ID operazione: getSCIMGroup

Parametri

Nome	Invia	Obbligatorio?	Descrizione
id	path	obbligatorio	L’id di una risorsa provisionata, come l’ha restituito il servizio SCIM.
attributes	query	opzionale	Un elenco di attributi da restituire, separati da virgole; gli altri sono esclusi, tranne id e schemas.
excludedAttributes	query	opzionale	Un elenco di attributi da escludere, separati da virgole.

Modello richiesta e risposte

shell · modello richiesta

curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Groups/RESOURCE_ID'

Risposte

Stato	Significato	Corpo e intestazioni
200	Il gruppo.	SCIMResource (application/scim+json)
401	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
403	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
404	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
429	Il budget di richieste dell’organizzazione (600 al minuto) è esaurito. Un errore SCIM con status "429"; riprova dopo l’intervallo Retry-After.	SCIMError (application/scim+json); intestazioni: Retry-After
predefinito	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)

PUT/scim/v2/Groups/{id}¶

Sostituisci gruppo SCIM

Sostituisce un gruppo provisionato con il documento inviato. Un documento senza members mantiene i membri del gruppo. Le modifiche di appartenenza riallineano l’accesso ai progetti delle persone interessate, ed è un’operazione idempotente.

Autenticazione: scimBearer
Corpo della richiesta: SCIMResource
ID operazione: replaceSCIMGroup

Parametri

Nome	Invia	Obbligatorio?	Descrizione
id	path	obbligatorio	L’id di una risorsa provisionata, come l’ha restituito il servizio SCIM.

Campi del corpo della richiesta

Campo	Descrizione
schemas (opzionale, array)	Gli URN degli schemi a cui si attiene il documento.

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Il gruppo come memorizzato.	SCIMResource (application/scim+json)
400	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
401	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
403	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
404	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
409	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
429	Il budget di richieste dell’organizzazione (600 al minuto) è esaurito. Un errore SCIM con status "429"; riprova dopo l’intervallo Retry-After.	SCIMError (application/scim+json); intestazioni: Retry-After
predefinito	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)

PATCH/scim/v2/Groups/{id}¶

Patch gruppo SCIM

Applica un messaggio PatchOp RFC 7644 a un gruppo provisionato e risponde 204, oppure 200 con il gruppo quando sono indicati attributes o excludedAttributes.

Le modifiche di appartenenza riallineano l’accesso ai progetti delle persone interessate, ed è un’operazione idempotente.

Autenticazione: scimBearer
Corpo della richiesta: SCIMResource
ID operazione: patchSCIMGroup

Parametri

Nome	Invia	Obbligatorio?	Descrizione
id	path	obbligatorio	L’id di una risorsa provisionata, come l’ha restituito il servizio SCIM.
attributes	query	opzionale	Un elenco di attributi da restituire, separati da virgole; gli altri sono esclusi, tranne id e schemas.
excludedAttributes	query	opzionale	Un elenco di attributi da escludere, separati da virgole.

Campi del corpo della richiesta

Campo	Descrizione
schemas (opzionale, array)	Gli URN degli schemi a cui si attiene il documento.

Modello richiesta e risposte

shell · modello richiesta

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'

Risposte

Stato	Significato	Corpo e intestazioni
200	Il gruppo come memorizzato, quando sono stati indicati attributes o excludedAttributes.	SCIMResource (application/scim+json)
204	La patch è applicata.	nessun corpo
400	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
401	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
403	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
404	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
409	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
429	Il budget di richieste dell’organizzazione (600 al minuto) è esaurito. Un errore SCIM con status "429"; riprova dopo l’intervallo Retry-After.	SCIMError (application/scim+json); intestazioni: Retry-After
predefinito	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)

ELIMINA/scim/v2/Groups/{id}¶

Elimina gruppo SCIM

Elimina un gruppo provisionato insieme alle sue associazioni ai progetti. Le persone che avevano accesso solo tramite quelle associazioni lo perdono; un’appartenenza concessa manualmente resta.

Autenticazione: scimBearer
Corpo della richiesta: nessuno
ID operazione: deleteSCIMGroup

Parametri

Nome	Invia	Obbligatorio?	Descrizione
id	path	obbligatorio	L’id di una risorsa provisionata, come l’ha restituito il servizio SCIM.

Modello richiesta e risposte

shell · modello richiesta

curl --request DELETE --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Groups/RESOURCE_ID'

Risposte

Stato	Significato	Corpo e intestazioni
204	Il gruppo è eliminato.	nessun corpo
401	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
403	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
404	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)
429	Il budget di richieste dell’organizzazione (600 al minuto) è esaurito. Un errore SCIM con status "429"; riprova dopo l’intervallo Retry-After.	SCIMError (application/scim+json); intestazioni: Retry-After
predefinito	Un errore SCIM RFC 7644 sezione 3.12, application/scim+json, non un documento problem. status ripete lo stato HTTP come stringa e scimType indica la classe (invalidFilter, uniqueness, mutability e le altre della RFC); detail dice cosa è stato rifiutato. 401 è un token sconosciuto o revocato e 403 un’organizzazione con SCIM disattivato.	SCIMError (application/scim+json)