screenRIG
サインイン開始する

ドキュメント

サービスクライアント CLI コマンド

サービスクライアントの作成、キーとシークレットの追加と削除、失効。サーバー、スクリプト、CI ジョブ用のサインインです。

ここにあるコマンドはすべて CLI リファレンスの説明どおりに動作します。グローバルフラグ、JSON 出力、終了コード、リビジョン、再試行。

サービスクライアント

サービスクライアントは、プロジェクトが所有するサーバー、スクリプト、または CI ジョブで、人の承認の代わりに独自のキーまたはシークレットでサインインします。クライアントを作成または変更するには、エージェントに、identity スコープを持つアイデンティティの管理アクセス、対象プロジェクトで project 機能を含むエージェント自身の管理権限の付与、およびそのプロジェクトの組織を管理する本人確認済みの責任者が必要です。サービスクライアントがクライアントを管理することはありません。クライアントとしてコマンドを実行するには、screenrig --config PATH login --client-id scl_ID --client-key-file KEY.pem（または --client-secret-file FILE）を一度実行し、その設定を使用します。screenrig logout は保存されたクライアントを削除します。サービスクライアントを参照してください。

service-client list#

このプロジェクトのサービスクライアント一覧（有効・無効含む）、キー・シークレットID・使用状況付き

service-client list

パラメーターなし。

screenrig service-client list

秘密を返しません。

service-client show#

1つのサービスクライアントを表示します。

service-client show ID
パラメータータイプ必須デフォルトメモ
IDstringはいなしクライアントID、scl_…。
screenrig service-client show scl_ID

各キーのkidと各シークレットのcss_IDをローテーション用に一覧表示

service-client create#

このプロジェクト所有のサービスクライアントを作成。

service-client create --name NAME [--capability NAME]... [--access read|propose|manage]
                      [--uploader --folder-id IDS [--playlist-id IDS]] [--key-file PATH] [--secret-file PATH]
パラメータータイプ必須デフォルトメモ
--name NAMEstringはいなし1～80文字。
--capability NAMEstringいいえ6つすべて繰り返し可能：screens、content、playlists、advertising、reports、project、それぞれあなたの範囲内。
--access LEVELstringいいえ読み取りread、propose、またはmanage。アップローダーにはpropose。proposeはプレイリストとスクリーンの変更を人のレビューに送信します。
--uploaderbooleanいいえオフクライアントを --folder-id と --playlist-id で指定したメディアフォルダーとプレイリストに限定します。
--folder-id IDSstring--uploader とともになしクライアントのアップロード先となる mfd_ メディアフォルダー。カンマ区切りで、1つ以上。
--playlist-id IDSstringいいえなし--uploader を指定した場合：クライアントがページを変更する pl_ プレイリスト（カンマ区切り）。
--key-file PATHパスこれらのうちの1つなしJWK または PEM 形式の Ed25519、EC P-256、または 2048 ビット以上の RSA 公開鍵です。送信されるのは公開部分のみです。
--secret-file PATHパスこれらのうちの1つなしシークレットを生成し、この新しい0600ファイルに書き込みます。一度だけ表示されます。
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

上記のアイデンティティ、プロジェクト、組織管理者の権限が必要です。アップローダーは自分のフォルダーとプレイリストでのみ作業します。そこにメディアをアップロードし、それらのプレイリストのページを追加、置換、削除できますが、それ以外は outside_upload_scope になります。組織ごとに有効なクライアントは、すべてのプロジェクトを合わせて最大 50 個です。独自の kid がない鍵は RFC 7638 のサムプリントで識別されます。

service-client add-key#

ダウンタイムなしのローテーションのために2つ目の公開鍵を登録します。

service-client add-key ID --key-file PATH
パラメータータイプ必須デフォルトメモ
IDstringはいなしクライアントID。
--key-file PATHパスはいなし新しい公開鍵、JWKまたはPEM。
screenrig service-client add-key scl_ID --key-file new.pem

クライアントは最大で2つのキーを保持します。

service-client add-secret#

ダウンタイムなしのローテーション用に2つ目のシークレットを生成します。

service-client add-secret ID --secret-file PATH
パラメータータイプ必須デフォルトメモ
IDstringはいなしクライアントID。
--secret-file PATHパスはいなしシークレットを受け取る新しい0600ファイルです。
screenrig service-client add-secret scl_ID --secret-file new-secret

クライアントは最大で2つのシークレットを保持します。現在のものは削除するまで有効です。

service-client remove-key#

キーを削除します。これにより発行されたトークンは数秒で無効になります。

service-client remove-key ID --kid KID
パラメータータイプ必須デフォルトメモ
IDstringはいなしクライアントID。
--kid KIDstringはいなしservice-client showからのキーID。
screenrig service-client remove-key scl_ID --kid KID

クライアントは少なくとも1つのキーまたはシークレットを保持します。

service-client remove-secret#

シークレットを削除します。これにより発行されたトークンは数秒で無効になります。

service-client remove-secret ID --secret-id css_ID
パラメータータイプ必須デフォルトメモ
IDstringはいなしクライアントID。
--secret-id IDstringはいなしservice-client showからのcss_シークレットID
screenrig service-client remove-secret scl_ID --secret-id css_ID

クライアントは少なくとも1つのキーまたはシークレットを保持します。

service-client revoke#

サービスクライアントを永久に取り消します。

service-client revoke ID --yes
パラメータータイプ必須デフォルトメモ
IDstringはいなしクライアントID。
--yesbooleanはいオフ恒久的な取り消しを確認。
screenrig service-client revoke scl_ID --yes

キーとシークレットを削除します。トークンは数秒以内に無効になります。レコードは監査のために保持されます。

ほかのコマンドグループ