Users

Returns the requested user

You must have access to the requested activation and user; otherwise a 401 is returned. The user is requested in the scope of an activation, then it must be the owner or the host of an activation the API user can manage (or) Users created by API user (or) Users who belong to your company or its branches.

get/api/v4/activations/{activation_id}/users/{user_id}

Request

Path parameters

activation_idinteger required

The Enlighten ID of the activation(system). System-generated.

user_idinteger required

The Enlighten ID of the user. System-generated.

Query parameters

expand'company'

Passing expand params in the url with valid option, then the response will contain company object fields. Otherwise the company information not include in the response.

Response

OK

activeboolean

Whether the user is allowed to log in to Enlighten

user_rolesstring[]

What type of user this is in Enlighten. Possible values are ['self_installer']. For self installer user user_roles will be ['self_installer']. For other users user_roles will be empty.

emailstring

The email address of the user

enlighten_emailsboolean

Whether the user receives automated emails from Enlighten

enlighten_viewstring

Which view of Enlighten the user has

first_namestring

The user's first name

last_namestring

The user's last name

phonestring

The telephone number of the user

uristring

URI to the show() method for the user. System-generated

user_idinteger

The Enlighten ID of the user. System-generated

updated_atinteger

Last updated date and time in Epoch format

Changes

No recorded changes to this operation across all 1 revision of this API.