はじめに

業務でZendeskを利用しているのですが、トラブルシューティングの際にコマンド一つで知りたくなるものです。WebにアクセスせずにAPIでユーザー情報を取得する方法です。

Zendesk API Searchを使う

こちらのCore API #Search を使います。

.../api/v2/search.json?query={search_string}

{search_string}には、ユーザーID、名前、作成日などを指定できます。Search Referenceで詳しい記法が載っていました。

事前準備

Zendeskの管理画面に行き、APIトークンを取得します。
Zendesk公式のドキュメント>> APIトークンを作成して管理する

画面はこちら

サンプルリクエスト

curl "https://{subdomain}.zendesk.com/api/v2/search.json" \
-G --data-urlencode "query=type:user {search username}" \
-v -u {email_address}/token:{api_token}

ユーザー情報を取得するので、type:user
{search username}には、検索したい名前を入れよう例. テスト太郎
{email_address}には、Zendeskのエージェントであるメールアドレス
{api_token}には、前述のAPIトークン

サンプルレスポンス

取得できたEmail、ユーザーIDは適当に書き換えましたが、このようなJSON形式の文字列で取得できます。

{
    "count": 1, 
    "facets": null, 
    "next_page": null, 
    "previous_page": null, 
    "results": [
        {
            "active": true, 
            "alias": "", 
            "chat_only": false, 
            "created_at": "2014-01-16T15:54:53Z", 
            "custom_role_id": null, 
            "default_group_id": null, 
            "details": "", 
            "email": "xxxxxx@xxxxx", 
            "external_id": null, 
            "id": 0000000000, 
            "last_login_at": "2018-02-07T06:25:56Z", 
            "locale": "ja", 
            "locale_id": 67, 
            "moderator": false, 
            "name": "テスト",
            ...//以下、省略

プロキシ経由で実行する場合

次のコマンドを実行してから、リクエストするといいです。

変数 http_proxy にはプロキシサーバーを指定


export http_proxy=http://...
export https_proxy="${http_proxy}"
export HTTP_PROXY="${http_proxy}"
export HTTPS_PROXY="${http_proxy}"

さいごに

cURLコマンドを使って、すぐ確認することができそうです。

Zendesk APIでUsersを簡単に取得する方法