Invite User

Invite a new user using email.

Sends an invite email with instructions to the new user.

You should call this endpoint over the Create User endpoint if you are intending for users to use a regular password to authentication flow on the regular Aurora application.

post/tenants/{tenant_id}/users/invite

Request

Base URL
https://api-sandbox.aurorasolar.com
URL
https://api-sandbox.aurorasolar.com/tenants/{tenant_id}/users/invite
Auth
HTTP bearer

Path parameters

tenant_idstring uuid required

The ID of the tenant to invite the user to.

Request body

Example request

{
  "user": {
    "first_name": "Joe",
    "last_name": "Solar",
    "email": "jsolar@aurorasolar.com",
    "phone": "(415) 360-9291",
    "title": "Engineer",
    "job_function": "executive_or_owner",
    "role_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "locale": "en-US",
    "base_price_per_watt_max": 8.31,
    "base_price_per_watt_min": 1.72
  }
}

Response

User successfully invited.

Example response

{
  "user": {
    "first_name": "Joe",
    "last_name": "Solar",
    "email": "jsolar@aurorasolar.com",
    "account_status": "active",
    "phone": "(415) 360-9291",
    "title": "Engineer",
    "job_function": "executive_or_owner",
    "external_provider_id": "https://test.salesforce.com/id/00556000000X3J3AFA/00540000001ulvMAEA",
    "role_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "locale": "en-US",
    "base_price_per_watt_max": 8.31,
    "base_price_per_watt_min": 1.72
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.