SCIM API schemas

Get information about System for Cross-domain Identity Management (SCIM) API schemas.

 

User schema

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

User schema

Field	Required	Description
id Type: string	RETURNED	The service provider always issues this attribute. The client (IdP) must not issue it. Indeed defines this unique ID for a SCIM resource. It must be unique across all resources in the SCIM service provider, remain stable, and never be reassigned. It does not change when the same resource is returned in later requests. This value is the Indeed account key and the same ID used to make API calls to Indeed. Attribute characteristics: caseExact: true mutability: readOnly returned: always For privacy considerations, see RFC 7643, Section 9: Security Considerations. After Indeed assigns this value, the IdP must store it as the primary reference for the user account. Example: "f605d7366131bc7fffd36c1772be4617"
userName Type: string	✔	The account's unique user name within the tenant. This value is often the user's main sign-in ID, such as an email address. Must be unique across the tenant. Must not be empty. Case-insensitive. Example: "user@domain.com", "555-555-5555", "user1"
externalId Type: string	✔ by Indeed. SCIM does not require this value.	The primary key. Must be unique across all users in the tenant. Example: "701984"
name.familyName Type: string	✔ by Indeed. SCIM does not require this value.	The user's family name. For example, "Jensen" in "Ms. Barbara Jane Jensen, III". Example: "Jensen"
name.givenName Type: string	✔ by Indeed. SCIM does not require this value.	The user's given name. For example, "Barbara" in "Ms. Barbara Jane Jensen, III". Example: "Barbara"
emails Type: List of Emails	✔ Indeed requires one primary email. SCIM does not require this value.	Email addresses for the user. Example: "emails": [{ "value": "user@example.com", "type": "work", "primary": true }, { "value": "personal@example.com", "type": "personal" }]
email.value Type: string	✔	The email address. Example: "user@example.com"
email.type Type: string	Optional	Classification of the email address. Example: "work", "personal"
email.primary Type: boolean	Optional	Whether this is the primary email address. The value true can appear no more than once. Example: true, false
phoneNumbers Type: List of PhoneNumbers	Optional	Phone numbers for the user. Example: "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 Type: string	✔	The user's phone numbers. Values must follow the format defined in RFC 3966: The tel URI for Telephone Numbers. Example: "tel:+1-555-555-5555"
phoneNumber.display Type: string	RETURNED	The service provider returns an immutable, canonical, human-readable phone number. Example: "(555)555-5555"
phoneNumber.type Type: string	Optional	The phone number type. These examples show accepted values: Examples: "work" "home" "mobile" "fax" "pager" "other"
phoneNumber.primary Type: boolean	Optional	Whether this is the primary phone number. The value true can appear no more than once. Example: true false
userType Type: string	✔ by Indeed. SCIM does not technically require it	Whether the account belongs to a job seeker or employer user. Example: "Jobseeker" "EmployerUser"
title Type: string	Optional	The user's job title. Recommended for employer users. Example: "Recruiter"
preferredLanguage Type: string	Optional	The user's preferred written or spoken languages. Values use the same format as the HTTP Accept-Language header, as defined in RFC 7231, Section 5.3.5. Example: "en_US"
locale Type: string	Optional	The user's default location for localizing currency, date and time formats, and numeric formats. Values must use language tags defined in RFC 5646: Tags for Identifying Languages. Computer languages are excluded. Examples include fr, en-US, es-419, az-Arab, x-pig-latin, and man-Nkoo-GN. Example: "en_US"
timezone Type: string	Optional	The user's time zone in IANA Time Zone Database format. See RFC 6557: Procedures for Maintaining the Time Zone Database. For example, "America/Los_Angeles". Example: "America/Los_Angeles"
active Type: boolean	RETURNED	Shows whether the user's account is active. false means the account is suspended. This field is read-only. Example: true false
meta.resourceType Type: string	RETURNED	The service provider manages this resource type. It defines the resource name, endpoint URL, schemas, and other metadata. Currently, only "User" is supported. Example: "User"
meta.created Type: DateTime	RETURNED	Shows the date and time when the service provider added the resource. This value is immutable. Example: "2010-01-23T04:56:22Z"
meta.lastModified Type: DateTime	RETURNED	Shows the most recent date and time when the resource was updated. If the resource was never modified, this value matches "created". Example: "2011-05-13T04:42:34Z"
meta.version Type: string	RETURNED	Represents the current state of the user resource with a unique ID. This value changes after each update, so you can track versions and detect changes. This value is a weak version, W, so duplicates or inconsistencies can occur. Example: W"1744213122411"

User’s employer organization schema

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

This schema associates a user with an employer organization for one or more roles.

The schema is optional.

• If you exclude the schema, the user remains in EmployerOrganizations.
• If you include the schema without fields, you remove the user from EmployerOrganizations and roles.

User’s employer organization schema

Field	Example	Description
id Type: string	"aXJpOi8v...gyZTkzNQ=="	The employer organization ID. If you omit this field when you specify the EmployerOrganization schema, you remove the user from any employer organization.
roles Type: Array of strings	["admin"]	The user's roles in the employer organization. Accepted values are "admin" or an empty array.

See also

• HTTP request headers
• oauth/v2/tokens endpoint
• Error response
• Troubleshoot OAuth errors

 

Was this page helpful?