Skip to main content

List users

GET 
/nevisidm/api/scim/v1/:clientExtId/Users

Returns a paginated list of SCIM user representations belonging to the specified client. Supports filtering, sorting, attribute selection, and bulk export format.

Specific credential types can be selected using credentials[TYPE] syntax in the attributes/excludedAttributes parameters, e.g. credentials[PASSWORD] or credentials[OTP]. Only the specified credential types will be included in or excluded from the response.

When bulkImportFormat is set to true, the response is a ScimBulkRequest with POST operations instead of the standard ScimListResponse.

Request​

Path Parameters

    clientExtId stringrequired

    Client's external identifier.

    Example: 100

Query Parameters

    startIndex integer

    Start index for the listing. Default value: 1.

    Example: 1
    count integer

    Maximum number of elements in the result list. Default value is 10 and maximum set by application.scim.filter-max-results.

    Example: 10
    attributes string[]

    Comma separated list of attributes must be contained by the result. Empty value means all available attributes are contained by the result.

    Example: [userName]
    excludedAttributes string[]

    Comma separated list of attributes must NOT be contained by the result. Empty value means all available attributes are contained by the result. If attributes present and not empty, this 'excludedAttributes' is ignored.

    Example: [userName]
    filter string

    Filter expression may be used to restrict results to one or more specific resource. Empty filter means all possible resources are selected.

    Example: userName eq "tesla"
    sortBy string

    Name of an attribute (or sub-attribute) for sorting the result. Empty value means as sorting attribute the 'id' is used to. When used together with 'filter', deterministic output is not guaranteed because filtering and sorting are processed on separate execution branches.

    Example: userName
    sortOrder string

    Possible values: [ascending, descending]

    Sort order of selected attribute (in 'sortBy' parameter). Empty value means the default ascending sorting order.

    Example: descending
    bulkImportFormat boolean

    The output is ScimBulkRequest with create operations instead of ScimListResponse as standard defines. This optional parameter by default false.

    Example: true

Responses​

Users retrieved successfully

Schema
    schemas string[]required

    An array of Strings containing URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure.

    totalResults int64required

    Number of total results.

    itemsPerPage int32required

    Number of results in a single response. By default 10. Controlled by 'count' request parameter.

    startIndex int64required

    Start index of current result. By default 1. Controlled by 'startIndex' request parameter.

    Resources ScimBase[]required

    Array of SCIM resources. For example array of users.

  • Array [
    • schemas string[]required

    An array of Strings containing URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure.

  • ]
Loading...
Last updated on