POST /api/v1/users/invite
Create a new user and send them an invitation email.

Metadata

- Authentication: The user must be authenticated to perform this action.
- Admin privileges: The user has to have administrative privileges to perform this
    action.

Params

Param name Description
user
optional , nil allowed

Validations:

  • Must be a Hash
user[username]
optional

User’s login name.

Validations:

  • Must be a String
user[password]
optional , nil allowed

User’s password.

Validations:

  • Must be a String
user[password_confirmation]
optional , nil allowed

User’s password confirmation.

Validations:

  • Must be a String
user[role_id]
optional

The string determining user’s role in the application.

Validations:

  • Must be a String
user[firstname]
optional , nil allowed

User’s first name.

Validations:

  • Must be a String
user[lastname]
optional , nil allowed

User’s last name.

Validations:

  • Must be a String
user[user_matrix_attributes]
optional , nil allowed

Capabilities of this specific user. Overrides role capabilities.

Validations:

  • Must be a Hash
user[skies_tier]
optional , nil allowed

User’s Skies tier.

Validations:

  • Must be a String
user[authentication_method]
optional , nil allowed

Optionally set the authentication method to: ldap,openid.

Validations:

  • Must be a String
team_id
optional

Optionally the team to assign to the new user.

Validations:

  • Must be a String
message
optional

Optional message to attach to the invitation.

Validations:

  • Must be a String