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