users

Invite a User to the Account

Invite the user to the account by adding it to the account teams and/or creating access policies within the account.

If the user with a specified email does not exist - a new one will be created. The new user will be in the 'pending' status until the first login to the account.

This is the preferred way to create users.

post/accounts/{account}/actions/invite

Request

  • Base URL
    https://example.scalr.io/api/iacp/v3
  • URL
    https://example.scalr.io/api/iacp/v3/accounts/{account}/actions/invite
  • Auth
    HTTP bearer

Path parameters

accountstring required

Query parameters

includestring[]

The comma-separated list of relationship paths.

Request body

includedobject[]
metaobject

Response

Success.

includedobject[]
metaobject

Changes

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