API キーの管理

組織が公開 Cloud Identity Portal API での処理に使用できる API 資格情報を生成します。

このタスクについて

API キーを作成、編集、および削除します。

手順

  1. ナビゲーション・ペインで、「Company Profile」 > 「API Key Management」をクリックします。
  2. API キーを管理します。
    REST API キーの追加
    1. 「+ Add New API Key」をクリックします。
    2. 以下のフィールドを指定します。
      表 1. API キーのフィールド
      フィールド 説明
      Key Alias API キーの代替名を 50 文字以下の英数字で、識別しやすいように作成します。
      Key Description キーの使用目的とキーの場所を説明します。
      Access Token Validity このトークンの有効期間 (秒単位) を指定します。入力した値のおおよその時間数または日数が、このフィールドの隣に表示されます。クライアント ID秘密鍵、および grant_typeURL POST https://GmaApi/oauth/token に送信すると、アクセス・トークンを取得します。 このアクセス・トークンを使用して、API の呼び出しを行います。
      注: 新規 API キーを作成すると、秘密鍵が一度表示されます。新規 API キーの変更を保存すると、秘密鍵は二度と表示されません。
      アクセス・トークンの有効期限が切れたら、クライアント ID秘密鍵、および grant_type を使用して新しいアクセス・トークンを取得します。あるいは、リフレッシュ・トークンとクライアント ID秘密鍵を使用することで、新しいアクセス・トークンを取得することができます。
      Refresh Token Validity 「Refresh Token Validity」時間の秒数を指定します。この秒数は、「Access Token Validity」の値より大きくなければなりません。入力した値のおおよその時間数または日数が、このフィールドの隣に表示されます。
    REST API キーの編集または削除
    1. 「Narrow your search」バーで検索するか、キー名の隣にある矢印をクリックして、編集または削除する API キーの詳細を表示します。
    2. 編集または削除する API キー名を選択します。
    3. 次のいずれかのアクションを行います。
      • 表 1 に記載されているもののいずれかの値を編集または変更します。
      • 「Remove Key」をクリックしてキーを完全に削除します。