Users

Returns the requested user

You must have permission to view the user. You can view yourself, users you created, and users who belong to your company or its branches. In all other cases, a 401 is returned. Company details are provided in the response only if 'expand' parameter is passed in the URL with value as company. Otherwise, company information will not be provided in the response.

get/api/v4/partner/users/{user_id}

Request

Base URL
https://api-qa2.enphaseenergy.com
Auth
none declared
TypeScript
https://skmtc.dev/enphase/apis/commissioning-api/docs/api/v4/partner/users/:user_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

user_idinteger required

User ID

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 will not be provided in the response.

Response

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.