Documentação

Clientes de serviço: comandos da CLI

Crie clientes de serviço, adicione e remova chaves e segredos e revogue-os: o login de servidores, scripts e jobs de CI.

Cada comando funciona como descrito na referência da CLI: flags globais, saída JSON, códigos de saída, revisões e tentativas.

Clientes de serviço

Um cliente de serviço é um servidor, script ou job de CI pertencente ao projeto, que faz login com sua própria chave ou segredo em vez da aprovação de uma pessoa. Para criar ou alterar um cliente, o agente precisa de acesso Gerenciar para sua identidade com o escopo identity, de sua própria autorização Gerenciar com a capacidade project no projeto de destino e de uma pessoa responsável verificada que administre a organização desse projeto. Um cliente de serviço nunca gerencia clientes. Para executar comandos como o cliente, execute screenrig --config PATH login --client-id scl_ID --client-key-file KEY.pem (ou --client-secret-file FILE) uma vez e use essa configuração; screenrig logout remove o cliente salvo. Veja Clientes de serviço.

service-client list#

Listar os clientes de serviço deste projeto, ativos e revogados, com suas chaves, IDs secretas e uso.

service-client list

Sem parâmetros.

screenrig service-client list

Nunca retorna um segredo.

service-client show#

Exiba um cliente de serviço.

service-client show ID
ParâmetroTipoObrigatórioPadrãoNotas
IDstringsimnenhumO id do cliente, scl_….
screenrig service-client show scl_ID

Lista o kid de cada chave e o css_ de cada segredo para rotação.

service-client create#

Criar um cliente de serviço pertencente a este projeto.

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âmetroTipoObrigatórioPadrãoNotas
--name NAMEstringsimnenhum1 a 80 caracteres.
--capability NAMEstringnãotodos os seisRepetível: screens, content, playlists, advertising, reports, project, cada um dentro do seu.
--access LEVELstringnãolerread, propose ou manage; propose para um uploader. propose envia alterações de playlist e tela para a revisão de uma pessoa.
--uploaderbooleannãodesligadoLimite o cliente às pastas de mídia e playlists indicadas com --folder-id e --playlist-id.
--folder-id IDSstringcom --uploadernenhumPastas de mídia mfd_ separadas por vírgula nas quais o cliente faz upload; pelo menos uma.
--playlist-id IDSstringnãonenhumCom --uploader: playlists pl_ separadas por vírgula cujas páginas o cliente altera.
--key-file PATHcaminhoum destesnenhumUm JWK ou PEM: Ed25519, EC P-256 ou RSA de pelo menos 2048 bits. Apenas a metade pública é enviada.
--secret-file PATHcaminhoum destesnenhumGerar um segredo e gravá-lo neste novo arquivo 0600. Ele é exibido uma 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

Requer as autorizações de identidade, projeto e administração da organização descritas acima. Um uploader trabalha apenas em suas pastas e playlists: faz upload de mídia nelas e adiciona, substitui e remove páginas dessas playlists, e qualquer outra coisa é outside_upload_scope. No máximo 50 clientes ativos por organização, contados em todos os seus projetos. Uma chave sem seu próprio kid é identificada pela impressão digital RFC 7638.

service-client add-key#

Registre uma segunda chave pública para uma rotação sem tempo de inatividade.

service-client add-key ID --key-file PATH
ParâmetroTipoObrigatórioPadrãoNotas
IDstringsimnenhumO id do cliente.
--key-file PATHcaminhosimnenhumA nova chave pública, um JWK ou PEM.
screenrig service-client add-key scl_ID --key-file new.pem

Um cliente possui no máximo duas chaves.

service-client add-secret#

Gerar um segundo segredo para uma rotação sem tempo de inatividade.

service-client add-secret ID --secret-file PATH
ParâmetroTipoObrigatórioPadrãoNotas
IDstringsimnenhumO id do cliente.
--secret-file PATHcaminhosimnenhumUm novo arquivo 0600 que recebe o segredo.
screenrig service-client add-secret scl_ID --secret-file new-secret

Um cliente possui no máximo dois segredos. O atual continua funcionando até que você o remova.

service-client remove-key#

Remover uma chave; tokens emitidos com ela param de funcionar em segundos.

service-client remove-key ID --kid KID
ParâmetroTipoObrigatórioPadrãoNotas
IDstringsimnenhumO id do cliente.
--kid KIDstringsimnenhumO id da chave de service-client show.
screenrig service-client remove-key scl_ID --kid KID

Um cliente mantém pelo menos uma chave ou segredo.

service-client remove-secret#

Remover um segredo; tokens emitidos com ele param de funcionar em segundos.

service-client remove-secret ID --secret-id css_ID
ParâmetroTipoObrigatórioPadrãoNotas
IDstringsimnenhumO id do cliente.
--secret-id IDstringsimnenhumO id secreto css_ de service-client show.
screenrig service-client remove-secret scl_ID --secret-id css_ID

Um cliente mantém pelo menos uma chave ou segredo.

service-client revoke#

Revogar permanentemente um cliente de serviço.

service-client revoke ID --yes
ParâmetroTipoObrigatórioPadrãoNotas
IDstringsimnenhumO id do cliente.
--yesbooleansimdesligadoConfirme a revogação permanente.
screenrig service-client revoke scl_ID --yes

Exclui suas chaves e segredos; seus tokens param de funcionar em segundos. O registro permanece para auditoria.

Outros grupos de comandos