Skip to main content

Get user

The endpoint provides detailed information on a user, based on their unique identifier.

The required values are the userExtId retrieved upon user creation, and the instanceId of the customer.

For authorization, a JWT is required.

HTTP request

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

Parameters

ParameterInDescription
instanceId StringpathRequired The ID of the customer instance
userExtId UUIDpathRequired The ID of the searched user

HTTP response

On success

HTTP/1.1 200 is returned if the user is found.

Parameters

ParameterInDescription
loginId StringbodyThe username of the user
version IntegerbodyThe version of the user, used for optimistic locking
userState EnumbodyThe state of the user
languageCode StringbodyThe language of the user
extId StringbodyThe identifier of the user
name Object
- title String
- firstName String
- familyName String
bodyThe full name of the user
gender EnumbodyThe gender of the user
birthDate StringbodyThe birth date of the user
address Object
- countryCode String
- city String
- postalCode String
- addressline1 String
- addressline2 String
- street String
- houseNumber String
- dwellingNumber String
- postOfficeBoxText String
- postOfficeBoxNumber String
- locality String
bodyThe detailed address of the user.
contacts Object
- mobile String
- telephone String
- telefax String
- email String
bodyThe different contacts of the user
validity Object
- from String
- to String
bodyThe start and end date of the user validity period
remarks StringbodyThe short metadata, additional information field for the user
modificationComment StringbodyAdditional metadata regarding user modification
created StringbodyThe date of the user creation
lastModified StringbodyThe date of the last user modification;
Initially equals the creation date
properties Map<String,String>bodyCustom attributes of a user;
If a custom attribute value is empty it will be omitted.
Note Custom attribute definitions are requested as a white glove service in Identity Cloud by an administrator.

Example

{
"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",
"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"
}
}

On missing user

HTTP/1.1 404 is returned if no user is found with the given userExtId, with a detailed message.

Example

{
"errors": [
{
"code": "errors.noRecord",
"message": "A user with extId 4a5e7346-488b-46f9-914f-79ddb1131e0ba doesn't exist on client with name Client-users"
}
]
}

On failure

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

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