この記事では、ワークスペースで API キーの利用設定を確認する方法を説明します。
はじめる前に
API キーの利用可否は、ワークスペース設定や承認制の状態によって変わります。API キーを発行できない場合は、ワークスペースのアドミンに確認してください。
API による操作やデータ連携は、API キーを発行したユーザーの閲覧・編集権限に基づきます。連携できるデータは、そのユーザーがアクセスできるボードに限定されます。
操作を始めるには、APIキー管理画面（https://strap.app/app/workspace/api-keys）に移動します。
API キーの利用設定を確認する
API キー連携を利用できるかどうかは、環境設定 の Strapコネクタ にある設定で変わります。
| 設定 | ON のとき | OFF のとき |
|---|---|---|
| APIキーの利用を許可する | ワークスペースで API キーを使えます。 | API キー連携を利用できません。 |
| メンバーの利用を許可する | メンバーも API キー連携を利用できます。 | API キー連携を利用できるのは、通常アドミンのみです。 |
| メンバーの利用を承認制にする | メンバーが発行した API キーは、アドミン承認後に利用できます。 | メンバーが発行した API キーは、発行後に利用できます。 |
設定の組み合わせと利用できる範囲
| APIキーの利用 | メンバー利用 | 承認制 | API キー連携での動き |
|---|---|---|---|
| OFF | - | - | API キー連携は利用できません。 |
| ON | OFF | - | アドミンは API キー連携を利用できます。メンバーは自分では利用できません。 |
| ON | ON | OFF | メンバーも API キー連携を利用できます。 |
| ON | ON | ON | メンバーは API キーを発行できますが、アドミン承認後に利用できます。 |
環境設定で メンバーの利用を承認制にする が ON の場合、メンバーが発行した API キーはすぐには利用できません。
画面には、次の案内が表示されます。
> Strapコネクタを使える権限は通常アドミンのみですが、設定次第でメンバーにも許可できます。承認制を有効にすると、メンバーが発行した API キーはアドミンの承認後に利用できます。
メンバーが発行した API キーは、一覧で 承認待ち と表示されます。アドミンは行のメニューから 承認、却下、削除 または 取り消し を選択できます。
| 操作 | 使う場面 | 操作後の状態 |
|---|---|---|
| 承認 | メンバーが発行した API キーの利用を許可するときに使います。 | API キーが利用可能になります。 |
| 却下 | 発行理由や用途が適切でない場合に使います。 | API キーは利用できません。必要であれば、メンバーに用途を確認して再発行してもらいます。 |
| 削除 | 不要な承認待ちキーや、管理上残したくないキーを削除するときに使います。 | API キーは管理画面から削除され、利用できなくなります。 |
承認制を使う場合は、メンバーが申請したキーの用途を確認してから承認してください。用途が分からないキーを承認すると、意図しない操作やデータ連携に使われる場合があります。
操作できない場合
| 状況 | 確認すること |
|---|---|
発行 ボタンが表示されない |
API キーの利用が許可されているか、自分の権限で発行できるかを確認します。 |
| 発行したキーが使えない | 承認制が有効になっていないか、キーが承認済みかを確認します。 |
承認待ち のまま使えない |
アドミンに承認されるまで利用できません。キーの用途を伝えて承認を依頼します。 |
| 連携先でエラーになる | API キーを正しくコピーできているか、対象ボードへの権限があるかを確認します。 |
| 連携が急に使えなくなった | アドミンによって API キーが停止または削除されていないかを確認します。 |
| 不要なキーが残っている | 使っていない API キーは削除または無効化します。 |
注意事項
API キーの利用設定を変更すると、API キーを使った連携や既存の運用に影響する場合があります。変更前に利用者と連携先を確認してください。