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