Provisionamento de usuários: referência da API, endpoints e exemplos

OpenAPI YAML OpenAPI JSON problemas YAML Visão geral da API

Este grupo tem 24 operações, geradas a partir de api/openapi.yaml. Filtre por caminho, ação ou autenticação. Cada endpoint lista suas entradas; expanda-o para ver um modelo de solicitação e os códigos de resposta. Os modelos precisam de seus próprios valores e de um corpo válido conforme o esquema.

Substitua os espaços reservados em maiúsculas pelos seus valores. Para uma solicitação JSON, salve um corpo que corresponda ao esquema em request.json. Exemplos de cookies usam um jar local de cookies de uma sessão autenticada.

Provisionamento de usuários: SCIM 2.0, tokens e vinculações de grupo

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

Dashboard Organizações Obter SCIM

Um administrador designado lê as configurações de provisionamento SCIM da organização: se está ativado, a URL base a informar no provedor de identidade (na origem da API), os tokens de provisionamento ativos sem seus segredos e as contagens de usuários e grupos provisionados. Somente pessoas; agentes e credenciais bearer não têm rota.

Autenticação: dashboardSession
Corpo da solicitação: nenhum
ID da operação: dashboardOrganizationsGetSCIM

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
org_id	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
200	As configurações de SCIM da organização.	SCIMSettings (application/json); cabeçalhos: Cache-Control
401	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
403	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

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

Dashboard Organizações Definir SCIM

Um administrador designado ativa ou desativa o provisionamento SCIM após prova recente: uma prova de passkey ou de senha vinculada a uma reautenticação do tipo scim_change com o ID da organização como subject_id, ou {type: sso} de uma sessão iniciada por login único há no máximo 10 minutos.

Desativar não altera o acesso de ninguém: as pessoas e os grupos já provisionados mantêm suas concessões, e as rotas /scim/v2 respondem 403 até o SCIM ser ativado novamente. Retorna as configurações.

Somente pessoas; agentes e credenciais bearer não têm rota. enabled true é o recurso de provisionamento SCIM, que o plano Enterprise inclui; uma organização cujo plano não o inclui é recusada com feature_not_in_plan (402). enabled false é sempre aceito, e os endpoints /scim/v2 de uma organização que tem o SCIM ativado continuam respondendo.

Autenticação: dashboardSession
Corpo da solicitação: SCIMSettingsWrite
ID da operação: dashboardOrganizationsSetSCIM

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
org_id	caminho	obrigatório

Campos do corpo da solicitação

Campo	Descrição
habilitado (obrigatório, boolean)
proof (obrigatório, DashboardProof)

Modelo e respostas da solicitação

shell · modelo de requisição

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'

Respostas

Status	Significado	Corpo e cabeçalhos
200	As configurações de SCIM da organização.	SCIMSettings (application/json); cabeçalhos: Cache-Control
400	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
401	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
402	feature_not_in_plan — O provisionamento SCIM faz parte do plano Enterprise; o problema nomeia o recurso, o plano em que a conta está e required_plan.	Problema (application/problem+json)
403	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

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

Dashboard Organizações Criar SCIMToken

Um administrador designado emite um token de provisionamento após prova recente (como em PUT .../scim). O token, srscim_ mais 43 caracteres base64url, é retornado uma vez, somente aqui; o servidor guarda um digest SHA-256 e um prefixo para reconhecê-lo. Uma organização tem no máximo 5 tokens ativos; caso contrário, resource_conflict.

Somente pessoas; agentes e credenciais bearer não têm rota. Emitir um token é o recurso de provisionamento SCIM, que o plano Enterprise inclui; uma organização cujo plano não o inclui é recusada com feature_not_in_plan (402). Os tokens já emitidos continuam funcionando e podem ser revogados.

Autenticação: dashboardSession
Corpo da solicitação: SCIMTokenCreate
ID da operação: dashboardOrganizationsCreateSCIMToken

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
org_id	caminho	obrigatório

Campos do corpo da solicitação

Campo	Descrição
nome (obrigatório, string)	minLength: 1 maxLength: 80
proof (obrigatório, DashboardProof)

Modelo e respostas da solicitação

shell · modelo de requisição

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'

Respostas

Status	Significado	Corpo e cabeçalhos
201	O novo token, com o seu segredo.	SCIMTokenCreated (application/json); cabeçalhos: Cache-Control
400	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
401	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
402	feature_not_in_plan — O provisionamento SCIM faz parte do plano Enterprise; o problema nomeia o recurso, o plano em que a conta está e required_plan.	Problema (application/problem+json)
403	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
409	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

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

Dashboard Organizações Revogar SCIMToken

Um administrador designado revoga um token de provisionamento; as requisições que o apresentam são recusadas com 401 daí em diante. Um token já revogado retorna 204; um id que a organização não possui é not_found. Somente pessoas; agentes e credenciais bearer não têm rota.

Autenticação: dashboardSession
Corpo da solicitação: nenhum
ID da operação: dashboardOrganizationsRevokeSCIMToken

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
org_id	caminho	obrigatório
token_id	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
204	O token é revogado.	sem corpo
401	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
403	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
404	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

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

Dashboard Organizações Listar SCIMGroups

Um administrador designado lista os grupos que o provedor de identidade provisionou, com o número de membros e os projetos a que cada um está vinculado. A vinculação é feita no projeto (createDashboardGroupBinding) por uma pessoa que pode aprovar nele; um administrador vê apenas as vinculações e os nomes dos projetos, o que não concede acesso ao projeto.

Somente pessoas; agentes e credenciais bearer não têm rota.

Autenticação: dashboardSession
Corpo da solicitação: nenhum
ID da operação: dashboardOrganizationsListSCIMGroups

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
org_id	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
200	Os grupos provisionados da organização.	SCIMGroupList (application/json); cabeçalhos: Cache-Control
401	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
403	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

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

Dashboard Organizações Listar SCIMEvents

Um administrador designado lê as últimas 500 requisições feitas pelos clientes SCIM da organização, da mais recente para a mais antiga, falhas incluídas, mantidas por 30 dias. Cada linha indica a operação, o recurso e o status, e traz um detalhe quando a requisição falhou. Somente pessoas; agentes e credenciais bearer não têm rota.

Autenticação: dashboardSession
Corpo da solicitação: nenhum
ID da operação: dashboardOrganizationsListSCIMEvents

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
org_id	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
200	Os últimos eventos SCIM da organização.	SCIMEventList (application/json); cabeçalhos: Cache-Control
401	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
403	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/project/group-bindings¶

Listar vinculações de grupo do dashboard

As vinculações de grupo do projeto da sessão e os grupos que o provedor de identidade da organização dele provisionou (nome e número de membros) para escolher.

Uma vinculação dá a todo membro do grupo uma associação a este projeto: o papel member é uma associação simples e o papel approver também permite que a pessoa aprove revisões, no projeto inteiro ou no screen_scope da vinculação. Uma pessoa que várias vinculações do projeto alcançam tem a união dos seus escopos, e uma vinculação sem escopo dá o projeto inteiro.

A pessoa aprova revisões apenas quando a união dos escopos das suas vinculações de Aprovador (com o de uma concessão manual de aprovação) cobre toda essa união, e é membro caso contrário; o SCIM nunca reduz uma concessão manual: uma vinculação que o faria não é aplicada à pessoa e é registrada como um evento SCIM com falha.

Qualquer membro do projeto pode ler, exceto um chamador limitado a telas (outside_screen_scope).

Autenticação: dashboardSession
Corpo da solicitação: nenhum
ID da operação: listDashboardGroupBindings

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
200	As vinculações do projeto e os grupos da organização.	GroupBindingList (application/json); cabeçalhos: Cache-Control
401	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
409	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/project/group-bindings¶

Criar vinculação de grupo do dashboard

Vincula um grupo provisionado ao projeto da sessão com um papel e, opcionalmente, um screen_scope que o limita a pastas de telas e telas (fixo depois de criado; invalid_request nomeia o campo de um id que o projeto não tem).

Somente o proprietário do projeto ou um membro que pode aprovar (caso contrário, approver_required; um chamador limitado a telas recebe outside_screen_scope); um administrador da organização do projeto vincula como esse membro, então quem não pode aprovar entra primeiro no projeto (POST /api/organizations/{org_id}/projects/{project_id}/access o torna aprovador), e o vínculo é então registrado na auditoria da organização, marcado com by_organization_admin na auditoria do projeto, e o proprietário do projeto recebe um e-mail; uma sessão sombra da equipe é somente leitura.

O grupo deve ser um dos grupos provisionados da organização do projeto, caso contrário not_found, e um grupo é vinculado a um projeto uma única vez, caso contrário resource_conflict. A vinculação passa a valer de imediato para os membros atuais do grupo e acompanha toda alteração na associação ao grupo.

O limite de 200 membros do projeto se aplica: uma pessoa que ele recusa é registrada como um evento com falha nos eventos SCIM da organização e nada mais muda; o mesmo vale para uma pessoa que seria um convidado externo que a política de convidados da organização não admite (guest_not_allowed).

Uma mudança de escopo feita por uma vinculação acrescenta project.member_screen_scope_changed (detalhes user_id, screen_scope, previous, via scim, changed_by_user_id vazio). Vincular um grupo é o recurso de provisionamento SCIM, que o plano Enterprise inclui; um projeto cujo plano não o inclui é recusado com feature_not_in_plan (402). As vinculações que existem continuam concedendo e podem ser removidas.

Autenticação: dashboardSession
Corpo da solicitação: GroupBindingCreate
ID da operação: createDashboardGroupBinding

Campos do corpo da solicitação

Campo	Descrição
group_id (obrigatório, string)	minLength: 1 maxLength: 200
role (obrigatório, string)	Permitido: "approver", "member"
screen_scope (opcional, ScreenScope)	Sobre o que um membro ou agente com escopo pode agir (docs/screen-scope.md): as telas nas pastas de telas listadas e em todas as pastas dentro delas, e as telas listadas. Pelo menos um id no total. Um id que não nomeia nenhuma pasta ou tela existente do projeto quando gravado é invalid_request na sua posição; uma exclusão posterior deixa um id morto, que não concede nada. O escopo é lido a cada requisição, então uma alteração vale já na próxima. Tags nunca são escopo.

Campo

Descrição

group_id (obrigatório, string)

minLength: 1 maxLength: 200

role (obrigatório, string)

Permitido: "approver", "member"

screen_scope (opcional, ScreenScope)

Sobre o que um membro ou agente com escopo pode agir (docs/screen-scope.md): as telas nas pastas de telas listadas e em todas as pastas dentro delas, e as telas listadas. Pelo menos um id no total. Um id que não nomeia nenhuma pasta ou tela existente do projeto quando gravado é invalid_request na sua posição; uma exclusão posterior deixa um id morto, que não concede nada.

O escopo é lido a cada requisição, então uma alteração vale já na próxima. Tags nunca são escopo.

Modelo e respostas da solicitação

shell · modelo de requisição

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'

Respostas

Status	Significado	Corpo e cabeçalhos
201	A nova vinculação.	GroupBinding (application/json); cabeçalhos: Cache-Control
400	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
401	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
402	feature_not_in_plan — O provisionamento SCIM faz parte do plano Enterprise; o problema nomeia o recurso, o plano em que a conta está e required_plan.	Problema (application/problem+json)
403	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
404	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
409	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

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

Excluir vinculação de grupo do dashboard

Desvincula um grupo do projeto da sessão. Somente o proprietário do projeto ou um membro que pode aprovar (caso contrário, approver_required); um administrador da organização do projeto desvincula como esse membro, com registro do mesmo modo que um vínculo.

As pessoas que tinham acesso somente pela vinculação o perdem; uma associação concedida manualmente permanece, e uma concessão manual que a vinculação elevou ou ampliou volta ao que era, incluindo o seu escopo de telas. Um id que o projeto não tem é not_found.

Autenticação: dashboardSession
Corpo da solicitação: nenhum
ID da operação: deleteDashboardGroupBinding

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
binding_id	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
204	A vinculação é removida e o acesso que ela concedia é retirado.	sem corpo
401	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
403	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
404	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
409	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/scim/v2/ServiceProviderConfig¶

Obter configuração do provedor de serviço SCIM

A ServiceProviderConfig da RFC 7643 do serviço SCIM da organização: patch e filter (no máximo 200 resultados) são suportados; bulk, sort, etag e changePassword não são. Requisições e respostas são application/scim+json; application/json é aceito nas requisições.

Autenticação: scimBearer
Corpo da solicitação: nenhum
ID da operação: getSCIMServiceProviderConfig

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
200	A configuração do provedor de serviço.	SCIMResource (application/scim+json)
401	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
403	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
429	O orçamento de requisições da organização (600 por minuto) foi esgotado. Um erro SCIM com status "429"; tente novamente após o intervalo de Retry-After.	SCIMError (application/scim+json); cabeçalhos: Retry-After
padrão	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)

GET/scim/v2/ResourceTypes¶

Listar SCIMResource Types

Os tipos de recurso da RFC 7643 que o serviço provisiona: User e Group.

Autenticação: scimBearer
Corpo da solicitação: nenhum
ID da operação: listSCIMResourceTypes

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
200	Uma ListResponse dos tipos de recurso.	SCIMResource (application/scim+json)
401	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
403	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
429	O orçamento de requisições da organização (600 por minuto) foi esgotado. Um erro SCIM com status "429"; tente novamente após o intervalo de Retry-After.	SCIMError (application/scim+json); cabeçalhos: Retry-After
padrão	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)

GET/scim/v2/Schemas¶

Listar SCIMSchemas

As definições de schema da RFC 7643 dos recursos que o serviço provisiona.

Autenticação: scimBearer
Corpo da solicitação: nenhum
ID da operação: listSCIMSchemas

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
200	Uma ListResponse dos schemas.	SCIMResource (application/scim+json)
401	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
403	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
429	O orçamento de requisições da organização (600 por minuto) foi esgotado. Um erro SCIM com status "429"; tente novamente após o intervalo de Retry-After.	SCIMError (application/scim+json); cabeçalhos: Retry-After
padrão	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)

GET/scim/v2/Users¶

Listar SCIMUsers

Lista os usuários provisionados da organização como uma ListResponse da RFC 7644. filter é de um a quatro termos attr eq value unidos por and; um value é uma string JSON entre aspas, ou true ou false para active.

Usuários filtram por userName (sem distinção entre maiúsculas e minúsculas), externalId (exato), id, emails e emails.value, displayName e active; qualquer outro filtro é 400 invalidFilter. startIndex começa em 1. count tem padrão 100 e máximo 200; count=0 retorna apenas totalResults. attributes e excludedAttributes reduzem os membros retornados.

Autenticação: scimBearer
Corpo da solicitação: nenhum
ID da operação: listSCIMUsers

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
filter	consulta	opcional	De um a quatro termos attr eq value unidos por and. Um value é uma string JSON entre aspas, ou true ou false para active. Um atributo, operador ou formato não suportado é 400 invalidFilter.
startIndex	consulta	opcional	O índice, a partir de 1, do primeiro resultado. Um valor abaixo de 1 é lido como 1.
count	consulta	opcional	O tamanho da página, no máximo 200. 0 retorna apenas totalResults. Um valor maior é lido como 200.
attributes	consulta	opcional	Uma lista de atributos separados por vírgula a retornar; os demais são omitidos, exceto id e schemas.
excludedAttributes	consulta	opcional	Uma lista de atributos separados por vírgula a omitir.

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
200	Uma ListResponse de usuários.	SCIMResource (application/scim+json)
400	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
401	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
403	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
429	O orçamento de requisições da organização (600 por minuto) foi esgotado. Um erro SCIM com status "429"; tente novamente após o intervalo de Retry-After.	SCIMError (application/scim+json); cabeçalhos: Retry-After
padrão	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)

POST/scim/v2/Users¶

Criar SCIMUser

Provisiona um usuário e responde 201 com o recurso e seu Location. A pessoa é identificada pelo e-mail de trabalho, senão pelo e-mail principal, senão por userName, e o endereço deve estar em um dos domínios verificados da organização.

Uma pessoa que não tem nenhuma credencial, ou que a organização já gerencia, passa a ser gerenciada por ela e faz login pela conexão; uma pessoa que já é membro de um dos seus projetos e mantém o próprio login é vinculada somente para acesso, de modo que o SCIM gerencia as concessões dela nos projetos da organização e nunca a pessoa.

Um endereço que a organização não pode provisionar, como um de outro domínio ou de uma pessoa da equipe do screenRIG, é recusado com um erro SCIM cujo detail indica o motivo. Uma pessoa cujo usuário esta organização excluiu enquanto não a gerenciava é provisionada de novo, com o acesso que a exclusão removeu. Um userName já provisionado é 409 uniqueness.

Autenticação: scimBearer
Corpo da solicitação: SCIMResource
ID da operação: createSCIMUser

Campos do corpo da solicitação

Campo	Descrição
schemas (opcional, array)	Os URNs dos schemas que o documento segue.

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
201	O usuário provisionado.	SCIMResource (application/scim+json); cabeçalhos: Location
400	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
401	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
403	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
409	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
429	O orçamento de requisições da organização (600 por minuto) foi esgotado. Um erro SCIM com status "429"; tente novamente após o intervalo de Retry-After.	SCIMError (application/scim+json); cabeçalhos: Retry-After
padrão	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)

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

Obter SCIMUser

Lê um usuário provisionado. attributes e excludedAttributes reduzem os membros retornados.

Autenticação: scimBearer
Corpo da solicitação: nenhum
ID da operação: getSCIMUser

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
id	caminho	obrigatório	O id de um recurso provisionado, como o serviço SCIM o retornou.
attributes	consulta	opcional	Uma lista de atributos separados por vírgula a retornar; os demais são omitidos, exceto id e schemas.
excludedAttributes	consulta	opcional	Uma lista de atributos separados por vírgula a omitir.

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
200	O usuário.	SCIMResource (application/scim+json)
401	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
403	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
404	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
429	O orçamento de requisições da organização (600 por minuto) foi esgotado. Um erro SCIM com status "429"; tente novamente após o intervalo de Retry-After.	SCIMError (application/scim+json); cabeçalhos: Retry-After
padrão	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)

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

Substituir SCIMUser

Substitui um usuário provisionado pelo documento enviado. active false desativa a pessoa.

Uma pessoa que a organização gerencia é desativada como no dashboard: suas sessões e tokens do dashboard terminam, suas associações a projetos e agentes responsáveis são suspensos, e o último administrador da organização é recusado com 400 mutability; active true a reativa com essas associações e esses agentes.

Uma pessoa que a organização não gerencia perde o acesso aos projetos da organização (nunca a um projeto de que é proprietária) e as sessões dela terminam; active true restaura esse acesso. Um usuário que representa uma pessoa da equipe do screenRIG nunca é alterado: 400 mutability.

Autenticação: scimBearer
Corpo da solicitação: SCIMResource
ID da operação: replaceSCIMUser

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
id	caminho	obrigatório	O id de um recurso provisionado, como o serviço SCIM o retornou.

Campos do corpo da solicitação

Campo	Descrição
schemas (opcional, array)	Os URNs dos schemas que o documento segue.

Modelo e respostas da solicitação

shell · modelo de requisição

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'

Respostas

Status	Significado	Corpo e cabeçalhos
200	O usuário como armazenado.	SCIMResource (application/scim+json)
400	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
401	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
403	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
404	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
409	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
429	O orçamento de requisições da organização (600 por minuto) foi esgotado. Um erro SCIM com status "429"; tente novamente após o intervalo de Retry-After.	SCIMError (application/scim+json); cabeçalhos: Retry-After
padrão	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)

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

Aplicar patch em SCIMUser

Aplica uma mensagem PatchOp da RFC 7644 a um usuário provisionado e responde 200 com o usuário.

As operações são lidas como o Microsoft Entra ID e o Okta as enviam, com ou sem ?aadOptscim062020: os nomes de op não diferenciam maiúsculas e minúsculas; booleanos são true ou false, ou "True" ou "False"; uma operação pode omitir path ou usar chaves com ponto como name.givenName; os paths incluem emails[type eq "work"].value, members (add, replace e remove com um array de value) e members[value eq "<id>"] (remove); os atributos que o screenRIG não usa são aceitos e ignorados. active false desativa a pessoa.

Autenticação: scimBearer
Corpo da solicitação: SCIMResource
ID da operação: patchSCIMUser

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
id	caminho	obrigatório	O id de um recurso provisionado, como o serviço SCIM o retornou.

Campos do corpo da solicitação

Campo	Descrição
schemas (opcional, array)	Os URNs dos schemas que o documento segue.

Modelo e respostas da solicitação

shell · modelo de requisição

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'

Respostas

Status	Significado	Corpo e cabeçalhos
200	O usuário como armazenado.	SCIMResource (application/scim+json)
400	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
401	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
403	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
404	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
409	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
429	O orçamento de requisições da organização (600 por minuto) foi esgotado. Um erro SCIM com status "429"; tente novamente após o intervalo de Retry-After.	SCIMError (application/scim+json); cabeçalhos: Retry-After
padrão	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)

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

Excluir SCIMUser

Desativa o usuário como active false faz; depois disso, o id é not_found e o usuário sai de toda listagem e filtro. Para uma pessoa que a organização não gerencia, o acesso que a desativação removeu é guardado, e uma criação posterior da mesma pessoa o restaura. Um usuário que representa uma pessoa da equipe do screenRIG nunca é alterado: 400 mutability.

Nunca apaga uma pessoa; o apagamento é a exclusão da própria conta pela pessoa.

Autenticação: scimBearer
Corpo da solicitação: nenhum
ID da operação: deleteSCIMUser

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
id	caminho	obrigatório	O id de um recurso provisionado, como o serviço SCIM o retornou.

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
204	O usuário é desativado e deixa de ser provisionado.	sem corpo
400	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
401	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
403	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
404	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
429	O orçamento de requisições da organização (600 por minuto) foi esgotado. Um erro SCIM com status "429"; tente novamente após o intervalo de Retry-After.	SCIMError (application/scim+json); cabeçalhos: Retry-After
padrão	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)

GET/scim/v2/Groups¶

Listar SCIMGroups

Lista os grupos provisionados da organização como uma ListResponse da RFC 7644. filter é de um a quatro termos attr eq value unidos por and.

Grupos filtram por displayName, externalId, id e members e members.value; qualquer outro filtro é 400 invalidFilter. startIndex começa em 1. count tem padrão 100 e máximo 200; count=0 retorna apenas totalResults. attributes e excludedAttributes reduzem os membros retornados.

Autenticação: scimBearer
Corpo da solicitação: nenhum
ID da operação: listSCIMGroups

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
filter	consulta	opcional	De um a quatro termos attr eq value unidos por and. Um value é uma string JSON entre aspas, ou true ou false para active. Um atributo, operador ou formato não suportado é 400 invalidFilter.
startIndex	consulta	opcional	O índice, a partir de 1, do primeiro resultado. Um valor abaixo de 1 é lido como 1.
count	consulta	opcional	O tamanho da página, no máximo 200. 0 retorna apenas totalResults. Um valor maior é lido como 200.
attributes	consulta	opcional	Uma lista de atributos separados por vírgula a retornar; os demais são omitidos, exceto id e schemas.
excludedAttributes	consulta	opcional	Uma lista de atributos separados por vírgula a omitir.

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
200	Uma ListResponse de grupos.	SCIMResource (application/scim+json)
400	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
401	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
403	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
429	O orçamento de requisições da organização (600 por minuto) foi esgotado. Um erro SCIM com status "429"; tente novamente após o intervalo de Retry-After.	SCIMError (application/scim+json); cabeçalhos: Retry-After
padrão	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)

POST/scim/v2/Groups¶

Criar SCIMGroup

Provisiona um grupo e responde 201 com o recurso e seu Location. displayName é único na organização, comparado sem distinção entre maiúsculas e minúsculas; um duplicado é 409 uniqueness. Um grupo não concede acesso até uma pessoa que pode aprovar vinculá-lo a um projeto no dashboard.

Autenticação: scimBearer
Corpo da solicitação: SCIMResource
ID da operação: createSCIMGroup

Campos do corpo da solicitação

Campo	Descrição
schemas (opcional, array)	Os URNs dos schemas que o documento segue.

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
201	O grupo provisionado.	SCIMResource (application/scim+json); cabeçalhos: Location
400	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
401	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
403	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
409	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
429	O orçamento de requisições da organização (600 por minuto) foi esgotado. Um erro SCIM com status "429"; tente novamente após o intervalo de Retry-After.	SCIMError (application/scim+json); cabeçalhos: Retry-After
padrão	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)

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

Obter SCIMGroup

Lê um grupo provisionado. attributes e excludedAttributes reduzem os membros retornados.

Autenticação: scimBearer
Corpo da solicitação: nenhum
ID da operação: getSCIMGroup

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
id	caminho	obrigatório	O id de um recurso provisionado, como o serviço SCIM o retornou.
attributes	consulta	opcional	Uma lista de atributos separados por vírgula a retornar; os demais são omitidos, exceto id e schemas.
excludedAttributes	consulta	opcional	Uma lista de atributos separados por vírgula a omitir.

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
200	O grupo.	SCIMResource (application/scim+json)
401	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
403	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
404	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
429	O orçamento de requisições da organização (600 por minuto) foi esgotado. Um erro SCIM com status "429"; tente novamente após o intervalo de Retry-After.	SCIMError (application/scim+json); cabeçalhos: Retry-After
padrão	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)

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

Substituir SCIMGroup

Substitui um grupo provisionado pelo documento enviado. Um documento sem members mantém os membros do grupo. As alterações de associação reconciliam o acesso a projetos das pessoas afetadas, o que é idempotente.

Autenticação: scimBearer
Corpo da solicitação: SCIMResource
ID da operação: replaceSCIMGroup

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
id	caminho	obrigatório	O id de um recurso provisionado, como o serviço SCIM o retornou.

Campos do corpo da solicitação

Campo	Descrição
schemas (opcional, array)	Os URNs dos schemas que o documento segue.

Modelo e respostas da solicitação

shell · modelo de requisição

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'

Respostas

Status	Significado	Corpo e cabeçalhos
200	O grupo como armazenado.	SCIMResource (application/scim+json)
400	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
401	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
403	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
404	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
409	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
429	O orçamento de requisições da organização (600 por minuto) foi esgotado. Um erro SCIM com status "429"; tente novamente após o intervalo de Retry-After.	SCIMError (application/scim+json); cabeçalhos: Retry-After
padrão	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)

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

Aplicar patch em SCIMGroup

Aplica uma mensagem PatchOp da RFC 7644 a um grupo provisionado e responde 204, ou 200 com o grupo quando attributes ou excludedAttributes são informados.

As alterações de associação reconciliam o acesso a projetos das pessoas afetadas, o que é idempotente.

Autenticação: scimBearer
Corpo da solicitação: SCIMResource
ID da operação: patchSCIMGroup

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
id	caminho	obrigatório	O id de um recurso provisionado, como o serviço SCIM o retornou.
attributes	consulta	opcional	Uma lista de atributos separados por vírgula a retornar; os demais são omitidos, exceto id e schemas.
excludedAttributes	consulta	opcional	Uma lista de atributos separados por vírgula a omitir.

Campos do corpo da solicitação

Campo	Descrição
schemas (opcional, array)	Os URNs dos schemas que o documento segue.

Modelo e respostas da solicitação

shell · modelo de requisição

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'

Respostas

Status	Significado	Corpo e cabeçalhos
200	O grupo como armazenado, quando attributes ou excludedAttributes foram informados.	SCIMResource (application/scim+json)
204	O patch é aplicado.	sem corpo
400	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
401	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
403	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
404	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
409	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
429	O orçamento de requisições da organização (600 por minuto) foi esgotado. Um erro SCIM com status "429"; tente novamente após o intervalo de Retry-After.	SCIMError (application/scim+json); cabeçalhos: Retry-After
padrão	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)

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

Excluir SCIMGroup

Exclui um grupo provisionado junto com suas vinculações a projetos. As pessoas que tinham acesso somente por essas vinculações o perdem; uma associação concedida manualmente permanece.

Autenticação: scimBearer
Corpo da solicitação: nenhum
ID da operação: deleteSCIMGroup

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
id	caminho	obrigatório	O id de um recurso provisionado, como o serviço SCIM o retornou.

Modelo e respostas da solicitação

shell · modelo de requisição

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

Respostas

Status	Significado	Corpo e cabeçalhos
204	O grupo é excluído.	sem corpo
401	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
403	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
404	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)
429	O orçamento de requisições da organização (600 por minuto) foi esgotado. Um erro SCIM com status "429"; tente novamente após o intervalo de Retry-After.	SCIMError (application/scim+json); cabeçalhos: Retry-After
padrão	Um erro SCIM da RFC 7644 seção 3.12, application/scim+json, não um documento de problema. status repete o status HTTP como string e scimType nomeia a classe (invalidFilter, uniqueness, mutability e os demais da RFC); detail diz o que foi recusado. 401 é um token desconhecido ou revogado e 403 é uma organização com SCIM desativado.	SCIMError (application/scim+json)