Skip to main content

Find user

The endpoint finds one or more users in the system that match the defined query parameters.

The required value is the instanceId of the customer.

For authorization, a JWT is required.

HTTP request

GET https://${instanceId}.id.nevis.cloud/nevis/api/v1/users?{queryParameters}

Parameters

ParameterInDescription
instanceId StringpathRequired The ID of the customer instance
limit IntegerqueryOptional The maximum size limit of the results
Default 1000
Note Always returned in response
continuationToken StringqueryOptional Token for retrieving the next set of results
Important Returned only with response that has a result for the given search

Examples

  • If you do not give any query parameters, an unordered set of users is returned.
  • /users/?name.firstName=John&name.lastName=Smith&limit=10 returns the first set of users called John Smith, containing at most 10 of them.
  • With the continuationToken available in the result, you can try for a next set. /users/?name.firstName=John&name.lastName=Smith&limit=10&continuationToken="1635929988000_bff1f42a-5ef8-4031-98ad-4c2a5d5a72fe returns the next set of 10 users called John Smith.

See detailed structure in the HTTP response. All parameters included in this topic are available for searching.

HTTP response

On success

HTTP/1.1 200 is returned if at least one user is found.

GET https://${instanceId}.id.nevis.cloud/nevis/api/v1/users/?languageCode=en

Parameters

ParameterInDescription
items StringbodyThe collection of results
limit IntegerbodyThe limit of the current search
continuationToken StringbodyThe continuation token value for retrieving the next set of results

Example

{
"items": [
{
"loginId": "[email protected]",
"address": {
"dwellingNumber": "31",
"city": "Budapest",
"street": "Corvin sétány",
"countryCode": "hu",
"postalCode": "1082",
"postOfficeBoxText": "133",
"houseNumber": "1/b",
"locality": "Corvin-negyed",
"addressline2": "Main building",
"addressline1": "Corvin sétány 1/b 1/1",
"postOfficeBoxNumber": 9
},
"gender": "other",
"modificationComment": "simply created modification",
"created": "2021-10-15T07:54:12Z",
"languageCode": "en",
"version": 1,
"birthDate": "2000-01-01T00:00:01Z",
"userState": "active",
"name": {
"firstName": "Alexander",
"familyName": "Nagy",
"title": "Dr."
},
"lastModified": "2021-10-15T07:54:12Z",
"extId": "4a5e7346-488b-46f9-914f-79ddb1131e0b",
"validity": {
"from": "2001-01-02T00:00:00Z",
"to": "2031-01-12T00:00:00Z"
},
"contacts": {
"mobile": "+36701235467",
"telephone": "+3611234567",
"telefax": "+441619998888",
"email": "[email protected]"
},
"remarks": "my first user!",
"properties": {
"preferredContactChannel": "email"
}
},
{
"loginId": "[email protected]",
"address": {
"dwellingNumber": "32",
"city": "Budapest",
"street": "Corvin sétány",
"countryCode": "hu",
"postalCode": "1082",
"postOfficeBoxText": "134",
"houseNumber": "1/b",
"locality": "Corvin-negyed",
"addressline2": "Main building",
"addressline1": "Corvin sétány 1/b 1/2",
"postOfficeBoxNumber": 10
},
"gender": "male",
"modificationComment": "simply created modification",
"created": "2021-10-15T07:54:13Z",
"languageCode": "en",
"version": 1,
"birthDate": "2001-01-02T00:00:01Z",
"userState": "active",
"name": {
"firstName": "Attila",
"familyName": "Black",
"title": "Mr."
},
"lastModified": "2021-10-15T07:54:13Z",
"extId": "4a5e7346-488b-46f9-914f-79ddb1131e0b",
"validity": {
"from": "2001-01-02T00:00:00Z",
"to": "2031-01-12T00:00:00Z"
},
"contacts": {
"mobile": "+36701235467",
"telephone": "+3611234567",
"telefax": "+441619998888",
"email": "[email protected]"
},
"remarks": "my second user!",
"properties": {
"preferredContactChannel": "phone"
}
}
],
"continuationToken": "1639467743000_a721ec6d-dcbf-4bcf-ac15-8ba7bba4135b",
"limit": 1000
}
note

properties in the response item body, properties map custom attributes of a user. If a custom attribute value is empty, it will be simply omitted. Custom attribute definitions are requested as a white glove service in Identity Cloud by an administrator.

On no result

HTTP/1.1 200 is returned also when no user is found with the given parameters.

Example

{
"items": [],
"continuationToken": "",
"limit": 1000
}

On failure

HTTP/1.1 401 is returned if the authorization failed due to an invalid JWT.

HTTP/1.1 422 is returned if invalid query parameters were given.

HTTP/1.1 500 is returned if an unexpected error occurred.