Skip to main content

List users of a client

GET 
/nevisidm/api/core/v1/clients/:extId/users

Since: 2.71.0

Required permission(s): AccessControl.ClientView,AccessControl.UserView,AccessControl.PropertyView,AccessControl.PropertyValueView,AccessControl.PropertyAllowedValueView

Returns all users belonging to the client with the given external ID. Supports sorting result via sortBy query parameter. Possible values:

  • extId,
  • loginId,
  • isTechnicalUser,
  • name.title,
  • name.firstName,
  • name.familyName,
  • birthDate,
  • address.countryCode,
  • address.city,
  • address.postalCode,
  • address.addressline1,
  • address.addressline2,
  • address.street,
  • address.houseNumber,
  • address.dwellingNumber,
  • address.postOfficeBoxText,
  • address.postOfficeBoxNumber,
  • address.locality,
  • contacts.telephone,
  • contacts.telefax,
  • contacts.mobile,
  • contacts.email,
  • validity.to,
  • validity.from,
  • remarks,
  • version,
  • created,
  • lastModified

Supports offset-based pagination. The offset query parameter specifies the offset of the first result to be returned. If both continuation token and offset are provided, the continuation token is ignored.

Filtering is supported by property or any user field. Supported filter fields:

  • extId
  • userState
  • loginId
  • languageCode
  • isTechnicalUser
  • name.title
  • name.firstName
  • name.familyName
  • sex
  • gender
  • birthDate
  • address.countryCode
  • address.city
  • address.postalCode
  • address.addressline1
  • address.addressline2
  • address.street
  • address.houseNumber
  • address.dwellingNumber
  • address.postOfficeBoxText
  • address.postOfficeBoxNumber
  • address.locality
  • contacts.telephone
  • contacts.telefax
  • contacts.email
  • contacts.mobile
  • validity.from
  • validity.to
  • remarks
  • modificationComment
  • version
  • created
  • lastModified

Modifiers for extId and loginId: _SW (starts with), _IEQ (case-insensitive full match).

Example filter queries:

  • ?property.user%20global%20test%201=ffgg&property.user%20global%20test%20status=ACTIVE
  • ?extId=100&userState=ACTIVE
  • ?extId_SW=boo&userState=ACTIVE
  • ?loginId_IEQ=BOOTSTRAP&languageCode=en
  • ?isTechnicalUser=false&name.title=Mr.
  • ?address.street=Roentgenstrasse&address.houseNumber=22
  • ?contacts.telephone=0444444444&contacts.email=[email protected]

Example sort queries:- ?sortBy=extId

  • ?sortBy=extId_DESC
  • ?sortBy=extId_ASC

Set returnTotalResultCount=true to include the total count in the _pagination response.

Request​

Path Parameters

    extId stringrequired

    External ID of the client.

    Example: client-123

Query Parameters

    continuationToken string

    Pagination continuation token from a previous response.

    limit int32

    Default value: 0

    Maximum number of results to return.

    Example: 100
    sortBy string

    Field to sort by, optionally suffixed with _ASC or _DESC.

    Example: extId_ASC
    allParams objectrequired
    returnTotalResultCount boolean

    Whether to include total result count in the pagination response.

    offset int32

    Zero-based offset for pagination. Overrides continuation token if provided.

Responses​

Users retrieved successfully

Schema
    items object[]
  • Array [
    • created string

    Creation date of the entity.

    lastModified string

    Date when the entity was last modified.

    version int32

    Version used for optimistic locking.

    extId string

    The external ID of the user. Can only be set on creation.

    clientExtId string

    The external ID of the client the user belongs to.

    userState string

    Possible values: [active, disabled, archived]

    The state of the user.

    loginId string

    The login ID (username) of the user.

    languageCode string

    Possible values: [EN, DE, FR, IT]

    The default language of the user.

    isTechnicalUser boolean

    Determines whether the user is a regular user like a real person, or a technical user like another software.

    name object

    The name of the user.

    title string

    User's title.

    firstName string

    User's first name.

    familyName string

    User's family name.

    properties object

    Custom properties of the user.

    property name* string
    sex string

    Possible values: [male, female, other]

    The biological sex of the user. This is not the same as legal gender.

    gender string

    Possible values: [female, male, other]

    The gender of the user. Possible values are 'female', 'male' and 'other'.

    birthDate string

    The user date of birth in ISO format.

    address object

    The address of the user.

    addressline1 string

    First line of the address.

    addressline2 string

    Second line of the address.

    postalCode string

    Postal code.

    city string

    City.

    street string

    Street name.

    houseNumber string

    House number.

    countryCode string

    Country code (ISO 3166-1 alpha-2).

    postOfficeBoxText string

    Text for post office box.

    postOfficeBoxNumber int32

    Number for post office box.

    dwellingNumber string

    Dwelling number.

    locality string

    Locality.

    contacts object

    Telephone numbers and email addresses on which the user can be contacted.

    telephone string

    User's telephone number.

    telefax string

    User's telefax number.

    mobile string

    User's mobile number.

    email string

    User's email address.

    validity object

    The validity period of the user entity.

    from string

    Start date of the entity's validity in ISO format.

    to string

    End date of the entity's validity in ISO format.

    remarks string

    General textual remark about the user.

    modificationComment string

    Textual comment on the last modification.

    get_classifications object

    Classifications assigned to the user.

    property name* string[]
  • Array [

    • string

  • ]
    • lastSuccessfulLoginDate string

    The date of the last successful login of the user.

    lastFailedLoginDate string

    The date of the last failed login attempt for the user.

  • ]
    • _pagination object
    continuationToken string

    The continuation token for fetching the next page of results generated from creation date and external id of the last entity

    limit int32

    The maximum number of results returned in a single page

    totalResult int64

    The total number of results available, only supported for selected endpoints, if returnTotalResultCount query-parameter is true

    _classifications object
    property name* string[]
  • Array [

    • string

  • ]
Loading...
Last updated on