管理者ユーザーの追加のプロパティを構成し、API トークンを作成できます。

パートナー ポータルで、[管理者 (Admins)] をクリックします。管理者ユーザーを構成するには、ユーザー名へのリンクをクリックするか、ユーザーを選択して [アクション (Actions)] > [管理者の変更 (Modify Admin)] をクリックします。

選択したユーザーの既存のプロパティが表示されます。必要に応じて、次の項目を追加または変更できます。

[ステータス (Status)]

デフォルトでは、ステータスは [有効 (Enabled)] 状態になっています。[無効 (Disabled)] を選択すると、ユーザーはすべてのアクティブなセッションからログアウトされます。

[タイプ (Type)]

パートナー認証の構成でパートナー認証モードとして [ネイティブ (Native)] を選択した場合は、ユーザーのタイプとして [ネイティブ (Native)] が選択されます。別の認証モードを選択した場合は、ユーザーのタイプを選択できます。ユーザーを [非ネイティブ (Non-Native)] として選択した場合、パスワードをリセットしたり、ユーザー ロールを変更したりすることはできません。

[プロパティ (Property)]

ユーザーの既存の連絡先詳細が表示されます。必要に応じて、詳細を変更したり、パスワードのリセットを選択したりすることができます。[パスワードのリセット (Password Reset)] をクリックすると、パスワードをリセットするためのリンクを含む E メールがユーザーに送信されます。

[ユーザー ロール (User Role)]

ユーザー ロールの既存のタイプが表示されます。必要に応じて、ユーザーに別のロールを選択できます。ロールの権限がこれに応じて変更されます。

[API トークン (API Tokens)]

ユーザーは、セッションベースの認証ではなく、トークンを使用して Orchestrator API にアクセスできます。パートナー スーパー ユーザーは、エンタープライズ ユーザーの API トークンを管理できます。ユーザーに対して複数の API トークンを作成できます。

[API トークンの構成]

ユーザーは、自分のユーザー ロールに割り当てられている権限に基づいてトークンを作成できます。ただし、ビジネス スペシャリスト ユーザーを除きます。

ユーザーは、ロールに基づいて次のアクションを実行できます。

  • エンタープライズ ユーザーは、トークンの作成、ダウンロード、および取り消しを行うことができます。
  • パートナー スーパー ユーザーは、エンタープライズ ユーザーからユーザー権限を委任されている場合、エンタープライズ ユーザーのトークンを管理できます。
  • パートナー スーパー ユーザーは、他のユーザーのトークンの作成と取り消しのみを実行できます。
  • ユーザーは自分自身のトークンのみをダウンロードでき、他のユーザーのトークンをダウンロードすることはできません。

[API トークンを管理するには、次の手順を実行します。]

  • [API トークン (API Tokens)] セクションで [アクション (Actions)] > [新規 API トークン (New API Token)] をクリックして、新しいトークンを作成します。
  • [新規 API トークン (New API Token)] 画面で、トークンの [名前 (Name)][説明 (Description)] を入力し、ドロップダウン メニューから [有効期間 (Lifetime)] を選択します。

  • [作成 (Create)] をクリックすると、[API トークン (API Tokens)] グリッドに新しいトークンが表示されます。
  • 最初に、トークンのステータスは [保留中 (Pending)] として表示されます。トークンをダウンロードするには、トークンを選択し、[アクション (Actions)] > [API トークンをダウンロード (Download API Token)] をクリックします。ステータスが [有効 (Enabled)] に変わります。これは API トークンを API アクセスに使用できることを意味します。
  • トークンを無効にするには、トークンを選択し、[アクション (Actions)] > [API トークンを取り消す (Revoke API Token)] をクリックします。トークンのステータスは [取り消し済み (Revoked)] として表示されます。
  • トークンの有効期間が過ぎると、ステータスは [期限切れ (Expired)] に変わります。

トークンに関連付けられているユーザーのみがトークンをダウンロードでき、ダウンロード後にトークンの ID のみが表示されます。トークンをダウンロードできるのは 1 回だけです。

トークンをダウンロードすると、ユーザーは、それを Orchestrator API にアクセスするための要求の認証ヘッダーの一部として送信できます。

次の例は、API にアクセスするコードのサンプル スニペットを示しています。

curl -k -H "Authorization: Token <Token>"
  -X POST https://vco/portal/
  -d '{ "id": 1, "jsonrpc": "2.0", "method": "enterprise/getEnterpriseUsers", "params": { "enterpriseId": 1 }}'

設定と API トークンを変更した後、[変更の保存 (Save Changes)] をクリックします。