この記事の対象者:
- 組織のセキュリティ管理者
- 組織ワークスペース管理者
- ワークスペース所有者
WorkivaのAPIにアクセスするには、ユーザは権限のためのAPI付与が必要です。ユーザー用のAPI付与を作成すると、グラントの詳細を編集したり、グラントを削除したりできるようになります。ただし、ユーザープロフィールで付与を再生成することで、そのユーザーだけが自分の付与シークレットを閲覧できるようになります。
API付与の作成
API付与の作成を開始するには:
- ワークスペース設定で、 セキュリティ タブを開き、API付与の作成を選択します。
- API付与に以下の情報を入力します:
-
- クライアント名には、この付与を識別するのに役立つ名前を入力します。
- ワークスペースには、この付与が帰属するワークスペースを入力します。
-
Workivaユーザー名には、API の付与を必要とするユーザーのユーザー名を入力します。この API 付与の秘密情報は、このユーザーだけがマイ・プロフィール> セキュリティで見ることができます。
メモ: セキュリティ上、後でWorkiva ユーザー名 を変更した場合、現在のシークレットは無効となり、新規ユーザーだけが新しいシークレット に使用することができます。
-
スコープでは、システムがユーザーに代わって実行できるアクションを指定します。
メモ: スコープの詳細は、Understanding API Grant Scopes をご参照ください。
組織スコープ (organization:read or organization:write) を割り当てるには、組織管理で API グラントを作成および管理する を参照してください。 - 有効期限では、組織のセキュリティ ポリシーと設定に基づいて、付与の有効期限を設定します。
- 必要に応じて、 IP許可リストに、付与する IP アドレスのリストをカンマ区切りで入力します。
-
- 「付与を追加」をクリックして完了します。
API付与の管理
アクションドロップダウンでそれぞれのアクションをクリックすると、特定のグラントの詳細を編集したり、グラントを削除したりできます。
API付与シークレットの表示
API 付与の詳細で指定されたユーザーだけが、マイプロフィールにアクセスして、セキュリティタブを選択し、アクションドロップダウンで再生成をクリックして、グラントの秘密情報を表示できます。ユーザーは秘密を一度しか見ることができないので、安全な場所にコピーしておく必要があります。秘密を失ったら、また秘密を再生する必要があります。
注: 秘密情報は "wk_secret:" で始まります。