SCIM API スキーマ

System for Cross-domain Identity Management（SCIM）API のスキーマに関する情報を示します。

 

ユーザースキーマ

urn:ietf:params:scim:schemas:core:2.0:User

ユーザースキーマ

フィールド	必須	説明
id 型: string	RETURNED	サービスプロバイダーは常にこの属性を発行します。クライアント（IdP）はこの属性を発行してはいけません。 Indeed が SCIM リソースに対して定義する一意の ID です。この ID は SCIM サービスプロバイダー内のすべてのリソースで一意であり、安定しており、再割り当てされることがありません。同じリソースが後続のリクエストで返されても変更されません。 この値は Indeed アカウントキーであり、Indeed への API 呼び出しで使用する ID と同じです。 属性の特性: caseExact: true mutability: readOnly returned: always プライバシーに関する考慮事項については、RFC 7643, Section 9: Security Considerationsをご覧ください。 Indeed がこの値を割り当てた後、IdP はこの値をユーザーアカウントの主要な参照として保存する必要があります。 例: "f605d7366131bc7fffd36c1772be4617"
userName 型: string	✔	テナント内でアカウントを一意に識別するユーザー名です。多くの場合、メールアドレスなど、ユーザーの主なサインイン ID です。 テナント内で一意である必要があります。 空にできません。 大文字と小文字を区別しません。 例: "user@domain.com", "555-555-5555", "user1"
externalId 型: string	✔ by Indeed. SCIM does not require this value.	主キーです。テナント内のすべてのユーザーで一意である必要があります。 例: "701984"
name.familyName 型: string	✔ by Indeed. SCIM does not require this value.	ユーザーの姓です。たとえば、"Ms. Barbara Jane Jensen, III" の "Jensen" です。 例: "Jensen"
name.givenName 型: string	✔ by Indeed. SCIM does not require this value.	ユーザーの名です。たとえば、"Ms. Barbara Jane Jensen, III" の "Barbara" です。 例: "Barbara"
emails 型: Email のリスト	✔ Indeed requires one primary email. SCIM does not require this value.	ユーザーのメールアドレスです。 例: "emails": [{ "value": "user@example.com", "type": "work", "primary": true }, { "value": "personal@example.com", "type": "personal" }]
email.value 型: string	✔	メールアドレスです。 例: "user@example.com"
email.type 型: string	Optional	メールアドレスの分類です。 例: "work", "personal"
email.primary 型: boolean	Optional	これが主なメールアドレスかどうかを示します。値 true は 1 回までしか指定できません。 例: true, false
phoneNumbers 型: PhoneNumber のリスト	Optional	ユーザーの電話番号です。 例: "phoneNumbers": [{ "value": "tel:+1-555-555-5555", "display": "(555)555-5555", "type": "work" }, { "value": "tel:+81-080-1234-5678", "display": "+81 080-1234-5678", "type": "mobile", "primary": true }]
phoneNumber.value 型: string	✔	ユーザーの電話番号です。値は RFC 3966: The tel URI for Telephone Numbers で定義されている形式に従う必要があります。 例: "tel:+1-555-555-5555"
phoneNumber.display 型: string	RETURNED	サービスプロバイダーは、変更できない正規化済みの人が読める電話番号を返します。 例: "(555)555-5555"
phoneNumber.type 型: string	Optional	電話番号のタイプです。次の例は受け付ける値を示します。 例: "work" "home" "mobile" "fax" "pager" "other"
phoneNumber.primary 型: boolean	Optional	これが主な電話番号かどうかを示します。値 true は 1 回までしか指定できません。 例: true false
userType 型: string	✔ by Indeed. SCIM does not technically require it	アカウントが求職者ユーザーと採用企業ユーザーのどちらに属するかを示します。 例: "Jobseeker" "EmployerUser"
title 型: string	Optional	ユーザーの役職です。採用企業ユーザーに推奨します。 例: "Recruiter"
preferredLanguage 型: string	Optional	ユーザーが希望する書き言葉または話し言葉です。値は RFC 7231, Section 5.3.5 で定義されている HTTP Accept-Language ヘッダーと同じ形式を使用します。 例: "en_US"
locale 型: string	Optional	通貨、日付形式、時刻形式、数値形式をローカライズするためのユーザーの既定のロケーションです。値には RFC 5646: Tags for Identifying Languages で定義されている言語タグを使用する必要があります。コンピューター言語は含みません。例として、fr、en-US、es-419、az-Arab、x-pig-latin、man-Nkoo-GN があります。 例: "en_US"
timezone 型: string	Optional	IANA Time Zone Database 形式のユーザーのタイムゾーンです。RFC 6557: Procedures for Maintaining the Time Zone Database をご覧ください。たとえば、"America/Los_Angeles" です。 例: "America/Los_Angeles"
active 型: boolean	RETURNED	ユーザーアカウントが有効かどうかを示します。false はアカウントが停止されていることを意味します。このフィールドは読み取り専用です。 例: true false
meta.resourceType 型: string	RETURNED	サービスプロバイダーが管理するリソースタイプです。リソース名、エンドポイント URL、スキーマ、そのほかのメタデータを定義します。サポートされる値は "User" のみです。 例: "User"
meta.created 型: DateTime	RETURNED	サービスプロバイダーがリソースを追加した日時を示します。この値は変更されません。 例: "2010-01-23T04:56:22Z"
meta.lastModified 型: DateTime	RETURNED	リソースが最後に更新された最新の日時を示します。リソースが一度も変更されていない場合、この値は "created" と一致します。 例: "2011-05-13T04:42:34Z"
meta.version 型: string	RETURNED	ユーザーリソースの現在の状態を一意の ID で表します。この値は更新のたびに変わるため、バージョンを追跡し、変更を検出できます。 この値は弱いバージョン W であるため、重複や不整合が発生することがあります。 例: W"1744213122411"

ユーザーの採用企業組織スキーマ

urn:ietf:params:scim:schemas:extension:Indeed:1.0:User.EmployerOrganization

このスキーマは、1 つ以上のロールに対してユーザーを採用企業組織に関連付けます。

このスキーマは任意です。

• このスキーマを含めない場合、ユーザーは EmployerOrganizations に残ります。
• フィールドを含めずにこのスキーマを含めると、ユーザーは EmployerOrganizations と roles から削除されます。

ユーザーの採用企業組織スキーマ

フィールド	例	説明
id 型: string	"aXJpOi8v...gyZTkzNQ=="	採用企業組織 ID です。EmployerOrganization スキーマを指定するときにこのフィールドを省略すると、ユーザーはどの採用企業組織からも削除されます。
roles 型: string の配列	["admin"]	採用企業組織におけるユーザーのロールです。使用できる値は "admin" または空の配列です。

関連項目

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

 

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