Documentación

Clientes del servicio: comandos CLI

Crea clientes del servicio, añade y quita sus claves y secretos, y revócalos: el inicio de sesión para servidores, scripts y tareas de CI.

Cada comando se ejecuta como describe la referencia de la CLI: banderas globales, salida JSON, códigos de salida, revisiones y reintentos.

Clientes de servicio

Un cliente de servicio es un servidor, script o trabajo CI propiedad del proyecto, que inicia sesión con su propia clave o secreto en lugar de la aprobación de una persona. Para crear o cambiar un cliente, el agente necesita acceso Gestionar para su identidad con el ámbito identity, su propia autorización Gestionar con la capacidad project en el proyecto de destino y una persona responsable verificada que administre la organización de ese proyecto. Un cliente de servicio nunca administra clientes. Para ejecutar comandos como el cliente, ejecute screenrig --config PATH login --client-id scl_ID --client-key-file KEY.pem (o --client-secret-file FILE) una vez y use esa configuración; screenrig logout elimina el cliente guardado. Véase Clientes de servicio.

service-client list#

Listar los clientes de servicio de este proyecto, activos y revocados, con sus claves, IDs secretas y uso.

service-client list

Sin parámetros.

screenrig service-client list

Nunca devuelve un secreto.

service-client show#

Mostrar un cliente de servicio.

service-client show ID
ParámetroTipoRequeridoPredeterminadoNotas
IDstringsíningunoEl id del cliente, scl_….
screenrig service-client show scl_ID

Lista el kid de cada clave y el css_ de cada secreto para rotación.

service-client create#

Crear un cliente de servicio propiedad de este proyecto.

service-client create --name NAME [--capability NAME]... [--access read|propose|manage]
                      [--uploader --folder-id IDS [--playlist-id IDS]] [--key-file PATH] [--secret-file PATH]
ParámetroTipoRequeridoPredeterminadoNotas
--name NAMEstringsíningunoDe 1 a 80 caracteres.
--capability NAMEstringnolos seisRepetible: screens, content, playlists, advertising, reports, project, cada uno dentro de los suyos.
--access LEVELstringnoleerread, propose o manage; propose para un usuario de carga. propose envía los cambios de lista de reproducción y pantalla a la revisión de una persona.
--uploaderbooleannoapagadoLimitar el cliente a las carpetas multimedia y a las listas de reproducción indicadas con --folder-id y --playlist-id.
--folder-id IDSstringcon --uploaderningunoCarpetas multimedia mfd_ separadas por comas en las que el cliente sube archivos; al menos una.
--playlist-id IDSstringnoningunoCon --uploader: listas de reproducción pl_ separadas por comas cuyas páginas cambia el cliente.
--key-file PATHrutauno de estosningunoUn JWK o PEM: Ed25519, EC P-256 o RSA de al menos 2048 bits. Solo se envía la mitad pública.
--secret-file PATHrutauno de estosningunoGenerar un secreto y escribirlo en este nuevo archivo 0600. Se muestra una vez.
screenrig service-client create --name "Nightly report" --access read --capability reports --key-file screenrig-client.pem
screenrig service-client create --name "Agency agent" --uploader --folder-id mfd_01EXAMPLEFOLDER000000000 --playlist-id pl_01EXAMPLEPLAYLIST000000 --secret-file agency.secret

Requiere las autorizaciones de identidad, proyecto y administración de la organización descritas arriba. Un usuario de carga trabaja solo en sus carpetas y listas de reproducción: sube contenido multimedia a ellas y agrega, reemplaza y elimina páginas de esas listas, y cualquier otra cosa es outside_upload_scope. Máximo 50 clientes activos por organización, contados en todos sus proyectos. Una clave sin su propio kid se identifica mediante su huella RFC 7638.

service-client add-key#

Registrar una segunda clave pública para una rotación sin tiempo de inactividad.

service-client add-key ID --key-file PATH
ParámetroTipoRequeridoPredeterminadoNotas
IDstringsíningunoEl id del cliente.
--key-file PATHrutasíningunoLa nueva clave pública, un JWK o PEM.
screenrig service-client add-key scl_ID --key-file new.pem

Un cliente tiene como máximo dos claves.

service-client add-secret#

Generar un segundo secreto para una rotación sin tiempo de inactividad.

service-client add-secret ID --secret-file PATH
ParámetroTipoRequeridoPredeterminadoNotas
IDstringsíningunoEl id del cliente.
--secret-file PATHrutasíningunoUn nuevo archivo 0600 que recibe el secreto.
screenrig service-client add-secret scl_ID --secret-file new-secret

Un cliente tiene como máximo dos secretos. El actual sigue funcionando hasta que lo elimine.

service-client remove-key#

Eliminar una clave; los tokens emitidos con ella dejan de funcionar en segundos.

service-client remove-key ID --kid KID
ParámetroTipoRequeridoPredeterminadoNotas
IDstringsíningunoEl id del cliente.
--kid KIDstringsíningunoEl id de clave de service-client show.
screenrig service-client remove-key scl_ID --kid KID

Un cliente mantiene al menos una clave o secreto.

service-client remove-secret#

Eliminar un secreto; los tokens emitidos con él dejan de funcionar en segundos.

service-client remove-secret ID --secret-id css_ID
ParámetroTipoRequeridoPredeterminadoNotas
IDstringsíningunoEl id del cliente.
--secret-id IDstringsíningunoEl id secreto css_ de service-client show.
screenrig service-client remove-secret scl_ID --secret-id css_ID

Un cliente mantiene al menos una clave o secreto.

service-client revoke#

Revocar un cliente de servicio permanentemente.

service-client revoke ID --yes
ParámetroTipoRequeridoPredeterminadoNotas
IDstringsíningunoEl id del cliente.
--yesbooleansíapagadoConfirmar la revocación permanente.
screenrig service-client revoke scl_ID --yes

Elimina sus claves y secretos; sus tokens dejan de funcionar en segundos. El registro permanece para auditoría.

Otros grupos de comandos