Get user details by criteria

GET 
/scim/v2/Users

Gets information for a user, filtered by specified criteria.

You must filter the response by this SCIM 2.0 filter criteria:

• externalId eq "value" – Find user by external ID.
• emails.value eq "email@example.com" – Find user by email address.

Returns a maximum of one user. If multiple users match the filter, returns an error.

Request

Query Parameters

filter stringrequired

Possible values: [externalId eq "string", emails.value eq "email@example.com"]

SCIM 2.0 filter expression. Supported filters:

• externalId eq "external-id-value"
• emails.value eq "user@example.com"

Examples:

externalId

Description: Filter by external ID.

Example: externalId eq "ext-123"

email

Description: Filter by email address.

Example: emails.value eq "john.doe@example.com"

Responses

200

Users found successfully

application/scim+json

Schema

Schema

schemas string[]required
totalResults integerrequired

Total number of results.

startIndex integerrequired

1-based index of the first result.

itemsPerPage integerrequired

Number of results per page.

Resources

object[]

required

Array [

schemas string[]required

id string

Encrypted account ID (external format).

externalId string

External identifier for the user.

userName string

Unique username for the user.

name

object

SCIM Name complex type

formatted string

Full name.

familyName string

Family name. Also known as last name.

givenName string

Given name. Also known as first name.

middleName string

Middle name.

honorificPrefix string

Honorific prefix, such as Mr. or Dr.

honorificSuffix string

Honorific suffix, such as Jr. or Sr.

displayName string

Display name for the user.

emails

object[]

Array [

value emailrequired

Email address.

type string

Possible values: [work, home, other]

Email type.

primary boolean

Indicates whether this email is the primary email.

]

active boolean

Indicates whether the user account is active.

meta

object

SCIM Meta complex type

resourceType string

Resource type.

created date-time

Creation timestamp.

lastModified date-time

Last modification timestamp.

location uri

Resource location URL.

version string

Resource version/ETag.

urn:ietf:params:scim:schemas:extension:indeed:2.0:EmployerOrg

object

Indeed-specific employer organization extension

id string

Employer organization ID.

roles string[]

Possible values: [admin]

User roles within the employer organization:

• admin: Organization administrator
• Empty array or null: Basic member

]

Example (from schema)

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 100,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:indeed:2.0:EmployerOrg"
      ],
      "id": "encrypted-account-key-123",
      "externalId": "ext-user-123",
      "userName": "john.doe@example.com",
      "name": {
        "formatted": "Mr. John Q. Doe",
        "familyName": "Doe",
        "givenName": "John",
        "middleName": "Q",
        "honorificPrefix": "Mr.",
        "honorificSuffix": "Jr."
      },
      "displayName": "John Doe",
      "emails": [
        {
          "value": "john.doe@example.com",
          "type": "work",
          "primary": true
        }
      ],
      "active": true,
      "meta": {
        "resourceType": "User",
        "created": "2023-01-01T00:00:00Z",
        "lastModified": "2023-01-01T00:00:00Z",
        "location": "https://api.indeed.com/scim/v2/Users/encrypted-account-key-123",
        "version": "\"W/1\""
      },
      "urn:ietf:params:scim:schemas:extension:indeed:2.0:EmployerOrg": {
        "id": "org-123",
        "roles": [
          "admin"
        ]
      }
    }
  ]
}

emptyResult

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 0,
  "startIndex": 1,
  "itemsPerPage": 100,
  "Resources": []
}

400

Bad Request - Invalid request format or parameters

application/scim+json

Schema

Schema

schemas string[]required
status stringrequired

HTTP status code as string.

scimType string

Possible values: [invalidFilter, tooMany, uniqueness, mutability, invalidSyntax, invalidPath, noTarget, invalidValue, invalidVers, sensitive]

SCIM error type.

detail string

Human-readable error description.

Example (from schema)

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "status": "400",
  "scimType": "invalidFilter",
  "detail": "Invalid filter: No filter provided"
}

invalidFilter

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "status": "400",
  "scimType": "invalidFilter",
  "detail": "Invalid filter: No filter provided"
}

invalidUser

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "status": "400",
  "scimType": "invalidValue",
  "detail": "Invalid SCIM user data"
}

401

Unauthorized - Invalid or missing authentication

application/scim+json

Schema

Schema

schemas string[]required
status stringrequired

HTTP status code as string.

scimType string

Possible values: [invalidFilter, tooMany, uniqueness, mutability, invalidSyntax, invalidPath, noTarget, invalidValue, invalidVers, sensitive]

SCIM error type.

detail string

Human-readable error description.

Example (from schema)

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "status": "400",
  "scimType": "invalidFilter",
  "detail": "Invalid filter: No filter provided"
}

Example

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "status": "401",
  "detail": "Authentication required"
}

403

Forbidden - Insufficient permissions

application/scim+json

Schema

Schema

schemas string[]required
status stringrequired

HTTP status code as string.

scimType string

Possible values: [invalidFilter, tooMany, uniqueness, mutability, invalidSyntax, invalidPath, noTarget, invalidValue, invalidVers, sensitive]

SCIM error type.

detail string

Human-readable error description.

Example (from schema)

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "status": "400",
  "scimType": "invalidFilter",
  "detail": "Invalid filter: No filter provided"
}

Example

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "status": "403",
  "detail": "Insufficient permissions"
}

500

Internal Server Error

application/scim+json

Schema

Schema

schemas string[]required
status stringrequired

HTTP status code as string.

scimType string

Possible values: [invalidFilter, tooMany, uniqueness, mutability, invalidSyntax, invalidPath, noTarget, invalidValue, invalidVers, sensitive]

SCIM error type.

detail string

Human-readable error description.

Example (from schema)

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "status": "400",
  "scimType": "invalidFilter",
  "detail": "Invalid filter: No filter provided"
}

Example

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "status": "500",
  "detail": "An unexpected error occurred"
}

Loading...

 

Was this page helpful?