トークンエクスチェンジグラントタイプ（OAuth）
セキュリティトークンを Indeed のアクセストークンと交換します。
本 API および本ドキュメントを利用し、連携を構築することにより、Additional API Terms and Guidelines に同意したものとみなされます。
概要
#トークンエクスチェンジグラントタイプを使用すると、ID プロバイダーが発行した ID トークンを Indeed のアクセストークンと交換できます。このグラントタイプは RFC 8693: OAuth 2.0 Token Exchange に準拠しています。
手順
#この連携を開始する場合やご質問がある場合は、indeed-ciam-integrations-support@indeed.com までお問い合わせください。
1. アプリを登録する
#日本のみ
#-
Indeed アカウントで Manage app credentials （新しいウィンドウで開きます） ページにサインインし、Register new application を選択します。
-
Provide basic information ページで、アプリの名前と説明を入力します。Credential type で OAuth 2.0 を選択し、Save and continue を選択します。
-
Select OAuth grant types ページで Client credentials を選択し、Save and continue を選択します。
-
Provide additional information ページで必要に応じて詳細を追加し、Save and continue を選択します。
-
Preview app ページでアプリの情報を確認し、Complete registration を選択します。
Credentials ページに表示されるクライアント ID とシークレットを控えておきます。シークレットは共有しないでください。
-
Indeed がアプリをトークンエクスチェンジの許可リストに追加できるよう、クライアント ID を Indeed に送信します。
日本以外
#Indeed エントリーの XML 連携を構築するには、Indeed クライアントサクセスチーム （新しいウィンドウで開きます）にお問い合わせください。開発者契約に署名すると、Indeed が連携用のアプリを設定します。
アプリとその Indeed エントリー API トークンの認証情報を確認するには、Partner Console （新しいウィンドウで開きます） にサインインします。
- API トークンの認証情報は、クライアント ID とシークレットです。
- Indeed に掲載する各求人に API トークンを含めます。
2. Authorization Basic ヘッダーの値を生成する
#RFC 2617: HTTP Authentication: Basic and Digest Access Authentication の Basic Authentication Scheme （新しいウィンドウで開きます） もご覧ください。
Authorization Basic ヘッダーの値を生成するには、次の手順で行います。
-
client_idとclient_secretを、区切り文字としてコロン（:）で連結します。base64.encode("<client_id>:<client_secret>"); -
その文字列に Base64 エンコードアルゴ リズムを適用します。
base64.encode("5e175cbb7f88e2048bd95323bbc9ca2fcec32ad60f95f7ee66ab53e099abe6f3:pJ4qRe2sdXRP0Whr3bwz9D37exFuuOtqJDRHMmmlLWV7J25rH7oItrPNCKzhaQf2"); -
Base64 エンコードされた文字列を、基本 HTTP
Authorizationヘッダーとして渡します。Authorization: Basic NWUxNzVjYmI3Zjg4ZTIwNDhiZDk1MzIzYmJjOWNhMmZjZWMzMmFkNjBmOTVmN2VlNjZhYjUzZTA5OWFiZTZmMzpwSjRxUmUyc2RYUlAwV2hyM2J3ejlEMzdleEZ1dU90cUpEUkhNbW1sTFdWN0oyNXJIN29JdHJQTkNLemhhUWYy
3. アクセストークンを取得する
#手順 2 で生成した Authorization: Basic ヘッダーと ID トークンを指定して、https://apis.indeed.com/oauth/v2/tokens に POST リクエストを送信します。
curl -L 'https://apis.indeed.com/oauth/v2/tokens' \ -H 'Content-Type: application/x-www-form-urlencoded' \ -H 'Authorization: Basic <credentials>' \ -d 'grant_type=urn:ietf:params:oauth:grant-type:token-exchange' \ -d 'subject_token_type=urn:ietf:params:oauth:token-type:id_token' \ -d 'scope=email offline_access' \ -d 'subject_token=xxxxx.yyyyy.zzzzz'リクエストヘッダーは次のとおりです。
| ヘッダー | 値 |
|---|---|
Authorization |
|
Content-Type | application/x-www-form-urlencoded |
oauth/v2/tokens のリクエストボディパラメーターは次のとおりです。
| リクエストボディパラメーター | 必須 | 値 |
|---|---|---|
grant_type | ✔ |
型: string |
scope | 任意 | Indeed のアクセストークンで付与するスコープです。スコープをご覧ください。 例:
|
subject_token | ✔ | 代理で操作するユーザーを識別するトークンです。トークンの発行者は、Indeed がトークンを検証できる手段を提供する必要があります。 Indeed は ID トークンのみをサポートしています。 例:
|
subject_token_type | ✔ |
例:
|
成功した場合のレスポンスは次のとおりです。
HTTP/1.1 200 OKContent-Type: application/json
{ "access_token": "<access_token>", "scope": "email offline_access", "issued_token_type": "urn:ietf:params:oauth:token-type:access_token", "token_type": "Bearer", "expires_in": 3600}失敗した場合のレスポンスは次のとおりです。
HTTP/1.1 400 Bad RequestContent-Type: application/json
{ "error": "invalid_request"}レスポンスフィールドは次のとおりです。
ID トークン
#ID トークンは JSON Web Token（JWT） （新しいウィンドウで開きます） です。
次の表は、必須のクレームと任意のクレームを区別しています。OpenID Connect の要件については、OpenID Connect Core 1.0 ID Token （新しいウィンドウで開きます） をご覧ください。
Indeed は、OpenID で必須とされるクレームに加えて、JWT 本文に次のフィールドがあれば読み取ります。
| フィールド | 必須 | 説明 |
|---|---|---|
型: | ID トークンの受信者です。トークンを受け取った外部アプリのクライアント ID を指定します。 例: | |
型: | ユーザーがサインインしたときの IPv4 アドレスです。RFC 1918 をご覧ください。 例: | |
型: JSON 数値 | ユーザーが最後に認証された日時です。 例: | |
型: JSON 数値 | 有効期限です。この時刻を過ぎると、Indeed はトークンを拒否します。発行されるアクセストークンも同じ時刻に失効します。 例: | |
型: JSON 数値 | ✔ すべての連携 | JWT が発行された日時です。 例: |
型: | JWT を発行したシステムの URI です。 例: | |
型: | ✔ すべての連携 | ID プロバイダーにおけるユーザーの ID です。SCIM の 例: |
型: | ユーザーのロケールに合わせて表示用に整形されたフルネームです。 例: | |
型: | ✔ すべての連携 | ユーザーの優先メールアドレスです。RFC 5322 の addr-spec 形式 （新しいウィンドウで開きます）で指定します。 例: |
型: | ユーザーのメールアドレスを検証済みかどうかを表します。省略した場合、Indeed はメールアドレスが未検証であると見なします。 例: | |
型: | ✔ 一部の連携 | ユーザーの姓です。複数の姓はスペースで区切ります。 例: |
型: | ユーザーの名です。複数の名はスペースで区切ります。 例: | |
型: | ユーザーのロケールを表す BCP 47（RFC 5646）言語タグです。通常は、小文字の ISO 639 （新しいウィンドウで開きます） 言語コードと大文字の ISO 3166-1 （新しいウィンドウで開きます） 国コードをハイフンでつなげた形式です。 例: | |
型: | ユーザーの電話番号です。E.164 （新しいウィンドウで開きます） 形式で指定します。 例: | |
型: | 電話番号が検証済みかどうかを表します。 例: | |
型: JSON 数値 | ユーザー情報が最後に更新された日時です。 例: |
関連項目
#RFCs
#ガイド
#- OAuthエラーのトラブルシューティング — Indeed API にアクセスする前に発生する OAuth エラーの修正方法を説明します。
リファレンス
#- HTTP リクエストヘッダー — OAuth リクエストの HTTP リクエストヘッダーの一覧です。
- oauth/v2/tokens エンドポイント — トークンを Indeed のアクセストークンと交換する方法を説明します。