Invite a User to the Team

post

https://webapi.splashtop.com/api/open/v1/teams/{team_id}/users/invite

This is the API to send an invitation to a user to join the team.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

team_id

integer

required

ID of the Splashtop team.

Body Params

string

required

Email address of the user you would like to invite to the team. The email address will be invitee’s Splashtop account moving forward.

role

string

required

The assigned role of the invited user on the team (String) Available roles: manager: Admins on the team, including super admins, group admins and normal admins. Super Admin role cannot be assigned upon invitation and can be configured after the user joins the team. member: member on the team remote_user: available only for Splashtop AEM and Splashtop AEM (Enterprise)

license_type

string

required

The license type of the invited user on the team (String) Available license types: technician: Users who will occupy support license on the team end_user: Users who will occupy access license on the team

xauth_method_id

integer

(Optional) ID of the SSO method. Only required when you invite a user to be associated an SSO method. You can get the SSO method list from 5.3.4 Get SSO method info.

group_admin

boolean

(Optional) Boolean, assign the invited user as a group admin. To set this to true, the parameter role has to be manager

group_id

integer

(Optional) The ID of the user group that you would like to assign the invited user to. You can retrieve the group id info from 5.4 Groups API.

save_invitation_message

boolean

(Optional) Boolean, modify the invitation email contents. If this is set to true, it will refer to below parameters to send the invitation.

invitation_text

string

(Optional) Only used when save_invitation_message is true. This is the content you would like to add to the default invitation email content.

invitation_language

string

(Optional) Only used when save_invitation_message is true. Determine which language you would like to send the default invitation email content in. The default value is en. (String) Available languages: en, ja, zh-cn, de, ko, es, it, fr, zh-tw, pt

Responses

400

Bad request — invalid parameters

401

Unauthorized — invalid or missing access token

403

Forbidden — insufficient scope, or the action/value/target is not allowed. See data.error for the sub-reason.

200Successful response