OAuth リファレンス

HTTP リクエストヘッダー、スコープ、API エンドポイント、リクエストパラメーター、レスポンスフィールドを説明します。

 

法的注意

本 API および本ドキュメントを利用し、連携を構築することにより、Additional API Terms and Guidelines に同意したものとみなされます。

HTTP リクエストヘッダー

リクエストヘッダーは次のとおりです。

HTTP リクエストヘッダー

ヘッダー	値と説明
Accept	application/json
Authorization	Bearer <token> 各 API 呼び出しでは、Bearer 認証スキームを使用してこのヘッダーにアクセストークンを渡します。 Authorization ヘッダーを渡せるのは、oauth/v2/tokens エンドポイントを通じてアクセストークンをリクエストまたは更新する場合のみです。 アクセストークンを取得する際は、oauth/v2/tokens のリクエストボディでクライアント ID とクライアントシークレットを渡す代わりに、Basic 認証スキームを使用できます。 アクセストークンとBasic 認証スキームもご覧ください。
Content-Type	application/json

Basic 認証スキーム

アクセストークンを取得する際は、/oauth/v2/tokens のリクエストボディでクライアント ID とクライアントシークレットを渡す代わりに、Basic 認証スキームを使用できます。このスキームを使用するには、これらの認証情報をエンコードし、Authorization Basic ヘッダーで渡します。

RFC 2617: HTTP Authentication: Basic and Digest Access Authentication の Basic Authentication Scheme もご覧ください。

Authorization Basic ヘッダーの値を生成するには、次の手順で行います。

1. client_id と client_secret を、区切り文字としてコロン（:）で連結します。

   base64.encode("<client_id>:<client_secret>");

2. その文字列に Base64 エンコードアルゴリズムを適用します。

   base64.encode("5e175cbb7f88e2048bd95323bbc9ca2fcec32ad60f95f7ee66ab53e099abe6f3:pJ4qRe2sdXRP0Whr3bwz9D37exFuuOtqJDRHMmmlLWV7J25rH7oItrPNCKzhaQf2");

3. Base64 エンコードされた文字列を、基本 HTTP Authorization ヘッダーとして渡します。

   Authorization: Basic NWUxNzVjYmI3Zjg4ZTIwNDhiZDk1MzIzYmJjOWNhMmZjZWMzMmFkNjBmOTVmN2VlNjZhYjUzZTA5OWFiZTZmMzpwSjRxUmUyc2RYUlAwV2hyM2J3ejlEMzdleEZ1dU90cUpEUkhNbW1sTFdWN0oyNXJIN29JdHJQTkNLemhhUWYy

スコープ

スコープは、アプリ自身、他のユーザーアカウント、またはそれらに関連付けられた雇用主アカウントに代わって動作することをアプリに認可します。

一部の Indeed API では、アクセストークンをリクエストする際に追加のスコープが必要です。API 固有のスコープについては、各 API のドキュメントをご覧ください。

アプリに権限を付与するには、アクセストークンを取得する際に scope パラメーターを含めます。

OAuth 同意画面

認可コードグラントタイプ（3-legged OAuth）では、アプリが https://secure.indeed.com/oauth/v2/authorize を呼び出すと、Indeed は OAuth 同意画面 を表示します。用語集をご覧ください。

ユーザーがアプリのリクエストするスコープ（employer_access など）に対して Allow を選択すると、Indeed は認可コードを redirect_uri に送信し、code、iss、state のレスポンスフィールドを追加します。oauth/v2/authorize のレスポンスフィールドをご覧ください。

ユーザーが一度スコープを付与すると、アプリはそのスコープを保持します。たとえば、その後アプリが employer_access を必要とする場合、OAuth 同意画面では employer_access に対してのみユーザーに許可を求め、email や offline_access については再度求めません。

認可を行うユーザーは、いつでも Indeed の Third-party applications with account access ページでアプリに付与したスコープを取り消せます。次回そのアプリを使用するときに、ユーザーは再度スコープを付与できます。

インクリメンタル認可

インクリメンタル認可を使用すると、OAuth アプリは必要なスコープのみをリクエストできます。これには offline_access スコープが必要です。これにより、アプリがすでに保持している権限が維持されます。たとえば、アプリが email スコープをリクエストする場合は、offline_access もリクエストする必要があります。

付与されたスコープ

oauth/v2/tokens レスポンスの consented_scope フィールドには、アプリに付与されたスコープが一覧表示されます。

{
  "access_token": "<access_token>",
  "refresh_token": "<refresh_token>",
  "id_token": "<id_token>",
  "scope": "offline_access employer_access email",
  "consented_scope": "offline_access employer_access email",
  "convid": "1er835qvtu54n800",
  "token_type": "Bearer",
  "expires_in": 3600
}

また、認可コードグラントタイプ（3-legged OAuth）では、OAuth 同意画面の Current permissions タブにアプリのスコープが一覧表示されます。

アプリケーションスコープ

スコープ	権限
email	同意画面: メールアドレスを表示 ID トークンまたは v2/api/userinfo エンドポイント から、ユーザーの email と email_verified の状態をアプリが読み取れるようにします。 userinfo エンドポイントをご覧ください。 ✔ 3-legged OAuth
employer_access	同意画面: ユーザーアカウントに関連付けられた雇用主を一覧表示し、雇用主のアクセストークンを取得する ユーザーに関連付けられたすべての雇用主アカウントを一覧表示します。雇用主のアクセストークンを取得するために必要です。 雇用主を一覧表示し、雇用主のアクセストークンを取得する方法については、次をご覧ください。 3-legged OAuth については、採用企業を表すアクセストークンを取得するをご覧ください。 2-legged OAuth については、採用企業を表すアクセストークンを取得するをご覧ください。 ✔ 3-legged OAuth ✔ 2-legged OAuth
offline_access	同意画面: 付与した権限を維持する リフレッシュトークンを生成するために必要です。Indeed OAuth アクセストークンは 1 時間後に期限切れになるため、新しいアクセストークンを取得するにはリフレッシュトークンを使用します。 ✔ 3-legged OAuth

oauth/v2/authorize エンドポイント

認可コードグラントタイプ（3-legged OAuth）の認可コードを取得するには、クエリパラメーターを指定して https://secure.indeed.com/oauth/v2/authorize エンドポイントを呼び出します。

Indeed は、対象アカウントを所有するエンドユーザーに OAuth 同意画面を表示します。

ユーザーがアプリのリクエストするスコープ（employer_access など）に対して Allow を選択すると、Indeed は認可コードを redirect_uri に送信し、code、iss、state のレスポンスフィールドを追加します。oauth/v2/authorize のレスポンスフィールドをご覧ください。

呼び出し例については、認可コードを取得するをご覧ください。

oauth/v2/authorize のクエリパラメーター

このエンドポイントとこれらのクエリパラメーターは、3-legged OAuth にのみ適用されます。

oauth/v2/authorize のクエリパラメーター

クエリパラメーター	説明
client_id	必須です。 クライアント ID です。 例: 6nwwcdklwgktryjw2j5f xh5t2fyneule7zg7mvw3pf9 jbx3wmewzlxkdz1jxvs6b
code_challenge	パブリッククライアントでは 必須、コンフィデンシャルクライアントでは 推奨 です。 RFC 7636: Proof Key for Code Exchange by OAuth Public Clients に従って、code verifier から導出した OAuth PKCE の code challenge です。 例: code_challenge=TmosKb_XlmuUDNPfdEPqTNpK5lfA6qWE3OBQHwG_qsc
code_challenge_method	code_challenge とともに PKCE を使用する場合に 必須 です。 S256 のみサポートされます。 例: code_challenge_method=S256
employer	任意です。 アクセストークンに関連付ける雇用主 ID です。 リフレッシュトークンをアクセストークンと交換する際にも、このパラメーターを渡せます。 例: employer=6d2f02224e30d401810b1726eb246d8d
prompt	必須です。 認可を行うユーザーに Indeed の雇用主選択画面を表示し、アクセストークンに割り当てる雇用主アカウントを選択してもらいます。認可リンクに prompt=select_employer を追加し、employer_access スコープを含めます。 例: prompt=select_employer Show the Indeed employer selection screen をご覧ください。
redirect_uri	必須です。 URL エンコードされたリダイレクト URL です。認可コードを受け取るサイト上のページを識別します。アプリに登録したリダイレクト URL のいずれかと一致している必要があります。 例: https://www.acerecruitersllc.com/oauth/indeed を次のようにエンコードします。 https%3A%2F%2Fwww.acerecruitersllc.com%2Foauth%2Findeed Indeed は redirect_uri パラメーターでクエリパラメーターをサポートしていますが、代わりに state パラメーターを使用することを推奨しています。 state パラメーターもご覧ください。
response_type	必須です。 常に code です。 例: code
scope	任意です。 アプリがリクエストする権限です。URL エンコードし、スコープをスペース区切りで指定します。エンコードにより、スペースはプラス記号（+）になります。 例: email+offline_access Scopes をご覧ください。
state	推奨です。 CSRF 攻撃を防止します。リクエストとコールバックの間で状態を維持するために、アプリが作成する一意の文字列を使用します。Indeed はこの値をリダイレクト URI に転送します。 例: employer1234 RFC 6819: OAuth 2.0 Threat Model and Security Considerations の Threat: CSRF Attack against redirect-uri をご覧ください。

oauth/v2/authorize のレスポンスフィールド

oauth/v2/authorize のレスポンスフィールド

レスポンスフィールド	型	説明
code	String	認可コードです。10 分間有効です。 例: rXZSMNyYQHQ
iss	String	認可サーバーの発行者 ID です。たとえば https://secure.indeed.com です。 Indeed はこの値を、成功レスポンスとエラーレスポンスの両方で常に返します（RFC 9207）。Indeed のみと連携する場合は、この値を無視できます。クライアントが複数の認可サーバーに接続する場合は、認可サーバー取り違え攻撃を防ぐために、この値が Indeed の想定する発行者と一致することを検証してください。 Indeed は /.well-known/openid-configuration の authorization_response_iss_parameter_supported を通じてサポートを宣言しています。 例: https%3A%2F%2Fsecure.indeed.com
state	String	任意です。Indeed は、このフィールドをリクエストで渡した場合にのみ返します。 例: employer1234

oauth/v2/tokens エンドポイント

クライアント ID とクライアントシークレットをアクセストークンと交換するには、Accept と Content-Type のリクエストヘッダー、およびリクエストボディパラメーターを指定して https://apis.indeed.com/oauth/v2/tokens に POST を送信します。

呼び出し例については、次をご覧ください。

• 2-legged アクセストークンを取得する
• 3-legged アクセストークンを取得する
• 3-legged アクセストークンを更新する

次のリクエストボディパラメーターを含めます。

oauth/v2/tokens のリクエストボディパラメーター

oauth/v2/tokens のリクエストボディパラメーター

リクエストボディパラメーター	説明
client_id	クライアント ID です。 例: client_id=6nwwcdklwgktryjw2j5fxh5t2fyneule7zg7mvw3pf9jbx3wmewzlxkdz1jxvs6b client_id をリクエストボディで送信する代わりに、Authorization ヘッダーで渡せます。 ✔ 3-legged OAuth ✔ 2-legged OAuth
client_secret	クライアントシークレットです。パブリッククライアントでは省略します。 例: client_secret=02KKpg6yLXw2v3FKf5lqyFGtMQCvPBNbJIw89SoSd9fts1LAdlvwUQQ6dwhAhEXv client_secret をリクエストボディで送信する代わりに、Authorization ヘッダーで渡せます。 ✔ 3-legged OAuth ✔ 2-legged OAuth
code	アクセストークンと交換する 認可コード です。 代わりにリフレッシュトークンを交換するには、refresh_token を使用します。 例: code=rXZSMNyYQHQ ✔ 3-legged OAuth
code_verifier	code_challenge の生成に使用した code verifier です。 例: code_verifier=XCojR8eDRqElINajGkYbqX8pQCp6AbPjwAM7Y-8z-UA ✔ 3-legged OAuth。PKCE を使用する場合は必須です。
employer	アクセストークンに関連付ける雇用主 ID です。 例: employer=6d2f02224e30d401810b1726eb246d8d ✔ 2-legged OAuth ✔ 3-legged OAuth
grant_type	次のいずれかのグラントタイプを使用します。 client_credentials client credentials グラントタイプ（2-legged OAuth）のアクセストークンを取得します。 authorization_code authorization code グラントタイプ（3-legged OAuth）のアクセストークンを取得します。 refresh_token authorization code グラントタイプ（3-legged OAuth）のアクセストークンを更新します。 urn:ietf:params:oauth:grant-type:token-exchange Token exchange グラントタイプ（OAuth）のアクセストークンを取得します。 例: grant_type=client_credentials urn:ietf:params:oauth:grant-type:token-exchange ✔ 3-legged OAuth ✔ 2-legged OAuth ✔ Token exchange OAuth
redirect_uri	URL エンコードされたリダイレクト URL です。認可コードを取得した際に使用したリダイレクト URL と一致している必要があります。 例: https://www.acerecruitersllc.com/oauth/indeed をエンコードし、次のように設定します。 redirect_uri=https%3A%2F%2Fwww.acerecruitersllc.com%2Foauth%2Findeed%3Fmy-param%3Dpass-me-this-value ✔ 3-legged OAuth
refresh_token	アクセストークンと交換するリフレッシュトークンです。Indeed はアクセストークンを取得した際にリフレッシュトークンを返します。 代わりに認可コードを交換するには、code を使用します。 例: refresh_token=rXZSMNyYQHQ ✔ 3-legged OAuth
scope	条件付きです。 アプリを登録したユーザーに関連付けられた雇用主アカウントを一覧表示する場合、またはそれらのアカウントの 1 つに対するアクセストークンを取得する場合は、scope=employer_access を設定します。 Token exchange grant type (OAuth) では、scope=openid を設定します。 Scopes をご覧ください。 例: scope=employer_access ✔ 3-legged OAuth ✔ 2-legged OAuth
sub	ID プロバイダー内のユーザー ID です。SCIM の externalId に対応している必要があります。 例: R1234 ✔ Token exchange OAuth
subject_token	リクエストが代理で行われる対象者の ID を表すトークンです。トークン発行者は、Indeed がこのトークンを検証する方法を提供する必要があります。 Indeed は ID トークンのみをサポートします。 例: xxxxx.yyyyy.zzzzz ✔ Token exchange OAuth
subject_token_type	subject_token で渡すトークンタイプです。常に urn:ietf:params:oauth:token-type:id_token です。 例: urn:ietf:params:oauth:token-type:id_token ✔ Token exchange OAuth

oauth/v2/tokens のレスポンスフィールド

oauth/v2/tokens のレスポンスフィールド

レスポンスフィールド	型	説明
access_token	String	アクセストークンです。 例: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6Ikpv[...]
consented_scope	String	ユーザーがアプリに付与したすべてのスコープをスペース区切りで示すリストです。Indeed は、ユーザーが offline_access スコープを付与した場合にのみこのフィールドを返します。 現在のアクセストークンの外にあるスコープが含まれる場合があります。scope フィールドには、このトークンに含まれるスコープが一覧表示されます。 例: email offline_access
convid	String	会話識別子です。 例: "convid": "1eis1tplg01fe802"
error	String	エラータイプです。 例: "error": "invalid_request"
error_description	String	エラーの説明です。 例: "error_description": "Invalid authentication request."
expires_in	Integer	トークンが有効な期間を秒単位で示します。トークンは 1 時間（3600 秒）有効です。 例: 3600
id_token	String	ID トークンです。 例: "eyJraWQiOiJlMzEzZTc4My1lM2YwLTQ3ZWMtY[...] ID Token をご覧ください。
issued_token_type	String	発行されたトークンのタイプです。 例: urn:ietf:params:oauth:token-type:access_token
refresh_token	String	Indeed は、offline_access スコープをリクエストした場合にのみリフレッシュトークンを返します。安全に保管してください。直近のリフレッシュリクエストから 60 日後に期限切れになります。パブリッククライアントでは、Indeed は使用のたびにリフレッシュトークンをローテーションします。 例: rXZSMNyYQHQ
scope	String	email や offline_access など、アプリに実際に付与された権限をスペース区切りで示します。 例: email offline_access
token_type	String	常に Bearer です。 例: Bearer

v2/api/appinfo エンドポイント

アプリを登録したユーザーアカウントに関連付けられた雇用主を一覧表示するには、Authorization ヘッダーで Bearer 認証スキームを使用してアクセストークンを渡し、https://secure.indeed.com/v2/api/appinfo を呼び出します。

呼び出し例については、採用企業選択画面を作成するをご覧ください。

v2/api/appinfo のパラメーター

このエンドポイントには、リクエストボディパラメーターもクエリパラメーターもありません。

v2/api/appinfo のレスポンスフィールド

v2/api/appinfo のレスポンスフィールド

レスポンスフィールド	型	説明
employers	Object	アプリを登録したユーザーアカウントに関連付けられた雇用主アカウントです。各雇用主には、雇用主 ID と名前が含まれます。 このオブジェクトを表示するには、ユーザーが employer_access スコープを付与する必要があります。
id	String	雇用主 ID です。
name	String	雇用主名です。

v2/api/userinfo エンドポイント

現在のユーザーのアカウント情報を取得するには、https://secure.indeed.com/v2/api/userinfo に GET を送信します。レスポンスは、ID トークン内の情報と一致します。

v2/api/userinfo のパラメーター

このエンドポイントには、リクエストボディパラメーターもクエリパラメーターもありません。

v2/api/userinfo のレスポンスフィールド

v2/api/userinfo のレスポンスフィールド

レスポンスフィールド	型	説明
email	String	ユーザーのメールアドレスです。 email スコープをリクエストし、ユーザーがこれを付与した場合に、Indeed は email フィールドと email_verified フィールドを返します。 例: mina.ray@myemail.world
email_verified	Boolean	ユーザーがメールアドレスを確認済みかどうかを示します。 email スコープをリクエストし、ユーザーがこれを付与した場合に、Indeed は email フィールドと email_verified フィールドを返します。 例: true
employers	Object	アプリを登録したユーザーアカウントに関連付けられた雇用主アカウントです。各雇用主には、雇用主 ID と名前が含まれます。 このオブジェクトを表示するには、ユーザーが employer_access スコープを付与する必要があります。
sub	String	ユーザーアカウントの一意の識別子です。 例: 8b5280bdc83ebf66

Error response

OAuth エラーのトラブルシューティングをご覧ください。

 

このページは役に立ちましたか？