現在のプランを確認
Suite すべてのプラン
Support すべてのプラン

ユーザーは2つの認証方法のいずれかを使用してZendesk APIにアクセスできます。1つ目は、APIトークンと呼ばれる自動生成パスワードを使用します。2つ目は、OAuthアクセストークンで、これはAPIトークンとは異なります。

新しいアカウントでは、両方の認証方法がデフォルトで無効になっています。この記事では、各認証方法を有効または無効にして、Zendesk APIへのユーザーアクセスを管理する方法を説明します。

  • APIへのAPIトークンアクセスの管理
  • APIへのOAuthトークンアクセスの管理
APIリクエストでこれらの認証方法のいずれかを使用するには、developer.zendesk.comの「Security and authentication」を参照してください。

Zendesk APIの使用について詳しくは、次のページを参照してください。

  • Zendesk開発者向けドキュメント
  • Zendesk APIリファレンス
  • Zendesk APIコミュニティ

APIへのAPIトークンアクセスの管理

ユーザーは、APIトークンを使用してAPIリクエストを認証できます。APIトークンは自動生成されたパスワードで、ユーザー名と一緒にAPIリクエストの認証に使用されます。また、APIトークンは、インテグレーションの2要素認証の一部として使用することができます。各APIトークンは、アカウントの認証済みユーザーが使用でき、特定のユーザーに関連付けられていません。一度に複数のトークンをアクティブにできます。

最大256個のトークンを持つことができます。制限に達した場合、新しいトークンを追加するには既存のトークンを削除する必要があります。ただし、トークンが現在256個を超えているアカウントには、2048個の上限が適用されます。

APIトークンはOAuthアクセストークンと同じではありません。詳しくは、developer.zendesk.comで、「Differences between API tokens and access tokens」を参照してください。

このセクションでは、以下のトピックについて説明します。
  • APIトークンアクセスを有効にする
  • APIトークンを生成する
  • APIトークンを削除する

APIトークンを使用してAPIリクエストを認証する方法については、developer.zendesk.comの「API token」を参照してください。

APIトークンアクセスを有効にする

APIトークンアクセスはデフォルトで無効になっています。ユーザーがAPIトークンを使用できるようにするには、管理センターでAPIトークンアクセスを有効にする必要があります。

APIトークンアクセスを有効にするには

  1. 管理センターで、サイドバーの「 アプリおよびインテグレーション」をクリックし、「API」>「Zendesk API」を選択します。
  2. 「設定」タブで、トークンアクセスを有効にします。

APIトークンを生成する

APIトークンを生成するには、管理者であること、アカウントでAPIトークンアクセスが有効になっていることが必要です。

APIトークンを生成するには

  1. 管理センターで、サイドバーの「 アプリおよびインテグレーション」をクリックし、「API」>「Zendesk API」を選択します。
  2. アクティブなAPIトークンの右側にある「APIトークンを追加」ボタンをクリックします。

    トークンが生成され、表示されます。

  3. （オプション）APIトークンの説明を入力します。
  4. トークンをコピーし、安全な場所に貼り付けてください。「保存」をクリックすると、完全なトークンは二度と表示されません。
  5. 「保存」をクリックして、Zendesk APIのページに戻ります。

    トークンをクリックして再度開くと、トークンの短縮バージョンが表示されます。

APIトークンを削除する

APIトークンはパスワードのようなもので、アカウントの認証済みユーザーやメールアドレスを持っている人なら誰でも、APIリクエストの認証に使用することができます。APIトークンが侵害されたことに気づいた場合は、すぐに削除してください。トークンを削除すると、そのトークンは完全に非アクティブになります。

APIトークンを削除するには

  1. 管理センターで、サイドバーの「 アプリおよびインテグレーション」をクリックし、「API」>「Zendesk API」を選択します。
  2. リスト内のトークンを選択し、右側の「削除」をクリックします。

APIへのOAuthトークンアクセスの管理

OAuthアクセストークンを使用してAPIリクエストを認証できます。OAuthは、アプリケーションがZendeskのデータにアクセスする際に、機密情報であるAPIトークンを保存して使用することなく、安全にアクセスする方法を提供します。

APIトークンとは異なり、管理センターで直接OAuthアクセストークンを作成することはできません。まず管理センターでOAuthクライアントを作成し、定義されたOAuth認証フローでOAuthクライアントを使用してOAuthアクセストークンを作成する必要があります。

OAuthアクセストークンはAPIトークンと同じではありません。詳しくは、developer.zendesk.comで、「Differences between API tokens and access tokens」を参照してください。

ここでは、以下のトピックについて説明します。

  • OAuthクライアントを作成する
  • OAuthクライアントでアクセストークンを作成する
  • OAuthクライアントとトークンを削除する

OAuthアクセストークンを使用してAPIリクエストを認証するには、developer.zendesk.comの「OAuth access token」を参照してください。

OAuthクライアントを作成する

OAuthクライアントを使用すると、APIリクエストの認証に使用できるOAuthアクセストークンを作成できます。OAuthアクセストークンはAPIトークンと異なります。OAuthアクセストークンは、アプリケーションがZendeskユーザーのAPIトークンを保存および使用することなくZendesk APIにアクセスするための安全な手段です。

OAuthクライアントを作成するには

  1. 管理センターで、サイドバーの「 アプリおよびインテグレーション」をクリックし、「API」>「Zendesk API」を選択します。
  2. 「OAuthクライアント」タブを選択します。
  3. クライアントを作成するには、「OAuthクライアントを追加」ボタンをクリックし、「アプリケーションをZendeskに登録する」の手順に従ってください。
  4. クライアントを削除するには、リスト内のクライアントを選択し、右側の「削除」をクリックします。

次に、OAuthクライアントを使用して、1つ以上のOAuthアクセストークンを作成します。

OAuthクライアントでアクセストークンを作成する

管理センターでOAuthクライアントを作成した後、定義された認証フローでOAuthクライアントを使用してOAuthアクセストークンを作成できます。

また、APIでOAuthクライアントを使用して、認証フローなしでアクセストークンを作成することもできます。これらのAPIトークンを使用してAPIリクエストを認証できます。developer.zendesk.comで「Creating and using OAuth access tokens with the API」を参照してください。

OAuthクライアントとトークンを削除する

OAuthクライアントを削除すると、そのクライアントで作成されたすべてのアクセストークンを非アクティブにすることができます。アクセストークンを個別に取り消すこともできます。

OAuthクライアントを削除するには

  1. 管理センターで、サイドバーの「 アプリおよびインテグレーション」をクリックし、「API」>「Zendesk API」を選択します。
  2. 「OAuthクライアント」タブを選択します。
  3. リスト内のクライアントを選択し、右側の「削除」をクリックします。

アクセストークンを個別に取り消すには

  • developer.zendesk.comで「Revoking an access token」を参照してください。
Powered by Zendesk