inviteMspAdmin
POST https://{{host}}/api/v1/msps/:msp_id/invites
Body Parameters
Parameter | Type | Description |
---|---|---|
string | email - admin_id is not exposed | |
name | string | name, used in the invitation text |
privileges | list | list of privileges the admin has on the MSP / Orgs / OrgGroups |
scope | string | msp / org / orggroup |
role | string | admin / write / read |
hours | int | optional, how long the invite should be valid, default is 1 day, maximum is 1 week. |
Note: An email will also be sent to the user with a link to https://manage.mist.com/verify/invite?token=:token
Request Body
{"email"=>"joe@abc.com", "name"=>"Richard", "hours"=>24, "privileges"=>[{"scope"=>"msp", "role"=>"admin"}, {"scope"=>"org", "org_id"=>"2818e386-8dec-2562-9ede-5b8a0fbbdc71", "role"=>"admin"}, {"scope"=>"orggroup", "orggroup_id"=>"507f1bab-13ba-73e2-f291-2bcb8d1362b0", "role"=>"read"}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string | ||
X-CSRFToken | string | ||
Content-Type | string |
RESPONSES
status: OK
{"admin_id":"456b7016-a916-a4b1-78dd-72b947c152b7","first_name":"Joe","last_name":"Smith","privileges":[{"scope":"msp","role":"admin"},{"scope":"org","org_id":"2818e386-8dec-2562-9ede-5b8a0fbbdc71","role":"admin"},{"scope":"orggroup","orggroup_id":"507f1bab-13ba-73e2-f291-2bcb8d1362b0","role":"read"}]}