Get user

The endpoint provides detailed information of a user.

HTTP request

GET https://$instanceId.id.nevis.cloud/nevis/api/v1/users/$userId

Parameters

Parameter	In	Type	Required / Optional	Description
instanceId	path	string	required	The ID of your Identity Cloud instance
userId	path	string	required	The ID of the user

Example request

Set the ID of the user.

userId=your-user-id-123

curl "https://$instanceId.id.nevis.cloud/nevis/api/v1/users/$userId" \
  --header "Authorization: Bearer $accessKey"

HTTP response

On success

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

Parameter	Type	Description
version	integer	The version of the user data, used for optimistic locking
created	string	The creation date of the user in ISO 8061 timestamp format YYYY-MM-DDThh:mm:ssZ
lastModified	string	The last modification date of the user modification in ISO 8061 timestamp format YYYY-MM-DDThh:mm:ssZ
loginId	string	The email of the user
userState	enum	The state of the user; Values: active,blocked, notInvited, pendingInvitation, expiredInvitation
languageCode	string	The language of the user
userId	string	The identifier of the user
name.title	string	The title of the user
name.firstName	string	The first name of the user
name.lastName	string	The last name of the user
gender	enum	The gender of the user Values: female, male, other
birthDate	string	The birth date of the user in ISO 8601 date format YYYYY-MM-DD
address.countryCode	string	The country code of the user in ISO 3166-1 format
address.city	string	The city of the user's address
address.postalCode	string	The postal code of the user
address.addressline1	string	First free text for supplementary address information of the user
address.addressline2	string	Second free text for supplementary address information of the user
address.street	string	The street of the user
address.houseNumber	string	The house number of the user
address.dwellingNumber	string	The dwelling number of the user
address.postOfficeBoxText	string	The post office box text of the user
address.postOfficeBoxNumber	string	The post office box number of the user
address.locality	string	The locality of the user address
contacts.telephone	string	The landline telephone number of the user in E.164 format starting with the plus + sign and having no spaces
contacts.telefax	string	The telefax number of the user in E.164 format starting with the plus + sign and having no spaces
remarks	string	The short metadata; Additional information field for the user Example Remarks to a food delivery
modificationComment	string	Additional metadata regarding user modification Note This can be seen in the history.
properties	map<string,string>	Custom attributes of the user You can request custom user attributes on the management console. For more information, see Custom user attributes.

Example response

{
    "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": "Jane",
        "lastName": "Doe",
        "title": "Dr."
    },
    "lastModified": "2021-10-15T07:54:12Z",
    "userId": "4a5e7346-488b-46f9-914f-79ddb1131e0b",
    "contacts": {
        "telephone": "+3611234567",
        "telefax": "+441619998888"
    },
    "remarks": "my first user!",
    "properties": {
        "preferredContactChannel": "email"
    }
}

On missing user

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

Example response

note

The referred extId field in the response equals the userId.

{
    "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 fails due to an invalid access key.

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