この記事の対象者：
- 組織のセキュリティ管理者
API付与の作成
WorkivaのAPIにアクセスするには、ユーザは権限のためのAPI付与が必要です。 組織セキュリティ管理者 として、ユーザー用の API グラントを作成すると、グラントの詳細を編集したり、グラントを削除したりできるようになります。ただし、ユーザープロフィールで付与を再生成することで、そのユーザーだけが自分の付与シークレットを閲覧できるようになります。
API付与の作成を開始するには：
- 右上のユーザーアイコンをクリックし、ドロップダウンからAdmin を選択します。
- 次に、ドロップダウンからOrganization admin を選択します。
-
Organization Admin ページで、左のメニューペインからSecurity を選択し、Provisioning タブを選択します。
-
Create Identity Provider or API Grant の下で、Add Identity or API をクリックする。
-
ドロップダウンでAPI Grant を選択します。
以下の手順は、API Grant のためのものである。ID プロバイダについては、SCIM によるユーザの管理とプロビジョニング を参照。
- API付与に以下の情報を入力します：
- Client Name（クライアント名） に、この補助金を識別するのに役立つ名前を入力します。
- Workspace に、このグラントを付与するワークスペースを入力します。
-
Workiva Username に、API のグラントが必要なユーザーのユーザー名を入力します。
このユーザーだけが、My profile > Security で、このAPIグラントの秘密を見ることができます。注： セキュリティのため、ワーキバのユーザー名 を変更すると、現在のシークレットは無効になり、新しいユーザー名のみが新しいシークレット にアクセスできるようになります。
-
スコープ で、システムがユーザーに代わって実行できるアクションを指定します。
例えば、Spreadsheets APIについては、Spreadsheets (Read) とSpreadsheets (Write) を追加し、ユーザーがスプレッドシートにアクセスして編集できるようにする。 - Expires では、組織のセキュリティ ポリシーと設定に基づいて、付与の有効期限を設定します。
- (オプション）グラントのIP Allowlist に IP アドレスのカンマ区切りリストを入力します。
- Add Grant をクリックして完了する。
API付与の管理
そのグラントのアクション ドロップダウンでそれぞれのアクションをクリックすることで、特定のグラントの詳細を編集したり、グラントを削除したりできます。
API付与シークレットの表示
APIシークレットをビューするには、
- 右上のユーザーアイコンをクリックし、ドロップダウンからマイプロフィール を選択します。
- セキュリティ タブをクリックします。
- シークレットが必要な API グラントを探します。
- 付与の次へアクション ドロップダウンの再生成 をクリックします。
重要事項
- API グラントの詳細で指定したユーザーだけが、グラントのシークレットを閲覧できます。
- シークレットは一度しか閲覧できませんので、安全な場所にコピーしておく必要があります。
シークレットを紛失した場合、シークレットを再生成し、シークレットを必要とするすべての場所に新規シークレットを入力する必要があります。 - ヒント:シークレットは "wk_secret:" で始まります。