Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
Orgs

updateOrg

PUT
/api/v1/orgs/{org_id}

Update organization-level settings such as display name, support-access setting, organization groups, default alarm template, or admin session lifetime.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

org_id*string
Formatuuid

Request Body

application/json

Request Body

Mist organization containing sites, devices, users, and organization-level settings

alarmtemplate_id?|

Org-level alarm template ID used as the default for sites

Formatuuid
allow_mist?boolean

Whether Mist support access is allowed for this organization

Defaulttrue
name*string

Display name of the organization

orggroup_ids?array<>

Organization group IDs that include this organization

session_expiry?integer

Admin session lifetime for the organization, in minutes

Formatint32
Range10 <= value <= 20160
Default1440

Response Body

curl -X PUT "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab" \  -H "Content-Type: application/json" \  -d '{    "alarmtemplate_id": "1984805d-2be2-4aec-a8d4-3ddf67fab0df",    "allow_mist": true,    "name": "string",    "orggroup_ids": [],    "session_expiry": 1440  }'
{  "alarmtemplate_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "allow_mist": true,  "created_time": 0,  "id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "modified_time": 0,  "msp_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",  "name": "string",  "orggroup_ids": [    "b069b358-4c97-5319-1f8c-7c5ca64d6ab1"  ],  "session_expiry": 1440}

deleteOrg DELETE

Delete an organization and its organization-level resources. Use MSP organization assignment endpoints when only changing MSP ownership or association. This action is only allowed when the Organization Inventory is empty.

inviteOrgAdmin POST

If the request is successful, an email will also be sent to the user with a link to ```https://manage.mist.com/verify/invite?token=:token&expire=1459632743&org=OrgName```