APIによるSecretsの管理
このガイドでは、Bitrise APIを使ってシークレットを管理する方法について説明します。UIで同様の操作を行う方法について詳しくは、Secretsをご覧ください。
| エンドポイント | 機能 | appのチームに必要なロール |
|---|---|---|
| GET/apps/{app-slug}/secrets | 指定したappのSecretsの一覧を取得します。 | Owner または Admin |
| GET/apps/{app-slug}/secrets/{secret-name}/value | (保護されていない)シークレットの値を取得します。 | Owner または Admin |
| PUT/apps/{app-slug}/secrets/{secret-name} | シークレットを作成または更新します。 | Owner または Admin |
| DELETE/apps/{app-slug}/secrets/{secret-name} | シークレットを削除します。 | Owner または Admin |
appのSecretsを表示するClick to copy link
必要なロール
Bitrise APIを使ってSecretsを表示するには、appのチームでadminまたはownerロールを持っている必要があります。
ユーザーロールとロールチートシートの完全な一覧については、appのチームにおけるユーザーロールをご確認ください。
APIを使って、appのSecretsを表示できます。
GET/apps/{app-slug}/secretsエンドポイントを使うと、appのすべてのSecretsの一覧を取得できます。
特定のシークレットは、そのis_protectedの値がfalseに設定されている場合に表示できます。
リクエスト:
curl -X GET -H 'Authorization: THE-ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG/secrets/test/value'
is_protectedの値がfalseに設定されている場合、レスポンスにシークレットの値が返されます。
{
"value": "123ld"
}
Secretsを作成または更新するClick to copy link
必要なロール
Bitrise APIを使ってSecretsを作成または更新するには、appのチームでadminまたはownerロールを持っている必要があります。
ユーザーロールとロールチートシートの完全な一覧については、appのチームにおけるユーザーロールをご確認ください。
secretsエンドポイントのPUTメソッドを使って、Secretsを作成または更新できます。
指定したsecret-nameのシークレットが存在しない場合は、新しいシークレットが作成されます。すでにシークレットが存在する場合は、指定した新しい値で更新されます。
必須のパラメーターは次のとおりです:
- app slug
- シークレットの名前
オプションのパラメーターは次のとおりです:
- expand_in_step_inputs: Stepsに渡す前にBitrise CLIでシークレットを展開したい場合はtrueに設定します。
- is_exposed_for_pull_requests: シークレットをプルリクエストに公開したい場合はtrueに設定します。
- is_protected: シークレットの値を保護したい場合はtrueに設定します(GETメソッドでシークレットの値を表示できなくなります)。
- value: シークレットに保存される値です。
リクエスト:
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"}'