アプリケーションの作成

ユーザー管理ページで、管理者はクライアントIDとクライアントシークレットを取得するためのアプリケーションを作成できます。

アプリケーションを作成するには:

1. [管理] > [ユーザー管理] > [認証] タブ > [OAuth アプリケーション] タブに移動します。
2. [アプリケーションの追加] をクリックします。
3. [名前]フィールドに、アプリケーションの一意の名前を入力します。
4. [スコープ]ドロップダウンリストから、[読み取り]または[読み取り/書き込み]を選択します。
   注記: アプリケーション内で選択されたスコープは、すべてのGainsight APIに適用されます。
5. [コールバックURL]フィールドに、コールバックのURLを入力します。
6. (オプション)[別の URL を追加] をクリックして、コールバック用の別のURLを追加します。
7. [アプリケーションの追加] をクリックします。クライアントIDとクライアントシークレットが生成され、一覧ページからコピーできます。

重要：

• 管理者は、Gainsightで作成できるアプリケーションは1つだけです。同じクライアントIDを使用して、ブラウザーで渡されるさまざまなスコープに対して複数の認証コードを生成できます。これらの認証コードは、さまざまな外部エージェント(ブラウザーまたはアプリケーション)からアクセストークンを生成するために使用できます。認証コードとアクセストークンの詳細については、認証コードの取得とアクセストークンの生成のセクションを参照してください。

• アプリケーションを作成する際、Gainsight APIにアクセスする外部アプリケーションのアクセスタイプを定義する際に、(アプリケーションで選択された) 権限とスコープが重要な役割を果たします。以下は、選択したスコープとユーザーのアクセス許可に基づいてアクセスが提供される2つのシナリオです。

  •  認可ユーザーの権限が、アプリケーションまたはブラウザーで提供される範囲よりも少ない場合、外部アプリケーションのアクセスレベルはユーザーの権限に従います。
    
    例えば、ユーザーが読み取りアクセス許可しか持っていない場合、同じユーザーによって承認されたアプリケーションは、APIを介してアクセスされるオブジェクトに書き込むことはできません。
  • アプリケーションまたはブラウザーで提供されるスコープが、ユーザーに与えられたアクセス許可よりも小さい場合、外部アプリケーションのアクセスレベルは、アプリケーションまたはブラウザーで提供されるスコープに従います。

• 認証コードの生成後、アプリケーションのスコープが変更された場合、ユーザーは新しいスコープの認証コードを再生成する必要があります。

• アクセストークンが生成された後、承認ユーザーの権限が変更された場合、既存のトークンはユーザーの以前の権限に従ってデータにアクセスできるため、新しいアクセストークンとリフレッシュトークンを生成するために再承認する必要があります。

認証コードを取得する

アプリケーションを作成したら、認証コードを生成する必要があります。認証コードは、アクセストークンとリフレッシュトークンを生成するために使用されます。

注記: 認可コードは、スコープのタイプ(読み取りまたは読み取り/書き込み)ごとに生成できます。

認証コードを取得するには:    

1. 新しいブラウザータブで、次のURLを入力し、アプリケーションURL、クライアントID、コールバックURL、およびスコープを置き換えます。

   URL形式: <アプリケーションURLを挿入>/v1/authorize?clientId=<クライアントIDを挿入>&redirectUri=<コールバックURLを挿入>&scopes=<スコープ>

   サンプル URL: https://xyzcompany.gainsightcloud.com/v1/authorize?clientId=yGCCltz2ZZuqhUqfB2DgUPInBaFlq7uR&redirectUri=https://oauthtest..com&scopes=read_write
   
   重要：

• アプリケーションの作成中に指定されたredirectUriとコールバックURLは同じである必要があります。
• readまたはread_writeの2つのスコープのみを指定できます。

2. キーボードのEnterキーを押します。Gainsightのログインページが表示されます。
3. ユーザー名とパスワードを入力します。
   
   注記: アプリケーションは、アプリケーションを承認したユーザーの権限に基づいてデータにアクセスできます。
    
4. ログインをクリックします。これにより、アプリケーションで提供されるコールバックURLにリダイレクトされます。認証コードはURLで確認できます。

アクセストークンの生成

POSTメソッドに以下のURLを入力することでアクセストークンを生成できます。

URL: <アプリケーションURL>/v1/users/oauth/token

注：

• ユーザー権限は、アクセストークンを使用して呼び出されたときにAPIがアクセスできるデータを制限します。
• Gainsightは、OAuth認証の認証コードフローに従います。つまり、アクセス トークンを生成するには認証コードが必要です。

リクエスト本文のクライアントシークレットと認証コードを置き換えます。

    
{
  
"clientId":   「クライアントIDを挿入」、
  
"clientSecret":   「クライアントシークレットを挿入」、
  
"grantType":"authorization_code"、
  
"redirectUri"   : 「URLを挿入」、
  
"code"   :"「コードを挿入」
  
}

アクセストークン(有効期間3600秒)とリフレッシュトークンを含むJSON応答が返されます。以下はJSON応答のサンプルです。

    
{
  
"result":   true,
  
"errorCode":   null,
  
"errorDesc":   null,
  
"requestId":   "wquoiueoiasd"、
  
"data":   {
  
"accessToken":   "ukjds80asdsvdfvsdvdsvsdvsdvdvskjlklk112nkl"、
  
"refreshToken":   "dassadaadjlsadjlsaddadvdsddsdvsdvdvdssdvd"、
  
"TokenType":   "Bearer"
  
"expiresIn":   3600
  
}、
  
"message":   null
  
}

このアクセストークンは、Gainsight APIおよびBulk APIジョブのcURLコマンドで使用できます。cURLコマンドを生成する方法の詳細については、Gainsight バルク APIおよび APIとDeveloper Docs (近日公開予定) の記事を参照してください。

リクエスト本文

{
"clientId": <Insert clientId>,
"clientSecret": <Insert clientSecret>,
"refreshToken": <Insert refreshToken>
}

方法の詳細