OpenAPI YAMLOpenAPI JSONproblemas YAMLResumen de la API
Este grupo tiene 9 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.
Clientes de servicio
Listar clientes de servicio
Los clientes de servicio del proyecto (especificación: un servidor, script o trabajo CI de un cliente propiedad del proyecto), los más nuevos primero, activos y revocados, con sus claves públicas, ids secretos y uso; nunca un secreto o su resumen. Necesita la capacidad del proyecto.
Parámetros
| Nombre | Enviar | ¿Requerido? | Descripción |
|---|---|---|---|
| ScreenRig-Project | encabezado | opcional | Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token. |
Plantilla y respuestas de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/service-clients'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 200 | El cliente de servicio. | ServiceClientList (application/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) |
Crear cliente de servicio
Crea un cliente de servicio propiedad del proyecto con un nombre, capacidades (omitido significa las seis; cada una debe ser poseída por el administrador, de lo contrario 403), acceso (lectura, por defecto, o gestión), y una clave pública JWK (OKP Ed25519, EC P-256 o RSA de al menos 2048 bits) y/o secreto verdadero. El secreto se devuelve una vez, solo aquí. Máximo 50 clientes activos por organización.
Los agentes necesitan alcance de identidad, identidad activa Gestionar, su propia concesión Gestionar con la capacidad del proyecto en el proyecto, y un rol activo de administrador de organización; una persona usa la sesión del panel con project_id y una prueba fresca (tipo service_client_change, sujeto el id del cliente, o el id del proyecto al crear) en el cuerpo. Un token de servicio es rechazado con 403.
Un miembro limitado a pantallas no conecta agentes, no emite credenciales ni administra a las personas del proyecto: outside_screen_scope (pida al propietario del proyecto).
Parámetros
| Nombre | Enviar | ¿Requerido? | Descripción |
|---|---|---|---|
| ScreenRig-Project | encabezado | opcional | Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token. |
Campos del cuerpo de la solicitud
| Campo | Descripción |
|---|---|
| project_id (opcional, cadena) | Solo sesión del panel. |
| proof (opcional, DashboardProof) | |
| nombre (opcional, cadena) | minLength: 1 maxLength: 80 |
| capacidades (opcional, arreglo) | |
| acceso (opcional, cadena) | Administrar requiere una persona que pueda aprobar revisiones (403 approver_required). Permitido: "leer", "proponer", "administrar" |
| key (opcional, objeto) | Una JWK pública: OKP Ed25519, EC P-256 o RSA de al menos 2048 bits. |
| secreto (opcional, booleano) | Generar un secreto (solo creación). |
| upload_scope (opcional, UploadScope) | Lo que un usuario de carga puede usar (docs/uploaders.md): las listas de reproducción cuyas páginas cambia y las carpetas de medios en las que sube. Las carpetas son exactamente las listadas, nunca sus subcarpetas. Un id que al escribirse no nombra ningún objeto activo del proyecto 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. |
Plantilla y respuestas de solicitud
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 201 | El cliente de servicio. | ServiceClientResult (application/json) |
| 402 | feature_not_in_plan — un alcance de carga crea un usuario de carga, y el plan del proyecto no incluye usuarios de carga; required_plan nombra el plan que sí los incluye. Restringir un alcance y quitarlo siempre están permitidos. | Problema (application/problem+json) |
| 403 | outside_screen_scope - el llamador está limitado a pantallas y la pantalla, carpeta de pantallas, selector o audiencia que nombra o alcanza la solicitud está fuera de ellas (docs/screen-scope.md). Un id fuera del alcance y un id que no existe reciben la misma respuesta; errors[0].screen_scope lleva el alcance del llamador, y la escritura se rechaza por completo, nunca se acota. | 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) |
Obtener cliente de servicio
Uno de los clientes de servicio del proyecto. Necesita la capacidad del proyecto.
Parámetros
| Nombre | Enviar | ¿Requerido? | Descripción |
|---|---|---|---|
| ScreenRig-Project | encabezado | opcional | Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token. |
| id | ruta | requerido |
Plantilla y respuestas de solicitud
curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 200 | El cliente de servicio. | ServiceClient (application/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) |
Actualizar cliente de servicio
Renombra un cliente de servicio o cambia sus capacidades (dentro de las del administrador) o acceso. Restringir cualquiera termina los tokens actuales del cliente en segundos.
Los agentes necesitan alcance de identidad, identidad activa Gestionar, su propia concesión Gestionar con la capacidad del proyecto en el proyecto, y un rol activo de administrador de organización; una persona usa la sesión del panel con project_id y una prueba fresca (tipo service_client_change, sujeto el id del cliente, o el id del proyecto al crear) en el cuerpo. Un token de servicio es rechazado con 403.
Un miembro limitado a pantallas no conecta agentes, no emite credenciales ni administra a las personas del proyecto: outside_screen_scope (pida al propietario del proyecto).
Parámetros
| Nombre | Enviar | ¿Requerido? | Descripción |
|---|---|---|---|
| ScreenRig-Project | encabezado | opcional | Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token. |
| id | ruta | requerido |
Campos del cuerpo de la solicitud
| Campo | Descripción |
|---|---|
| project_id (opcional, cadena) | Solo sesión del panel. |
| proof (opcional, DashboardProof) | |
| nombre (opcional, cadena) | minLength: 1 maxLength: 80 |
| capacidades (opcional, arreglo) | |
| acceso (opcional, cadena) | Administrar requiere una persona que pueda aprobar revisiones (403 approver_required). Permitido: "leer", "proponer", "administrar" |
| key (opcional, objeto) | Una JWK pública: OKP Ed25519, EC P-256 o RSA de al menos 2048 bits. |
| secreto (opcional, booleano) | Generar un secreto (solo creación). |
| upload_scope (opcional, UploadScope) | Lo que un usuario de carga puede usar (docs/uploaders.md): las listas de reproducción cuyas páginas cambia y las carpetas de medios en las que sube. Las carpetas son exactamente las listadas, nunca sus subcarpetas. Un id que al escribirse no nombra ningún objeto activo del proyecto 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. |
Plantilla y respuestas de solicitud
curl --request PATCH --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 200 | El cliente de servicio. | ServiceClientResult (application/json) |
| 402 | feature_not_in_plan — un alcance de carga crea un usuario de carga, y el plan del proyecto no incluye usuarios de carga; required_plan nombra el plan que sí los incluye. Restringir un alcance y quitarlo siempre están permitidos. | Problema (application/problem+json) |
| 403 | outside_screen_scope - el llamador está limitado a pantallas y la pantalla, carpeta de pantallas, selector o audiencia que nombra o alcanza la solicitud está fuera de ellas (docs/screen-scope.md). Un id fuera del alcance y un id que no existe reciben la misma respuesta; errors[0].screen_scope lleva el alcance del llamador, y la escritura se rechaza por completo, nunca se acota. | 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) |
Agregar clave de cliente de servicio
Registra una segunda clave pública JWK (clave en el cuerpo) para una rotación sin tiempo de inactividad; un cliente mantiene como máximo dos.
Los agentes necesitan alcance de identidad, identidad activa Gestionar, su propia concesión Gestionar con la capacidad del proyecto en el proyecto, y un rol activo de administrador de organización; una persona usa la sesión del panel con project_id y una prueba fresca (tipo service_client_change, sujeto el id del cliente, o el id del proyecto al crear) en el cuerpo. Un token de servicio es rechazado con 403.
Un miembro limitado a pantallas no conecta agentes, no emite credenciales ni administra a las personas del proyecto: outside_screen_scope (pida al propietario del proyecto).
Parámetros
| Nombre | Enviar | ¿Requerido? | Descripción |
|---|---|---|---|
| ScreenRig-Project | encabezado | opcional | Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token. |
| id | ruta | requerido |
Campos del cuerpo de la solicitud
| Campo | Descripción |
|---|---|
| project_id (opcional, cadena) | Solo sesión del panel. |
| proof (opcional, DashboardProof) | |
| nombre (opcional, cadena) | minLength: 1 maxLength: 80 |
| capacidades (opcional, arreglo) | |
| acceso (opcional, cadena) | Administrar requiere una persona que pueda aprobar revisiones (403 approver_required). Permitido: "leer", "proponer", "administrar" |
| key (opcional, objeto) | Una JWK pública: OKP Ed25519, EC P-256 o RSA de al menos 2048 bits. |
| secreto (opcional, booleano) | Generar un secreto (solo creación). |
| upload_scope (opcional, UploadScope) | Lo que un usuario de carga puede usar (docs/uploaders.md): las listas de reproducción cuyas páginas cambia y las carpetas de medios en las que sube. Las carpetas son exactamente las listadas, nunca sus subcarpetas. Un id que al escribirse no nombra ningún objeto activo del proyecto 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. |
Plantilla y respuestas de solicitud
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID/keys'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 200 | El cliente de servicio. | ServiceClientResult (application/json) |
| 403 | outside_screen_scope - el llamador está limitado a pantallas y la pantalla, carpeta de pantallas, selector o audiencia que nombra o alcanza la solicitud está fuera de ellas (docs/screen-scope.md). Un id fuera del alcance y un id que no existe reciben la misma respuesta; errors[0].screen_scope lleva el alcance del llamador, y la escritura se rechaza por completo, nunca se acota. | 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 clave de cliente de servicio
Elimina una clave; los tokens actuales del cliente terminan en segundos. Un cliente mantiene al menos una clave o secreto.
Los agentes necesitan alcance de identidad, identidad activa Gestionar, su propia concesión Gestionar con la capacidad del proyecto en el proyecto, y un rol activo de administrador de organización; una persona usa la sesión del panel con project_id y una prueba fresca (tipo service_client_change, sujeto el id del cliente, o el id del proyecto al crear) en el cuerpo. Un token de servicio es rechazado con 403.
Un miembro limitado a pantallas no conecta agentes, no emite credenciales ni administra a las personas del proyecto: outside_screen_scope (pida al propietario del proyecto).
Parámetros
| Nombre | Enviar | ¿Requerido? | Descripción |
|---|---|---|---|
| ScreenRig-Project | encabezado | opcional | Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token. |
| id | ruta | requerido | |
| kid | ruta | requerido |
Campos del cuerpo de la solicitud
| Campo | Descripción |
|---|---|
| project_id (opcional, cadena) | Solo sesión del panel. |
| proof (opcional, DashboardProof) | |
| nombre (opcional, cadena) | minLength: 1 maxLength: 80 |
| capacidades (opcional, arreglo) | |
| acceso (opcional, cadena) | Administrar requiere una persona que pueda aprobar revisiones (403 approver_required). Permitido: "leer", "proponer", "administrar" |
| key (opcional, objeto) | Una JWK pública: OKP Ed25519, EC P-256 o RSA de al menos 2048 bits. |
| secreto (opcional, booleano) | Generar un secreto (solo creación). |
| upload_scope (opcional, UploadScope) | Lo que un usuario de carga puede usar (docs/uploaders.md): las listas de reproducción cuyas páginas cambia y las carpetas de medios en las que sube. Las carpetas son exactamente las listadas, nunca sus subcarpetas. Un id que al escribirse no nombra ningún objeto activo del proyecto 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. |
Plantilla y respuestas de solicitud
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID/keys/KID/remove'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 200 | El cliente de servicio. | ServiceClientResult (application/json) |
| 403 | outside_screen_scope - el llamador está limitado a pantallas y la pantalla, carpeta de pantallas, selector o audiencia que nombra o alcanza la solicitud está fuera de ellas (docs/screen-scope.md). Un id fuera del alcance y un id que no existe reciben la misma respuesta; errors[0].screen_scope lleva el alcance del llamador, y la escritura se rechaza por completo, nunca se acota. | 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) |
Agregar secreto de cliente de servicio
Genera un segundo secreto, devuelto una vez, para una rotación sin tiempo de inactividad; un cliente mantiene como máximo dos.
Los agentes necesitan alcance de identidad, identidad activa Gestionar, su propia concesión Gestionar con la capacidad del proyecto en el proyecto, y un rol activo de administrador de organización; una persona usa la sesión del panel con project_id y una prueba fresca (tipo service_client_change, sujeto el id del cliente, o el id del proyecto al crear) en el cuerpo. Un token de servicio es rechazado con 403.
Un miembro limitado a pantallas no conecta agentes, no emite credenciales ni administra a las personas del proyecto: outside_screen_scope (pida al propietario del proyecto).
Parámetros
| Nombre | Enviar | ¿Requerido? | Descripción |
|---|---|---|---|
| ScreenRig-Project | encabezado | opcional | Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token. |
| id | ruta | requerido |
Campos del cuerpo de la solicitud
| Campo | Descripción |
|---|---|
| project_id (opcional, cadena) | Solo sesión del panel. |
| proof (opcional, DashboardProof) | |
| nombre (opcional, cadena) | minLength: 1 maxLength: 80 |
| capacidades (opcional, arreglo) | |
| acceso (opcional, cadena) | Administrar requiere una persona que pueda aprobar revisiones (403 approver_required). Permitido: "leer", "proponer", "administrar" |
| key (opcional, objeto) | Una JWK pública: OKP Ed25519, EC P-256 o RSA de al menos 2048 bits. |
| secreto (opcional, booleano) | Generar un secreto (solo creación). |
| upload_scope (opcional, UploadScope) | Lo que un usuario de carga puede usar (docs/uploaders.md): las listas de reproducción cuyas páginas cambia y las carpetas de medios en las que sube. Las carpetas son exactamente las listadas, nunca sus subcarpetas. Un id que al escribirse no nombra ningún objeto activo del proyecto 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. |
Plantilla y respuestas de solicitud
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID/secrets'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 200 | El cliente de servicio. | ServiceClientResult (application/json) |
| 403 | outside_screen_scope - el llamador está limitado a pantallas y la pantalla, carpeta de pantallas, selector o audiencia que nombra o alcanza la solicitud está fuera de ellas (docs/screen-scope.md). Un id fuera del alcance y un id que no existe reciben la misma respuesta; errors[0].screen_scope lleva el alcance del llamador, y la escritura se rechaza por completo, nunca se acota. | 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 secreto de cliente de servicio
Elimina un secreto; los tokens actuales del cliente terminan en segundos.
Los agentes necesitan alcance de identidad, identidad activa Gestionar, su propia concesión Gestionar con la capacidad del proyecto en el proyecto, y un rol activo de administrador de organización; una persona usa la sesión del panel con project_id y una prueba fresca (tipo service_client_change, sujeto el id del cliente, o el id del proyecto al crear) en el cuerpo. Un token de servicio es rechazado con 403.
Un miembro limitado a pantallas no conecta agentes, no emite credenciales ni administra a las personas del proyecto: outside_screen_scope (pida al propietario del proyecto).
Parámetros
| Nombre | Enviar | ¿Requerido? | Descripción |
|---|---|---|---|
| ScreenRig-Project | encabezado | opcional | Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token. |
| id | ruta | requerido | |
| secret_id | ruta | requerido |
Campos del cuerpo de la solicitud
| Campo | Descripción |
|---|---|
| project_id (opcional, cadena) | Solo sesión del panel. |
| proof (opcional, DashboardProof) | |
| nombre (opcional, cadena) | minLength: 1 maxLength: 80 |
| capacidades (opcional, arreglo) | |
| acceso (opcional, cadena) | Administrar requiere una persona que pueda aprobar revisiones (403 approver_required). Permitido: "leer", "proponer", "administrar" |
| key (opcional, objeto) | Una JWK pública: OKP Ed25519, EC P-256 o RSA de al menos 2048 bits. |
| secreto (opcional, booleano) | Generar un secreto (solo creación). |
| upload_scope (opcional, UploadScope) | Lo que un usuario de carga puede usar (docs/uploaders.md): las listas de reproducción cuyas páginas cambia y las carpetas de medios en las que sube. Las carpetas son exactamente las listadas, nunca sus subcarpetas. Un id que al escribirse no nombra ningún objeto activo del proyecto 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. |
Plantilla y respuestas de solicitud
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID/secrets/SECRET_ID/remove'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 200 | El cliente de servicio. | ServiceClientResult (application/json) |
| 403 | outside_screen_scope - el llamador está limitado a pantallas y la pantalla, carpeta de pantallas, selector o audiencia que nombra o alcanza la solicitud está fuera de ellas (docs/screen-scope.md). Un id fuera del alcance y un id que no existe reciben la misma respuesta; errors[0].screen_scope lleva el alcance del llamador, y la escritura se rechaza por completo, nunca se acota. | 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) |
Revocar cliente de servicio
Revoca un cliente de servicio permanentemente: sus claves y resúmenes secretos se eliminan, el registro permanece para auditoría y sus tokens terminan en segundos (propagación aplicada o pendiente).
Los agentes necesitan alcance de identidad, identidad activa Gestionar, su propia concesión Gestionar con la capacidad del proyecto en el proyecto, y un rol activo de administrador de organización; una persona usa la sesión del panel con project_id y una prueba fresca (tipo service_client_change, sujeto el id del cliente, o el id del proyecto al crear) en el cuerpo. Un token de servicio es rechazado con 403.
Un miembro limitado a pantallas no conecta agentes, no emite credenciales ni administra a las personas del proyecto: outside_screen_scope (pida al propietario del proyecto).
Parámetros
| Nombre | Enviar | ¿Requerido? | Descripción |
|---|---|---|---|
| ScreenRig-Project | encabezado | opcional | Obsoleto por una versión. Debe ser consistente con las concesiones de proyectos JWT; añade encabezados Deprecation y Warning. Sin intercambio de token. |
| id | ruta | requerido |
Campos del cuerpo de la solicitud
| Campo | Descripción |
|---|---|
| project_id (opcional, cadena) | Solo sesión del panel. |
| proof (opcional, DashboardProof) | |
| nombre (opcional, cadena) | minLength: 1 maxLength: 80 |
| capacidades (opcional, arreglo) | |
| acceso (opcional, cadena) | Administrar requiere una persona que pueda aprobar revisiones (403 approver_required). Permitido: "leer", "proponer", "administrar" |
| key (opcional, objeto) | Una JWK pública: OKP Ed25519, EC P-256 o RSA de al menos 2048 bits. |
| secreto (opcional, booleano) | Generar un secreto (solo creación). |
| upload_scope (opcional, UploadScope) | Lo que un usuario de carga puede usar (docs/uploaders.md): las listas de reproducción cuyas páginas cambia y las carpetas de medios en las que sube. Las carpetas son exactamente las listadas, nunca sus subcarpetas. Un id que al escribirse no nombra ningún objeto activo del proyecto 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. |
Plantilla y respuestas de solicitud
curl --request POST --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://api.screenrig.ai/api/service-clients/RESOURCE_ID/revoke'Respuestas
| Estado | Significado | Cuerpo y encabezados |
|---|---|---|
| 200 | El cliente de servicio. | ServiceClientResult (application/json) |
| 403 | outside_screen_scope - el llamador está limitado a pantallas y la pantalla, carpeta de pantallas, selector o audiencia que nombra o alcanza la solicitud está fuera de ellas (docs/screen-scope.md). Un id fuera del alcance y un id que no existe reciben la misma respuesta; errors[0].screen_scope lleva el alcance del llamador, y la escritura se rechaza por completo, nunca se acota. | 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) |