get https://api.seismic.com/scim/v2/Users
Use this endpoint to retrieve all the users from a tenant or supply a filter to retrieve a subset of users matching the filter criteria.
The results are paginated with 10 records per page.
SCOPES
Requires one:
seismic.user.view,seismic.user.manageSee Permissions for additional details.
User Filtering
Supported filters
| Property Name | Description | Example |
|---|---|---|
| userName | Unique identifier for the User, typically used by the user to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the service provider's entire set of Users. | ./Users?filter=username+eq+"test" ./Users?filter=username+co+"test" |
| name.givenName | The given name of the user, or first name in most Western languages (e.g., "David" given the full name "Mr. David A. Smith, III"). | ./Users?filter=name.givenName+eq+"Tom" ./Users?filter=name.givenName+co+"Tom" |
| name.familyName | The family name of the User, or last name in most Western languages (e.g., "Smith" given the full name "Mr. David A. Smith, III"). | ./Users?filter=name.familyName+eq+"Smith" ./Users?filter=name.familyName+co+"Smith" |
| title | The user's title, such as "Vice President." | ./Users?filter=title+eq+"President" ./Users?filter=title+co+"President" |
| userType | The license specified for the user. Valid values are: "Business", "Premium", or "Partner". | ./Users?filter=userType+eq+"Premium" ./Users?filter=userType+eq+"Business" ./Users?filter=userType+eq+"Partner" |
| preferredLanguage | Indicates the user's preferred interface language. For example, "en_US". | ./Users?filter=preferredLanguage+eq+"en_US"、 ./Users?filter=preferredLanguage+co+"en_US" |
| active | Indicates that the user is locked, which would prevent them from logging into the tenant. | ./Users?filter=active+eq+true ./Users?filter=active+eq+false |
| emails | Email addresses for the user. The valued should be converted to a common standard format by the service provider, e.g., "[email protected]" instead of "[email protected]". The type values are "work", "home", and "other". | ./Users?filter=emails.value+eq+"[email protected]" ./Users?filter=emails.value+co+"bjensen" |
| phoneNumbers | Phone numbers for the user. The service provider should convert numbers to the format specified in RFC 3966, e.g., "tel:+1-201-555-0123". The type values are "work", "home", "mobile", "fax", "pager", and "other". | ./Users?filter=phoneNumbers.value+eq+"+1-201-555-0123" ./Users?filter=phoneNumbers.value+co+"+1-201" |
| addresses | Mailing address for the user. Type values are "work", "home", and "other". This attribute is a complex type with the following sub-attributes. | ./Users?filter=addresses.formatted+eq+"xxx" ./Users?filter=addresses.formatted+co+"xxx" |
| timezone | Indicates the user's time zone, for example, "America/Los_Angeles". | ./Users?filter=timezone+eq+"xxxx" ./Users?filter=timezone+co+"xxxx" |
| meta.created | The date and time the user was created. | ./Users?filter=meta.created+le+"2021-09-01T16:07:58Z" ./Users?filter=meta.created+gt+"2021-09-01T16:07:58Z" |
| meta.lastModified | The date and time the user was most recently modified | ./Users?filter=meta.lastModified+le+"2021-09-01T16:07:58Z" ./Users?filter=meta.lastModified+gt+"2021-09-01T16:07:58Z" |
Supported attributes
| Operator | Description | Behavior |
|---|---|---|
| eq | equal | The attribute and operator values must be identical for a match. |
| ne | not equal | The attribute and operator values are not identical. |
| co | contains | The entire operator value must be a substring of the attribute value for a match. |
| gt | greater than | If the attribute value is greater than the operator value, there is a match. The actual comparison is dependent on the attribute type. For string attribute types, this is a lexicographical comparison, and for DateTime types, it is a chronological comparison. For integer attributes, it is a comparison by numeric value. Boolean and Binary attributes SHALL cause a failed response (HTTP status code 400) with "scimType" of "invalidFilter". |
| ge | greater than or equal to | If the attribute value is greater than or equal to the operator value, there is a match. The actual comparison is dependent on the attribute type. For string attribute types, this is a lexicographical comparison, and for DateTime types, it is a chronological comparison. For integer attributes, it is a comparison by numeric value. Boolean and Binary attributes SHALL cause a failed response (HTTP status code 400) with "scimType" of "invalidFilter". |
| lt | less than | If the attribute value is less than the operator value, there is a match. The actual comparison is dependent on the attribute type. For string attribute types, this is a lexicographical comparison, and for DateTime types, it is a chronological comparison. For integer attributes, it is a comparison by numeric value. Boolean and Binary attributes SHALL cause a failed response (HTTP status code 400) with "scimType" of "invalidFilter". |
| le | less than or equal to | If the attribute value is less than or equal to the operator value, there is a match. The actual comparison is dependent on the attribute type. For string attribute types, this is a lexicographical comparison, and for DateTime types, it is a chronological comparison. For integer attributes, it is a comparison by numeric value. Boolean and Binary attributes SHALL cause a failed response (HTTP status code 400) with "scimType" of "invalidFilter". |
Supported logical operators
| Operator | Description | Behavior |
|---|---|---|
| and | Logical "and" | The filter is only a match if both expressions evaluate to true. |
| or | Logical "or" | The filter is a match if either expression evaluates to true. |
Supported grouping operators
| Operator | Description | Behavior |
|---|---|---|
| [ ] | Complex attribute filter grouping | Service providers MAY support complex filters where expressions MUST be applied to the same value of a parent attribute specified immediately before the left square bracket ("["). The expression within square brackets ("[" and "]") MUST be a valid filter expression based upon sub-attributes of the parent attribute. Nested expressions MAY be used. See examples below. |
Pagination
Supported pagination parameters
| Parameter | Description | Default |
|---|---|---|
| startIndex | The 1-based index of the first query result. A value less than 1 SHALL be interpreted as 1. | 1 |
| count | Non-negative integer. Specifies the desired maximum number of query results per page, e.g., 10. A negative value SHALL be interpreted as "0". A value of "0" indicates that no resource results are to be returned except for "totalResults". | Default number is 10, Maximum number is 100 |
Pagination metadata
| Element | Description |
|---|---|
| itemsPerPage | Non-negative integer. Specifies the number of query results returned in a query response page, e.g., 10. |
| totalResults | Non-negative integer. Specifies the total number of results matching the client query, e.g., 1000. |
| startIndex | The 1-based index of the first result in the current set of query results, e.g., 1. |
Note: there's currently no support for sorting operators.