Referencia API

API de Aprovisionamiento de usuarios

Aprovisionamiento de usuarios: SCIM 2.0, tokens y vinculaciones de grupo

Referencia HTTP. Generada a partir del contrato backend. Explore los endpoints abajo o descargue OpenAPI.

Este grupo tiene 24 operaciones, generadas a partir de api/openapi.yaml. Filtre por ruta, acción o autenticación. Cada endpoint indica sus entradas; despliéguelo para ver una plantilla de solicitud y los códigos de respuesta. Las plantillas necesitan sus propios valores y un cuerpo válido según el esquema.

Reemplace los marcadores en mayúsculas con sus valores. Para una solicitud JSON, guarde un cuerpo que coincida con el esquema en request.json. Los ejemplos de cookies usan un frasco de cookies local de una sesión autenticada.

Aprovisionamiento de usuarios: SCIM 2.0, tokens y vinculaciones de grupo

GET/api/organizations/{org_id}/scim

Panel Organizaciones Obtener SCIM

Un administrador designado lee la configuración de aprovisionamiento SCIM de la organización: si está habilitado, la URL base que se ingresa en el proveedor de identidad (en el origen de la API), los tokens de aprovisionamiento vigentes sin sus secretos y los recuentos de usuarios y grupos aprovisionados. Solo personas; los agentes y las credenciales portadoras no tienen ruta.

Autenticación
dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
dashboardOrganizationsGetSCIM

Parámetros

NombreEnviar¿Requerido?Descripción
org_idrutarequerido
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/scim'

Respuestas

EstadoSignificadoCuerpo y encabezados
200La configuración SCIM de la organización.SCIMSettings (application/json); encabezados: Cache-Control
401

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
403

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
PUT/api/organizations/{org_id}/scim

Panel Organizaciones Establecer SCIM

Un administrador designado habilita o deshabilita el aprovisionamiento SCIM tras una prueba reciente: una prueba de passkey o de contraseña vinculada a una reautenticación de tipo scim_change con el id de la organización como subject_id, o {type: sso} de una sesión que inició sesión mediante el inicio de sesión único hace 10 minutos como máximo.

Deshabilitar no cambia el acceso de nadie: las personas y los grupos ya aprovisionados conservan sus concesiones, y las rutas /scim/v2 responden 403 hasta que SCIM se habilite de nuevo. Devuelve la configuración.

Solo personas; los agentes y las credenciales portadoras no tienen ruta. enabled true corresponde al aprovisionamiento SCIM, que incluye el plan Enterprise; una organización cuyo plan no lo incluye se rechaza con feature_not_in_plan (402). enabled false siempre se acepta, y los endpoints /scim/v2 de una organización que tiene SCIM activado siguen respondiendo.

Autenticación
dashboardSession
Cuerpo de la solicitud
SCIMSettingsWrite
ID de operación
dashboardOrganizationsSetSCIM

Parámetros

NombreEnviar¿Requerido?Descripción
org_idrutarequerido

Campos del cuerpo de la solicitud

CampoDescripción
habilitado (requerido, booleano)
proof (requerido, DashboardProof)
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
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'

Respuestas

EstadoSignificadoCuerpo y encabezados
200La configuración SCIM de la organización.SCIMSettings (application/json); encabezados: Cache-Control
400

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
401

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
402feature_not_in_plan — El aprovisionamiento SCIM forma parte del plan Enterprise; el problema nombra la función, el plan que tiene la cuenta y required_plan.Problema (application/problem+json)
403

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
POST/api/organizations/{org_id}/scim/tokens

Panel Organizaciones Crear Token SCIM

Un administrador designado emite un token de aprovisionamiento tras una prueba reciente (como en PUT .../scim). El token, srscim_ más 43 caracteres base64url, se devuelve una sola vez, solo aquí; el servidor conserva un resumen SHA-256 y un prefijo para reconocerlo. Una organización tiene como máximo 5 tokens vigentes; de lo contrario, resource_conflict.

Solo personas; los agentes y las credenciales portadoras no tienen ruta. Emitir un token corresponde al aprovisionamiento SCIM, que incluye el plan Enterprise; una organización cuyo plan no lo incluye se rechaza con feature_not_in_plan (402). Los tokens ya emitidos siguen funcionando y se pueden revocar.

Autenticación
dashboardSession
Cuerpo de la solicitud
SCIMTokenCreate
ID de operación
dashboardOrganizationsCreateSCIMToken

Parámetros

NombreEnviar¿Requerido?Descripción
org_idrutarequerido

Campos del cuerpo de la solicitud

CampoDescripción
nombre (requerido, cadena)minLength: 1 maxLength: 80
proof (requerido, DashboardProof)
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
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'

Respuestas

EstadoSignificadoCuerpo y encabezados
201El nuevo token, con su secreto.SCIMTokenCreated (application/json); encabezados: Cache-Control
400

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
401

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
402feature_not_in_plan — El aprovisionamiento SCIM forma parte del plan Enterprise; el problema nombra la función, el plan que tiene la cuenta y required_plan.Problema (application/problem+json)
403

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
409

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
ELIMINAR/api/organizations/{org_id}/scim/tokens/{token_id}

Panel Organizaciones Revocar Token SCIM

Un administrador designado revoca un token de aprovisionamiento; las solicitudes que lo presentan se rechazan con 401 a partir de ese momento. Un token ya revocado devuelve 204; un id que la organización no tiene es not_found. Solo personas; los agentes y las credenciales portadoras no tienen ruta.

Autenticación
dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
dashboardOrganizationsRevokeSCIMToken

Parámetros

NombreEnviar¿Requerido?Descripción
org_idrutarequerido
token_idrutarequerido
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/scim/tokens/TOKEN_ID'

Respuestas

EstadoSignificadoCuerpo y encabezados
204El token se revoca.sin cuerpo
401

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
403

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
404

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
GET/api/organizations/{org_id}/scim/groups

Panel Organizaciones Listar Grupos SCIM

Un administrador designado lista los grupos que el proveedor de identidad ha aprovisionado, con su número de miembros y los proyectos a los que está vinculado cada uno. La vinculación se hace en el proyecto (createDashboardGroupBinding) por una persona que puede aprobar allí; un administrador ve solo las vinculaciones y los nombres de los proyectos, lo que no concede acceso a ningún proyecto.

Solo personas; los agentes y las credenciales portadoras no tienen ruta.

Autenticación
dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
dashboardOrganizationsListSCIMGroups

Parámetros

NombreEnviar¿Requerido?Descripción
org_idrutarequerido
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/scim/groups'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Los grupos aprovisionados de la organización.SCIMGroupList (application/json); encabezados: Cache-Control
401

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
403

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
GET/api/organizations/{org_id}/scim/events

Panel Organizaciones Listar Eventos SCIM

Un administrador designado lee las últimas 500 solicitudes que hicieron los clientes SCIM de la organización, las más recientes primero, con los fallos incluidos, conservadas durante 30 días. Cada fila indica la operación, el recurso y el estado, y lleva un detalle cuando la solicitud falló. Solo personas; los agentes y las credenciales portadoras no tienen ruta.

Autenticación
dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
dashboardOrganizationsListSCIMEvents

Parámetros

NombreEnviar¿Requerido?Descripción
org_idrutarequerido
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/organizations/ORG_ID/scim/events'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Los últimos eventos SCIM de la organización.SCIMEventList (application/json); encabezados: Cache-Control
401

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
403

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
GET/api/project/group-bindings

Listar vinculaciones de grupo en el panel

Las vinculaciones de grupo del proyecto de la sesión, y los grupos que el proveedor de identidad de su organización ha aprovisionado (nombre y número de miembros) para elegir.

Una vinculación da a cada miembro del grupo una membresía en este proyecto: el rol member es una membresía simple y el rol approver permite además que la persona apruebe revisiones, en todo el proyecto o en el screen_scope de la vinculación. Una persona a la que llegan varias vinculaciones del proyecto tiene la unión de sus alcances, y una vinculación sin alcance da todo el proyecto.

La persona aprueba revisiones solo cuando la unión de los alcances de sus vinculaciones de Aprobador (con el de una concesión manual de aprobación) cubre toda esa unión, y es miembro en caso contrario; SCIM nunca reduce una concesión manual: una vinculación que lo haría no se aplica a la persona y se registra como un evento SCIM fallido.

Cualquier miembro del proyecto lee, salvo un llamador limitado a pantallas (outside_screen_scope).

Autenticación
dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
listDashboardGroupBindings
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/project/group-bindings'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Las vinculaciones del proyecto y los grupos de la organización.GroupBindingList (application/json); encabezados: Cache-Control
401

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
409

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
POST/api/project/group-bindings

Crear vinculación de grupo en el panel

Vincula un grupo aprovisionado al proyecto de la sesión con un rol y, opcionalmente, un screen_scope que lo limita a carpetas de pantallas y pantallas (fijo una vez creado; invalid_request nombra el campo de un id que el proyecto no tiene).

Solo el propietario del proyecto o un miembro que puede aprobar (de lo contrario, approver_required; un llamador limitado a pantallas recibe outside_screen_scope); un administrador de la organización del proyecto vincula como ese miembro, de modo que quien no puede aprobar se une primero al proyecto (POST /api/organizations/{org_id}/projects/{project_id}/access lo convierte en aprobador), y la vinculación se registra después en la auditoría de la organización, se marca con by_organization_admin en la auditoría del proyecto y se envía un correo electrónico al propietario del proyecto; una sesión sombra del personal es de solo lectura.

El grupo debe ser uno de los grupos aprovisionados de la organización del proyecto; de lo contrario, not_found, y un grupo se vincula a un proyecto una sola vez; de lo contrario, resource_conflict. La vinculación surte efecto de inmediato para los miembros actuales del grupo y sigue todos los cambios en la membresía del grupo.

Se aplica el límite de 200 miembros del proyecto: una persona a la que rechaza se registra como un evento fallido en los eventos SCIM de la organización y nada más cambia; lo mismo ocurre con una persona que sería un invitado externo que la política de invitados de la organización no admite (guest_not_allowed).

Un cambio de alcance que hace una vinculación añade project.member_screen_scope_changed (detalles user_id, screen_scope, previous, via scim, changed_by_user_id vacío). Vincular un grupo corresponde al aprovisionamiento SCIM, que incluye el plan Enterprise; un proyecto cuyo plan no lo incluye se rechaza con feature_not_in_plan (402). Las vinculaciones que ya existen siguen concediendo y se pueden eliminar.

Autenticación
dashboardSession
Cuerpo de la solicitud
GroupBindingCreate
ID de operación
createDashboardGroupBinding

Campos del cuerpo de la solicitud

CampoDescripción
group_id (requerido, cadena)minLength: 1 maxLength: 200
role (requerido, cadena)Permitidos: "approver", "member"
screen_scope (opcional, ScreenScope)

Sobre qué puede actuar un miembro o agente con alcance (docs/screen-scope.md): las pantallas de las carpetas de pantallas listadas y de cada carpeta que hay dentro, y las pantallas listadas. Al menos un id en total. Un id que no nombra ninguna carpeta ni pantalla viva del proyecto cuando se escribe es invalid_request en su posición; una eliminación posterior deja un id muerto, que no concede nada.

El alcance se lee en cada solicitud, así que un cambio se aplica a la siguiente. Las etiquetas nunca son alcance.

Plantilla y respuestas de solicitud
shell · plantilla de solicitud
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'

Respuestas

EstadoSignificadoCuerpo y encabezados
201La nueva vinculación.GroupBinding (application/json); encabezados: Cache-Control
400

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
401

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
402feature_not_in_plan — El aprovisionamiento SCIM forma parte del plan Enterprise; el problema nombra la función, el plan que tiene la cuenta y required_plan.Problema (application/problem+json)
403

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
404

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
409

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
ELIMINAR/api/project/group-bindings/{binding_id}

Eliminar vinculación de grupo en el panel

Desvincula un grupo del proyecto de la sesión. Solo el propietario del proyecto o un miembro que puede aprobar (de lo contrario, approver_required); un administrador de la organización del proyecto desvincula como ese miembro, y se registra igual que una vinculación.

Las personas que tenían acceso solo a través de la vinculación lo pierden; una membresía concedida a mano permanece, y una concesión manual que la vinculación elevó o amplió vuelve a lo que era, incluido su alcance de pantallas. Un id que el proyecto no tiene es not_found.

Autenticación
dashboardSession
Cuerpo de la solicitud
ninguno
ID de operación
deleteDashboardGroupBinding

Parámetros

NombreEnviar¿Requerido?Descripción
binding_idrutarequerido
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request DELETE --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/project/group-bindings/BINDING_ID'

Respuestas

EstadoSignificadoCuerpo y encabezados
204La vinculación se elimina y el acceso que daba se retira.sin cuerpo
401

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
403

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
404

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
409

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
predeterminado

Respuesta estable RFC 9457 a problemas. Un 421 server_draining lleva Retry-After de 1 segundo, un 500 not_ready o dependency_unavailable lleva 5, y un 500 manifest_degraded lleva 60, a menos que el manejador establezca un valor más específico.

Problema (application/problem+json)
GET/scim/v2/ServiceProviderConfig

Obtener configuración del proveedor de servicios SCIM

El ServiceProviderConfig de RFC 7643 del servicio SCIM de la organización: se admiten patch y filter (como máximo 200 resultados); no se admiten bulk, sort, etag ni changePassword. Las solicitudes y las respuestas son application/scim+json; en las solicitudes se acepta application/json.

Autenticación
scimBearer
Cuerpo de la solicitud
ninguno
ID de operación
getSCIMServiceProviderConfig
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/ServiceProviderConfig'

Respuestas

EstadoSignificadoCuerpo y encabezados
200La configuración del proveedor de servicios.SCIMResource (application/scim+json)
401

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
403

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
429Se agotó el presupuesto de solicitudes de la organización (600 por minuto). Un error SCIM con status "429"; reintente tras el intervalo de Retry-After.SCIMError (application/scim+json); encabezados: Retry-After
predeterminado

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
GET/scim/v2/ResourceTypes

Listar tipos de recurso SCIM

Los tipos de recurso de RFC 7643 que aprovisiona el servicio: User y Group.

Autenticación
scimBearer
Cuerpo de la solicitud
ninguno
ID de operación
listSCIMResourceTypes
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/ResourceTypes'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Un ListResponse de los tipos de recurso.SCIMResource (application/scim+json)
401

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
403

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
429Se agotó el presupuesto de solicitudes de la organización (600 por minuto). Un error SCIM con status "429"; reintente tras el intervalo de Retry-After.SCIMError (application/scim+json); encabezados: Retry-After
predeterminado

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
GET/scim/v2/Schemas

Listar esquemas SCIM

Las definiciones de esquema de RFC 7643 de los recursos que aprovisiona el servicio.

Autenticación
scimBearer
Cuerpo de la solicitud
ninguno
ID de operación
listSCIMSchemas
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Schemas'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Un ListResponse de los esquemas.SCIMResource (application/scim+json)
401

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
403

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
429Se agotó el presupuesto de solicitudes de la organización (600 por minuto). Un error SCIM con status "429"; reintente tras el intervalo de Retry-After.SCIMError (application/scim+json); encabezados: Retry-After
predeterminado

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
GET/scim/v2/Users

Listar usuarios SCIM

Lista los usuarios aprovisionados de la organización como un ListResponse de RFC 7644. filter es de uno a cuatro términos attr eq value unidos por and; un valor es una cadena JSON entre comillas, o true o false para active.

Los usuarios se filtran por userName (sin distinguir mayúsculas), externalId (exacto), id, emails y emails.value, displayName y active; cualquier otro filtro es 400 invalidFilter. startIndex tiene base 1. count es 100 por defecto y como máximo 200; count=0 devuelve solo totalResults. attributes y excludedAttributes recortan los miembros devueltos.

Autenticación
scimBearer
Cuerpo de la solicitud
ninguno
ID de operación
listSCIMUsers

Parámetros

NombreEnviar¿Requerido?Descripción
filterconsultaopcionalDe uno a cuatro términos attr eq value unidos por and. Un valor es una cadena JSON entre comillas, o true o false para active. Un atributo, un operador o una forma no admitidos es 400 invalidFilter.
startIndexconsultaopcionalEl índice, con base 1, del primer resultado. Un valor menor que 1 se lee como 1.
countconsultaopcionalEl tamaño de página, como máximo 200. 0 devuelve solo totalResults. Un valor mayor se lee como 200.
attributesconsultaopcionalUna lista separada por comas de los atributos que se devuelven; los demás se omiten, salvo id y schemas.
excludedAttributesconsultaopcionalUna lista separada por comas de los atributos que se omiten.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Users'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Un ListResponse de usuarios.SCIMResource (application/scim+json)
400

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
401

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
403

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
429Se agotó el presupuesto de solicitudes de la organización (600 por minuto). Un error SCIM con status "429"; reintente tras el intervalo de Retry-After.SCIMError (application/scim+json); encabezados: Retry-After
predeterminado

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
POST/scim/v2/Users

Crear usuario SCIM

Aprovisiona un usuario y responde 201 con el recurso y su Location. La persona se identifica por su correo electrónico de trabajo; si no existe, por su correo principal; si no, por userName. La dirección debe pertenecer a uno de los dominios verificados de la organización.

Una persona que no tiene ninguna credencial, o a quien la organización ya administra, pasa a ser administrada por ella e inicia sesión mediante la conexión; una persona que ya es miembro de uno de sus proyectos y conserva su propio inicio de sesión se vincula solo para el acceso, de modo que SCIM administra sus concesiones en los proyectos de la organización y nunca a la persona.

Una dirección que la organización no puede aprovisionar, como una de otro dominio o una persona del personal de screenRIG, se rechaza con un error SCIM cuyo detail indica el motivo. Una persona cuyo usuario eliminó esta organización cuando no la administraba se aprovisiona de nuevo, con el acceso que la eliminación quitó. Un userName ya aprovisionado es 409 uniqueness.

Autenticación
scimBearer
Cuerpo de la solicitud
SCIMResource
ID de operación
createSCIMUser

Campos del cuerpo de la solicitud

CampoDescripción
schemas (opcional, arreglo)Los URN de los esquemas que sigue el documento.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request POST --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Users'

Respuestas

EstadoSignificadoCuerpo y encabezados
201El usuario aprovisionado.SCIMResource (application/scim+json); encabezados: Location
400

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
401

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
403

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
409

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
429Se agotó el presupuesto de solicitudes de la organización (600 por minuto). Un error SCIM con status "429"; reintente tras el intervalo de Retry-After.SCIMError (application/scim+json); encabezados: Retry-After
predeterminado

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
GET/scim/v2/Users/{id}

Obtener usuario SCIM

Lee un usuario aprovisionado. attributes y excludedAttributes recortan los miembros devueltos.

Autenticación
scimBearer
Cuerpo de la solicitud
ninguno
ID de operación
getSCIMUser

Parámetros

NombreEnviar¿Requerido?Descripción
idrutarequeridoEl id de un recurso aprovisionado, tal como lo devolvió el servicio SCIM.
attributesconsultaopcionalUna lista separada por comas de los atributos que se devuelven; los demás se omiten, salvo id y schemas.
excludedAttributesconsultaopcionalUna lista separada por comas de los atributos que se omiten.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Users/RESOURCE_ID'

Respuestas

EstadoSignificadoCuerpo y encabezados
200El usuario.SCIMResource (application/scim+json)
401

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
403

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
404

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
429Se agotó el presupuesto de solicitudes de la organización (600 por minuto). Un error SCIM con status "429"; reintente tras el intervalo de Retry-After.SCIMError (application/scim+json); encabezados: Retry-After
predeterminado

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
PUT/scim/v2/Users/{id}

Reemplazar usuario SCIM

Reemplaza un usuario aprovisionado por el documento enviado. active false desactiva a la persona.

A una persona que la organización administra se la desactiva como en el panel: sus sesiones y tokens del panel terminan, sus membresías de proyecto y agentes responsables se suspenden, y al último administrador de la organización se le rechaza con 400 mutability; active true la reactiva con esas membresías y agentes.

Una persona que la organización no administra pierde su acceso a los proyectos de la organización (nunca a un proyecto que posee) y sus sesiones terminan; active true restablece ese acceso. Un usuario que representa a una persona del personal de screenRIG nunca se modifica: 400 mutability.

Autenticación
scimBearer
Cuerpo de la solicitud
SCIMResource
ID de operación
replaceSCIMUser

Parámetros

NombreEnviar¿Requerido?Descripción
idrutarequeridoEl id de un recurso aprovisionado, tal como lo devolvió el servicio SCIM.

Campos del cuerpo de la solicitud

CampoDescripción
schemas (opcional, arreglo)Los URN de los esquemas que sigue el documento.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
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'

Respuestas

EstadoSignificadoCuerpo y encabezados
200El usuario tal como está almacenado.SCIMResource (application/scim+json)
400

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
401

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
403

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
404

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
409

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
429Se agotó el presupuesto de solicitudes de la organización (600 por minuto). Un error SCIM con status "429"; reintente tras el intervalo de Retry-After.SCIMError (application/scim+json); encabezados: Retry-After
predeterminado

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
PATCH/scim/v2/Users/{id}

Parche de usuario SCIM

Aplica un mensaje PatchOp de RFC 7644 a un usuario aprovisionado y responde 200 con el usuario.

Las operaciones se leen tal como las envían Microsoft Entra ID y Okta, con o sin ?aadOptscim062020: los nombres de op no distinguen mayúsculas; los booleanos son true o false, o "True" o "False"; una operación puede omitir path o usar claves con puntos como name.givenName; las rutas incluyen emails[type eq "work"].value, members (add, replace y remove con un arreglo value) y members[value eq "<id>"] (remove); los atributos que screenRIG no usa se aceptan y se ignoran. active false desactiva a la persona.

A una persona que la organización administra se la desactiva como en el panel: sus sesiones y tokens del panel terminan, sus membresías de proyecto y agentes responsables se suspenden, y al último administrador de la organización se le rechaza con 400 mutability; active true la reactiva con esas membresías y agentes.

Una persona que la organización no administra pierde su acceso a los proyectos de la organización (nunca a un proyecto que posee) y sus sesiones terminan; active true restablece ese acceso. Un usuario que representa a una persona del personal de screenRIG nunca se modifica: 400 mutability.

Autenticación
scimBearer
Cuerpo de la solicitud
SCIMResource
ID de operación
patchSCIMUser

Parámetros

NombreEnviar¿Requerido?Descripción
idrutarequeridoEl id de un recurso aprovisionado, tal como lo devolvió el servicio SCIM.

Campos del cuerpo de la solicitud

CampoDescripción
schemas (opcional, arreglo)Los URN de los esquemas que sigue el documento.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
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'

Respuestas

EstadoSignificadoCuerpo y encabezados
200El usuario tal como está almacenado.SCIMResource (application/scim+json)
400

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
401

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
403

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
404

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
409

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
429Se agotó el presupuesto de solicitudes de la organización (600 por minuto). Un error SCIM con status "429"; reintente tras el intervalo de Retry-After.SCIMError (application/scim+json); encabezados: Retry-After
predeterminado

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
ELIMINAR/scim/v2/Users/{id}

Eliminar usuario SCIM

Desactiva al usuario como lo hace active false, tras lo cual el id es not_found y el usuario sale de todos los listados y filtros. Para una persona que la organización no administra, se conserva el acceso que la desactivación quitó, y una creación posterior de la misma persona lo restablece. Un usuario que representa a una persona del personal de screenRIG nunca se modifica: 400 mutability.

Nunca borra a una persona; el borrado es la eliminación de su propia cuenta por la persona.

Autenticación
scimBearer
Cuerpo de la solicitud
ninguno
ID de operación
deleteSCIMUser

Parámetros

NombreEnviar¿Requerido?Descripción
idrutarequeridoEl id de un recurso aprovisionado, tal como lo devolvió el servicio SCIM.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request DELETE --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Users/RESOURCE_ID'

Respuestas

EstadoSignificadoCuerpo y encabezados
204El usuario se desactiva y deja de estar aprovisionado.sin cuerpo
400

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
401

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
403

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
404

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
429Se agotó el presupuesto de solicitudes de la organización (600 por minuto). Un error SCIM con status "429"; reintente tras el intervalo de Retry-After.SCIMError (application/scim+json); encabezados: Retry-After
predeterminado

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
GET/scim/v2/Groups

Listar grupos SCIM

Lista los grupos aprovisionados de la organización como un ListResponse de RFC 7644. filter es de uno a cuatro términos attr eq value unidos por and.

Los grupos se filtran por displayName, externalId, id, members y members.value; cualquier otro filtro es 400 invalidFilter. startIndex tiene base 1. count es 100 por defecto y como máximo 200; count=0 devuelve solo totalResults. attributes y excludedAttributes recortan los miembros devueltos.

Autenticación
scimBearer
Cuerpo de la solicitud
ninguno
ID de operación
listSCIMGroups

Parámetros

NombreEnviar¿Requerido?Descripción
filterconsultaopcionalDe uno a cuatro términos attr eq value unidos por and. Un valor es una cadena JSON entre comillas, o true o false para active. Un atributo, un operador o una forma no admitidos es 400 invalidFilter.
startIndexconsultaopcionalEl índice, con base 1, del primer resultado. Un valor menor que 1 se lee como 1.
countconsultaopcionalEl tamaño de página, como máximo 200. 0 devuelve solo totalResults. Un valor mayor se lee como 200.
attributesconsultaopcionalUna lista separada por comas de los atributos que se devuelven; los demás se omiten, salvo id y schemas.
excludedAttributesconsultaopcionalUna lista separada por comas de los atributos que se omiten.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Groups'

Respuestas

EstadoSignificadoCuerpo y encabezados
200Un ListResponse de grupos.SCIMResource (application/scim+json)
400

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
401

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
403

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
429Se agotó el presupuesto de solicitudes de la organización (600 por minuto). Un error SCIM con status "429"; reintente tras el intervalo de Retry-After.SCIMError (application/scim+json); encabezados: Retry-After
predeterminado

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
POST/scim/v2/Groups

Crear grupo SCIM

Aprovisiona un grupo y responde 201 con el recurso y su Location. displayName es único en la organización, comparado sin distinguir mayúsculas; un duplicado es 409 uniqueness. Un grupo no concede ningún acceso hasta que una persona que puede aprobar lo vincula a un proyecto en el panel.

Autenticación
scimBearer
Cuerpo de la solicitud
SCIMResource
ID de operación
createSCIMGroup

Campos del cuerpo de la solicitud

CampoDescripción
schemas (opcional, arreglo)Los URN de los esquemas que sigue el documento.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request POST --header 'Authorization: Bearer [SCIM_TOKEN]' --header 'Content-Type: application/scim+json' --data '@request.json' 'https://api.screenrig.ai/scim/v2/Groups'

Respuestas

EstadoSignificadoCuerpo y encabezados
201El grupo aprovisionado.SCIMResource (application/scim+json); encabezados: Location
400

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
401

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
403

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
409

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
429Se agotó el presupuesto de solicitudes de la organización (600 por minuto). Un error SCIM con status "429"; reintente tras el intervalo de Retry-After.SCIMError (application/scim+json); encabezados: Retry-After
predeterminado

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
GET/scim/v2/Groups/{id}

Obtener grupo SCIM

Lee un grupo aprovisionado. attributes y excludedAttributes recortan los miembros devueltos.

Autenticación
scimBearer
Cuerpo de la solicitud
ninguno
ID de operación
getSCIMGroup

Parámetros

NombreEnviar¿Requerido?Descripción
idrutarequeridoEl id de un recurso aprovisionado, tal como lo devolvió el servicio SCIM.
attributesconsultaopcionalUna lista separada por comas de los atributos que se devuelven; los demás se omiten, salvo id y schemas.
excludedAttributesconsultaopcionalUna lista separada por comas de los atributos que se omiten.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request GET --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Groups/RESOURCE_ID'

Respuestas

EstadoSignificadoCuerpo y encabezados
200El grupo.SCIMResource (application/scim+json)
401

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
403

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
404

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
429Se agotó el presupuesto de solicitudes de la organización (600 por minuto). Un error SCIM con status "429"; reintente tras el intervalo de Retry-After.SCIMError (application/scim+json); encabezados: Retry-After
predeterminado

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
PUT/scim/v2/Groups/{id}

Reemplazar grupo SCIM

Reemplaza un grupo aprovisionado por el documento enviado. Un documento sin members conserva los miembros del grupo. Los cambios de membresía concilian el acceso a proyectos de las personas afectadas, lo cual es idempotente.

Autenticación
scimBearer
Cuerpo de la solicitud
SCIMResource
ID de operación
replaceSCIMGroup

Parámetros

NombreEnviar¿Requerido?Descripción
idrutarequeridoEl id de un recurso aprovisionado, tal como lo devolvió el servicio SCIM.

Campos del cuerpo de la solicitud

CampoDescripción
schemas (opcional, arreglo)Los URN de los esquemas que sigue el documento.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
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'

Respuestas

EstadoSignificadoCuerpo y encabezados
200El grupo tal como está almacenado.SCIMResource (application/scim+json)
400

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
401

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
403

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
404

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
409

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
429Se agotó el presupuesto de solicitudes de la organización (600 por minuto). Un error SCIM con status "429"; reintente tras el intervalo de Retry-After.SCIMError (application/scim+json); encabezados: Retry-After
predeterminado

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
PATCH/scim/v2/Groups/{id}

Parche de grupo SCIM

Aplica un mensaje PatchOp de RFC 7644 a un grupo aprovisionado y responde 204, o 200 con el grupo cuando se indican attributes o excludedAttributes.

Las operaciones se leen tal como las envían Microsoft Entra ID y Okta, con o sin ?aadOptscim062020: los nombres de op no distinguen mayúsculas; los booleanos son true o false, o "True" o "False"; una operación puede omitir path o usar claves con puntos como name.givenName; las rutas incluyen emails[type eq "work"].value, members (add, replace y remove con un arreglo value) y members[value eq "<id>"] (remove); los atributos que screenRIG no usa se aceptan y se ignoran.

Los cambios de membresía concilian el acceso a proyectos de las personas afectadas, lo cual es idempotente.

Autenticación
scimBearer
Cuerpo de la solicitud
SCIMResource
ID de operación
patchSCIMGroup

Parámetros

NombreEnviar¿Requerido?Descripción
idrutarequeridoEl id de un recurso aprovisionado, tal como lo devolvió el servicio SCIM.
attributesconsultaopcionalUna lista separada por comas de los atributos que se devuelven; los demás se omiten, salvo id y schemas.
excludedAttributesconsultaopcionalUna lista separada por comas de los atributos que se omiten.

Campos del cuerpo de la solicitud

CampoDescripción
schemas (opcional, arreglo)Los URN de los esquemas que sigue el documento.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
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'

Respuestas

EstadoSignificadoCuerpo y encabezados
200El grupo tal como está almacenado, cuando se indicaron attributes o excludedAttributes.SCIMResource (application/scim+json)
204El parche se aplica.sin cuerpo
400

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
401

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
403

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
404

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
409

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
429Se agotó el presupuesto de solicitudes de la organización (600 por minuto). Un error SCIM con status "429"; reintente tras el intervalo de Retry-After.SCIMError (application/scim+json); encabezados: Retry-After
predeterminado

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
ELIMINAR/scim/v2/Groups/{id}

Eliminar grupo SCIM

Elimina un grupo aprovisionado junto con sus vinculaciones a proyectos. Las personas que tenían acceso solo a través de esas vinculaciones lo pierden; una membresía concedida a mano permanece.

Autenticación
scimBearer
Cuerpo de la solicitud
ninguno
ID de operación
deleteSCIMGroup

Parámetros

NombreEnviar¿Requerido?Descripción
idrutarequeridoEl id de un recurso aprovisionado, tal como lo devolvió el servicio SCIM.
Plantilla y respuestas de solicitud
shell · plantilla de solicitud
curl --request DELETE --header 'Authorization: Bearer [SCIM_TOKEN]' 'https://api.screenrig.ai/scim/v2/Groups/RESOURCE_ID'

Respuestas

EstadoSignificadoCuerpo y encabezados
204El grupo se elimina.sin cuerpo
401

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
403

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
404

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)
429Se agotó el presupuesto de solicitudes de la organización (600 por minuto). Un error SCIM con status "429"; reintente tras el intervalo de Retry-After.SCIMError (application/scim+json); encabezados: Retry-After
predeterminado

Un error SCIM de RFC 7644 sección 3.12, application/scim+json, no un documento de problema. status repite el estado HTTP como cadena y scimType nombra la clase (invalidFilter, uniqueness, mutability y las demás del RFC); detail indica qué se rechazó. 401 es un token desconocido o revocado y 403 una organización con SCIM deshabilitado.

SCIMError (application/scim+json)