Service-Clients
Ein Service-Client ist ein Server, ein Skript oder ein CI-Job des Projekts; er meldet sich mit einem eigenen Schlüssel oder Secret an, statt mit der Zustimmung einer Person. Um einen Client zu erstellen oder zu ändern, benötigt der Agent Manage-Zugriff für seine Identität mit dem Geltungsbereich identity, eine eigene Manage-Berechtigung mit der Fähigkeit project im Zielprojekt und eine verifizierte verantwortliche Person, die die Organisation dieses Projekts verwaltet. Ein Service-Client verwaltet nie Clients. Um Befehle als der Client auszuführen, führen Sie einmal screenrig --config PATH login --client-id scl_ID --client-key-file KEY.pem (oder --client-secret-file FILE) aus und verwenden Sie diese Konfiguration; screenrig logout entfernt den gespeicherten Client. Siehe Service-Clients.
service-client list#
Service-Clients dieses Projekts auflisten, aktiv und widerrufen, mit ihren Schlüsseln, geheimen IDs und Nutzung.
service-client listKeine Parameter.
screenrig service-client listGibt niemals ein Geheimnis zurück.
service-client show#
Einen Service-Client anzeigen.
service-client show ID| Parameter | Typ | Erforderlich | Standard | Notizen |
|---|---|---|---|---|
ID | string | ja | keine | Die Client-ID, scl_…. |
screenrig service-client show scl_IDJeden Schlüssel kid und jede geheime css_ ID für die Rotation auflisten.
service-client create#
Erstellen Sie einen Service-Client, der diesem Projekt gehört.
service-client create --name NAME [--capability NAME]... [--access read|propose|manage]
[--uploader --folder-id IDS [--playlist-id IDS]] [--key-file PATH] [--secret-file PATH]| Parameter | Typ | Erforderlich | Standard | Notizen |
|---|---|---|---|---|
--name NAME | string | ja | keine | 1 bis 80 Zeichen. |
--capability NAME | string | nein | alle sechs | Wiederholbar: screens, content, playlists, advertising, reports, project, jeweils innerhalb Ihrer. |
--access LEVEL | string | nein | lesen | read, propose oder manage; propose für einen Uploader. propose sendet Playlist- und Bildschirmänderungen an die Überprüfung einer Person. |
--uploader | boolean | nein | aus | Den Client auf die mit --folder-id und --playlist-id angegebenen Medienordner und Playlists beschränken. |
--folder-id IDS | string | mit --uploader | keine | Durch Kommas getrennte mfd_-Medienordner, in die der Client hochlädt; mindestens einer. |
--playlist-id IDS | string | nein | keine | Mit --uploader: durch Kommas getrennte pl_-Playlists, deren Seiten der Client ändert. |
--key-file PATH | Pfad | eines davon | keine | Ein JWK oder PEM: Ed25519, EC P-256 oder RSA mit mindestens 2048 Bit. Es wird nur die öffentliche Hälfte gesendet. |
--secret-file PATH | Pfad | eines davon | keine | Ein Geheimnis erzeugen und in diese neue 0600-Datei schreiben. Es wird einmal angezeigt. |
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.secretErfordert die oben beschriebenen Berechtigungen für Identität, Projekt und Organisationsverwaltung. Ein Uploader arbeitet nur in seinen Ordnern und Playlists: Er lädt Medien dorthin hoch und fügt Seiten dieser Playlists hinzu, ersetzt und entfernt sie, alles andere ist outside_upload_scope. Höchstens 50 aktive Clients pro Organisation, gezählt über alle ihre Projekte. Ein Schlüssel ohne eigenes kid wird durch seinen RFC-7638-Fingerabdruck identifiziert.
service-client add-key#
Registrieren Sie einen zweiten öffentlichen Schlüssel für eine Rotation ohne Ausfallzeiten.
service-client add-key ID --key-file PATH| Parameter | Typ | Erforderlich | Standard | Notizen |
|---|---|---|---|---|
ID | string | ja | keine | Die Client-ID. |
--key-file PATH | Pfad | ja | keine | Der neue öffentliche Schlüssel, ein JWK oder PEM. |
screenrig service-client add-key scl_ID --key-file new.pemEin Client hält höchstens zwei Schlüssel.
service-client add-secret#
Ein zweites Geheimnis für eine Rotation ohne Ausfallzeit erzeugen.
service-client add-secret ID --secret-file PATH| Parameter | Typ | Erforderlich | Standard | Notizen |
|---|---|---|---|---|
ID | string | ja | keine | Die Client-ID. |
--secret-file PATH | Pfad | ja | keine | Eine neue 0600-Datei, die das Secret erhält. |
screenrig service-client add-secret scl_ID --secret-file new-secretEin Client hält höchstens zwei Geheimnisse. Das aktuelle funktioniert weiter, bis Sie es entfernen.
service-client remove-key#
Schlüssel entfernen; damit ausgestellte Tokens funktionieren innerhalb von Sekunden nicht mehr.
service-client remove-key ID --kid KID| Parameter | Typ | Erforderlich | Standard | Notizen |
|---|---|---|---|---|
ID | string | ja | keine | Die Client-ID. |
--kid KID | string | ja | keine | Die Schlüssel-ID von service-client show. |
screenrig service-client remove-key scl_ID --kid KIDEin Client behält mindestens einen Schlüssel oder ein Geheimnis.
service-client remove-secret#
Geheimnis entfernen; damit ausgestellte Tokens funktionieren innerhalb von Sekunden nicht mehr.
service-client remove-secret ID --secret-id css_ID| Parameter | Typ | Erforderlich | Standard | Notizen |
|---|---|---|---|---|
ID | string | ja | keine | Die Client-ID. |
--secret-id ID | string | ja | keine | Die css_ Geheim-ID von service-client show. |
screenrig service-client remove-secret scl_ID --secret-id css_IDEin Client behält mindestens einen Schlüssel oder ein Geheimnis.
service-client revoke#
Einen Service-Client dauerhaft widerrufen.
service-client revoke ID --yes| Parameter | Typ | Erforderlich | Standard | Notizen |
|---|---|---|---|---|
ID | string | ja | keine | Die Client-ID. |
--yes | boolean | ja | aus | Die dauerhafte Widerrufung bestätigen. |
screenrig service-client revoke scl_ID --yesLöscht seine Schlüssel und Geheimnisse; seine Tokens funktionieren innerhalb von Sekunden nicht mehr. Der Datensatz bleibt zur Prüfung erhalten.