Mist API Reference
Mist Automation Guide
HomeSDKsAPI ReferenceContext Plugin
OrgsLicenses

moveOrDeleteOrgLicenseToAnotherOrg

PUT
/api/v1/orgs/{org_id}/licenses

Move, Undo Move or Delete Org License to Another Org If the admin has admin privilege against the org_id and dst_org_id, he can move some of the licenses to another Org. Given that:

  1. the specified license is currently active
  2. there’s enough licenses left in the specified license (by subscription_id)
  3. there will still be enough entitled licenses for the type of license after the amendment

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

Request to amend, annotate, delete, or unamend an organization license

amendment_id?string

If op==unamend, the ID of the operation to cancel

Formatuuid
dst_org_id?string

If op==amend, the id of the org where the license is moved

Formatuuid
notes?string

If op==annotate, note text to attach to the license

op*org_license_action_operation

License action operation to perform. enum: amend, annotate, delete, unamend.

Value in

  • "amend"
  • "annotate"
  • "delete"
  • "unamend"
quantity?integer

If op==amend, the number of licenses to move

subscription_id?string

If op==amend or op==delete, the ID of the subscription to use

Response Body

curl -X PUT "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/licenses" \  -H "Content-Type: application/json" \  -d '{    "notes": "customer notes",    "op": "annotate",    "subscription_id": "SUB-000144"  }'
Empty

getOrgLicensesSummary GET

Return the organization license entitlement, subscription, amendment, consumption, and available-license summary.

getOrgOauthAppAuthorizationUrl GET

Return linked-account status for the specified organization OAuth application and the authorization URL used to start account linking.