Skip to main content

API を使用したシークレットの管理

このガイドでは、Bitrise API を使用してシークレットを管理する方法について説明します。 UI で同じことを行う方法について詳しく知りたい場合は、こちらをご覧ください。シークレット.

表1 シークレットに関連するエンドポイント

エンドポイント

関数

アプリのチームで必要な役割

GET/apps/{app-slug}/secrets

指定されたアプリの Secret のリストを取得します。

所有者または管理者

GET/apps/{app-slug}/secrets/{secret-name}/value

(保護されていない) Secret の値を取得します。

所有者または管理者

PUT/apps/{app-slug}/secrets/{secret-name}

シークレットを作成または更新します。

所有者または管理者

DELETE/apps/{app-slug}/secrets/{secret-name}

シークレットを削除します。

所有者または管理者

アプリのシークレットを表示する

必要な役割

Bitrise API を使用してシークレットを表示するには、アプリのチームで管理者または所有者の役割を持っている必要があります。

ユーザーの役割と役割のチートシートの完全なリストについては、以下を確認してください。アプリ チームのユーザー ロール.

あなたは見ることができます シークレット API の助けを借りてアプリの。

アプリのすべてのシークレットのリストを取得するには、 GET/apps/{app-slug}/secrets 終点。

特定のシークレットを表示できます is_protected 値はに設定されています false.

例1 「test」というアプリのシークレットを表示する

リクエスト：

curl -X GET -H  'Authorization: THE-ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG/secrets/test/value'

レスポンスは、Secret の値を示します。 is_protected 値はに設定されています false:

{
  "value": "123ld"
}

Secret の作成または更新

必要な役割

Bitrise API を使用してシークレットを作成/更新するには、アプリのチームで管理者または所有者の役割を持っている必要があります。

ユーザーの役割と役割のチートシートの完全なリストについては、以下を確認してください。アプリ チームのユーザー ロール.

の PUT メソッドを使用してシークレットを作成または更新できます。 secrets 終点。

もし ひみつ と一緒に存在しません secret-name 指定すると、新しい Secret が作成されます。シークレットが既に存在する場合は、指定した新しい値で更新されます。

必須パラメータは次のとおりです。

  • アプリスラッグ

  • 秘密の名前

オプションのパラメーターは次のとおりです。

  • expand_in_step_inputs: Steps に渡す前に Bitrise CLI に Secret を展開させたい場合は true に設定します。

  • is_exposed_for_pull_requests: シークレットをプル リクエスト用に公開する場合は、true に設定します。

  • is_protected: Secret の値を保護する場合は true に設定します。 (GET メソッドを使用して Secret の値を表示することはできません。)

  • value: シークレットに格納されている値。

例1 「test」という名前の新しい Secret を作成する

リクエスト：

curl -X PUT -H 'Authorization: THE-ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/THE-APP-SLUG/secrets/test' -d '{"expand_in_step_inputs": true, "is_exposed_for_pull_requests": true, "is_protected": false, "value": "123ld2"}'

このセクションの内容:
シークレットひみつ