SCIM API ガイド

サードパーティシステムは、System for Cross-domain Identity Management (SCIM) API を呼び出して、ユーザーディレクトリを同期できます。

 

法的注意

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

SCIM API の概要

System for Cross-domain Identity Management (SCIM) API は、SCIM プロトコルを使用して、サードパーティシステムがユーザーに代わって Indeed を呼び出し、Indeed PLUS 連携のためにユーザーディレクトリを同期できるようにします。通常、これらのユーザーは Indeed.com ユーザーから分離されたリソースグループに属します。リソースグループにより、サードパーティシステムは、ユーザーが Indeed アカウントを作成しなくても、これらのユーザーの作成、削除、権限の割り当てを含む直接的な管理権限を持てます。

エンドユーザーが Indeed アカウントを持つことはありません。Indeed に直接サインインすることはできず、サードパーティシステムを通じてのみサインインし、そのシステムのコンテキスト内の API にのみアクセスします。

次の表は、SCIM API のサードパーティ呼び出し元と、その使用方法を示しています。

SCIM API のユースケース

サードパーティ呼び出し元	SCIM API を呼び出して行うこと
採用管理システム (ATS)	採用企業のユーザーを Indeed のリソースグループにプロビジョニングし、Scout などのツールにアクセスできるようにします。
Recruit 運営の求人ボード	ユーザーを Indeed にリンクし、Indeed のモデレーション機能にアクセスできるようにします。
Glassdoor などのパートナー	ユーザーのリンクを管理して、Glassdoor と Indeed の間で一貫した体験を提供します。

サポート対象スキーマと任意スキーマについては、SCIM API スキーマをご覧ください。

この連携を開始する場合や質問がある場合は、fim-team@indeed.com までお問い合わせください。

SCIM API OAuth

When you become an Indeed partner, Indeed sets up an app for your integration. Sign in to Partner Console to view your app and OAuth credentials (client ID, secret, and authorization code for 3-legged OAuth). Exchange credentials for an access token to authenticate API calls.

次の手順を完了します。

SCIM API OAuth

#	手順
1.	Indeed パートナーになる。
2.	OAuth 認証情報を取得する。
3.	アクセストークンを取得する。

Indeed パートナーになる

まだパートナーでない場合は、Indeed パートナーになるをご覧ください。

OAuth 認証情報を取得する

1. Indeed ユーザーアカウントで Partner Console にサインインします。

2. Dashboard の Apps リストでアプリを選択します。

   アプリ詳細ページの Credentials タブに、OAuth 認証情報である client ID と secret が表示されます。

アクセストークンを取得する

アクセストークンを取得するには、curl などのコマンドラインツールや Insomnia などの UI ツールを使用して、次のヘッダーとボディパラメーターで https://apis.indeed.com/oauth/v2/tokens に POST リクエストを送信します。

クライアントシークレットをエンドユーザーに公開しないでください。Indeed は、バックエンドでトークンを生成することを推奨します。

curl -L 'https://apis.indeed.com/oauth/v2/tokens' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'client_id=<client_id>' \
  -d 'client_secret=<client_secret>' \
  -d 'grant_type=client_credentials' \
  -d 'scope=employer_access'

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

アクセストークン取得リクエストのヘッダー

ヘッダー	値
Accept	application/json
Content-Type	application/x-www-form-urlencoded

リクエストボディのパラメーターは次のとおりです。

アクセストークン取得リクエストのボディパラメーター

リクエストボディのパラメーター	値	説明
client_id	<client_id>	クライアント ID に置き換えます。
client_secret	<client_secret>	クライアントシークレットに置き換えます。
grant_type	client_credentials	クライアントクレデンシャル付与（2-legged OAuth）をリクエストします。
scope	employer_access	アプリを登録したユーザーに関連付けられた雇用主アカウントの一覧を取得するか、関連付けられた雇用主アカウントのアクセストークンを取得します。

{
  "access_token": "<access_token>",
  "scope": "employer_access",
  "token_type": "Bearer",
  "expires_in": 3600
}

トークンは 1 時間（3600 秒）で有効期限が切れます。トークンは 1 時間ごとに更新します。

SCIM サービスは、トークンの署名、issuer、audience、有効期限を確認し、アクセストークンを検証して、有効期限が切れていないことを確認します。

トークンが有効な場合、SCIM サービスはリクエストを処理し、適切なレスポンスを返します。トークンが無効または期限切れの場合、サービスは HTTP 401 Unauthorized ステータスコードを返します。

SCIM API の操作

OAuth を完了すると、次の操作を呼び出せます。

SCIM API の操作

操作	説明
条件でユーザーの詳細を取得する	リクエスト元のテナントに関連付けられた Indeed アカウントの詳細を取得します。
ID でユーザーの詳細を取得する	一意の ID で Indeed ユーザーアカウントの詳細を取得します。ユーザーのプロフィール情報、ロール、グループ所属にアクセスまたは確認するには、この操作を使用します。
ユーザーを作成する	Indeed ユーザーアカウントを作成します。
ID でユーザーを更新する	Indeed アカウントを更新し、変更可能なすべての値を上書きします。
ID でユーザーを削除する	Indeed ユーザーアカウントをハードデリートし、ユーザーのアイデンティティデータを Indeed から消去します。

条件でユーザーの詳細を取得する

GET https://api.indeed.com/scim/v2/Users

リクエスト元のテナントに関連付けられた Indeed アカウントの詳細を取得します。

この操作を使用して、Identity Provider (IdP) と Service Provider (SP) の間でユーザーデータを同期します。

たとえば、完全同期の際には、IdP が SP にクエリを実行し、すべての操作が完了した後に SP が IdP と一致するように、追加、削除、更新するユーザーを特定します。

この操作は最大 1 人のユーザーを返します。条件に複数のユーザーが一致する場合、この操作はエラーを返します。

リファレンス情報とリクエスト例、レスポンス例については、条件でユーザーの詳細を取得するをご覧ください。

ID でユーザーの詳細を取得する

GET https://api.indeed.com/scim/v2/Users/:id

一意のユーザー ID で Indeed ユーザーアカウントの詳細を取得します。

この操作を使用して、プロフィール情報、ロール、グループ所属などのユーザー詳細にアクセスまたは確認します。

たとえば、IdP でユーザーが変更された場合、IdP は SP にクエリを実行して現在の SP ユーザーの状態を取得し、その後 POST または PUT コマンドを送信して SP を IdP と一致させます。

リファレンス情報とリクエスト例、レスポンス例については、ID でユーザーの詳細を取得するをご覧ください。

ユーザーを作成する

POST https://api.indeed.com/scim/v2/Users

Indeed アカウントを作成します。従業員が組織に加わるとき、IdP はこの操作を呼び出してユーザー情報を SP に追加します。これにより、ユーザーは初日から必要なリソースとサービスにアクセスできます。

必須フィールドと任意フィールドは次のとおりです。

ユーザー作成操作のフィールド

フィールド	必須	任意
1 つのプライマリ email	✓
externalId	✓
familyName	✓
givenName	✓
locale		✓
phoneNumbers		✓
preferredLanguage		✓
timezone		✓
title		✓
username	✓
userType	✓
EmployerOrganizations		✓

リファレンス情報とリクエスト例、レスポンス例については、ユーザーを作成するをご覧ください。

ID でユーザーを更新する

PUT /Users/{id}

Indeed アカウントを更新します。この操作は、属性が空または省略されている場合でも、アカウント上のすべての値を上書きします。

必須フィールドと任意フィールドは次のとおりです。

ID でユーザーを更新する操作のフィールド

フィールド	必須	任意
1 つのプライマリ email	✓
externalId	✓
familyName	✓
givenName	✓
locale		✓
phoneNumbers		✓
preferredLanguage		✓
timezone		✓
title		✓
username	✓
userType	✓
EmployerOrganizations		✓

リファレンス情報とリクエスト例、レスポンス例については、ID でユーザーを更新するをご覧ください。

ID でユーザーを削除する

DELETE https://api.indeed.com/scim/v2/Users/:id

Indeed ユーザーアカウントをハードデリートし、Indeed からユーザーのアイデンティティデータを消去します。

従業員が組織を離れるとき、IdP はこの操作を呼び出してシステムからユーザーを削除します。この操作は、Indeed 内のユーザーのアイデンティティデータを消去し、再有効化を防ぐことで、ユーザーが組織のリソースやサービスにアクセスできないようにします。

この操作は、すべての Indeed プラットフォームにわたって、そのユーザーのすべての Personally Identifiable Information (PII) をサニタイズするわけではありません。DELETE 操作の前後を問わず、GDPR 関連のデータサニタイズ要求は適切な窓口を通じて処理してください。どちらの要求も、順序に関係なく正しく処理されます。

リファレンス情報とリクエスト例、レスポンス例については、ID でユーザーを削除するをご覧ください。

RFCs

• RFC 3966: The tel URI for Telephone Numbers
• RFC 7642: System for Cross-domain Identity Management: Definitions, Overview, Concepts, and Requirements
• RFC 7643: System for Cross-domain Identity Management: Core Schema
• RFC 7644: System for Cross-domain Identity Management: Protocol

関連項目

• HTTP リクエストヘッダー
• oauth/v2/tokens エンドポイント
• エラーレスポンス
• OAuth エラーのトラブルシューティング

 

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