{
  "opencollection": "1.0.0",
  "info": {
    "name": "Mist Admins Orgs SDK Invites API",
    "version": "2606.1.1"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Orgs SDK Invites",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "activateSdkInvite",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/mobile/verify/:secret",
            "params": [
              {
                "name": "secret",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Activate a mobile SDK invite by verifying the invite secret and binding it to the supplied device identifier. The response returns the device-specific secret used by the mobile SDK client."
        },
        {
          "info": {
            "name": "listSdkInvites",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/sdkinvites",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "List SDK invites configured for the organization. SDK invites are used to onboard mobile SDK clients and can define whether an invite is enabled, limited by usage quota, or scoped to a site."
        },
        {
          "info": {
            "name": "createSdkInvite",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/sdkinvites",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create an SDK invite that mobile SDK clients can use to onboard into the organization. The invite can be enabled or disabled, limited by usage quota, and associated with a site."
        },
        {
          "info": {
            "name": "getSdkInvite",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/sdkinvites/:sdkinvite_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "sdkinvite_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Return the configuration and status of an SDK invite, including enablement, expiration time, usage quota, and site scope."
        },
        {
          "info": {
            "name": "updateSdkInvite",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/sdkinvites/:sdkinvite_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "sdkinvite_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an SDK invite's onboarding settings, such as its display name, enabled state, expiration time, quota, or site association."
        },
        {
          "info": {
            "name": "revokeSdkInvite",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/sdkinvites/:sdkinvite_id",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "sdkinvite_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Revoke an SDK invite so it can no longer be used for mobile SDK client onboarding."
        },
        {
          "info": {
            "name": "sendSdkInviteEmail",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/sdkinvites/:sdkinvite_id/email",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "sdkinvite_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Send the SDK invite to a recipient email address so the recipient can onboard a mobile SDK client."
        },
        {
          "info": {
            "name": "getSdkInviteQrCode",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/sdkinvites/:sdkinvite_id/qrcode",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "sdkinvite_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Download a QR code image for the SDK invite so it can be scanned by a mobile SDK client during onboarding."
        },
        {
          "info": {
            "name": "sendSdkInviteSms",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.mist.com/api/v1/orgs/:org_id/sdkinvites/:sdkinvite_id/sms",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "sdkinvite_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Send the SDK invite to a phone number by SMS so the recipient can onboard a mobile SDK client."
        }
      ]
    }
  ],
  "bundled": true
}