Systems Manager

Force check-in a set of devices.

API documentation: checkinNetworkSmDevices

Parameters:

• network_id (str) –

  Network ID.

• wifi_macs (list[str] | None, default: None ) –

  The wifiMacs of the devices to be checked-in.

• ids (list[str] | None, default: None ) –

  The ids of the devices to be checked-in.

• serials (list[str] | None, default: None ) –

  The serials of the devices to be checked-in.

• scope (list[str] | None, default: None ) –

  The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be checked-in.

Returns:

• NetworkSmDevicesResponse –

  Successful operation.

{
  "ids": [
    "1284392014819",
    "2983092129865"
  ]
}

Bypass activation lock attempt.

API documentation: createNetworkSmBypassActivationLockAttempt

Parameters:

• network_id (str) –

  Network ID.

• ids (list[str]) –

  The ids of the devices to attempt activation lock bypass.

Returns:

• DictResponse –

  Successful operation.

{
  "id": "1234",
  "status": "pending",
  "data": {}
}

Add a target group.

API documentation: createNetworkSmTargetGroup

Parameters:

• network_id (str) –

  Network ID.

• name (str | None, default: None ) –

  The name of this target group.

• scope (str | None, default: None ) –

  The scope and tag options of the target group. Comma separated values beginning with one of withAny, withAll, withoutAny, withoutAll, all, none, followed by tags. Default to none if empty.

Returns:

• NetworkSmTargetGroupResponse –

  Successful operation.

{
  "id": "1284392014819",
  "name": "Target group name",
  "scope": "withAny",
  "tags": [
    "tag1",
    "tag2"
  ]
}

Create a Limited Access Role.

API documentation: createOrganizationSmAdminsRole

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  The name of the Limited Access Role.

• scope (CreateOrganizationSmAdminsRoleScope | None, default: None ) –

  The scope of the Limited Access Role.

• tags (list[str] | None, default: None ) –

  The tags of the Limited Access Role.

Returns:

• OrganizationSmAdminsRoleResponse –

  Successful operation.

{
  "roleId": "1284392014819",
  "name": "sample name",
  "scope": "all_tags",
  "tags": [
    "tag"
  ]
}

Delete a target group from a network.

API documentation: deleteNetworkSmTargetGroup

Parameters:

• network_id (str) –

  Network ID.

• target_group_id (str) –

  Target group ID.

Returns:

• None –

  Successful operation.

Delete a User Access Device.

API documentation: deleteNetworkSmUserAccessDevice

Parameters:

• network_id (str) –

  Network ID.

• user_access_device_id (str) –

  User access device ID.

Returns:

• None –

  Successful operation.

Delete a Limited Access Role.

API documentation: deleteOrganizationSmAdminsRole

Parameters:

• organization_id (str) –

  Organization ID.

• role_id (str) –

  Role ID.

Returns:

• None –

  Successful operation.

Bypass activation lock attempt status.

API documentation: getNetworkSmBypassActivationLockAttempt

Parameters:

• network_id (str) –

  Network ID.

• attempt_id (str) –

  Attempt ID.

Returns:

• DictResponse –

  Successful operation.

{
  "id": "1234",
  "status": "complete",
  "data": {
    "38290139892": {
      "success": true
    },
    "2090938209": {
      "success": false,
      "errors": [
        "Activation lock bypass code not known for this device"
      ]
    }
  }
}

Return the client's daily cellular data usage history.

API documentation: getNetworkSmDeviceCellularUsageHistory

Parameters:

• network_id (str) –

  Network ID.

• device_id (str) –

  Device ID.

Returns:

• PaginatedResponse[GetNetworkSmDeviceCellularUsageHistoryResponseItem] –

  Successful operation.

[
  {
    "received": 61.0,
    "sent": 138.0,
    "ts": "2018-05-12T00:00:00Z"
  }
]

List the certs on a device.

API documentation: getNetworkSmDeviceCerts

Parameters:

• network_id (str) –

  Network ID.

• device_id (str) –

  Device ID.

Returns:

• PaginatedResponse[GetNetworkSmDeviceCertsResponseItem] –

  Successful operation.

[
  {
    "name": "My Cert",
    "notValidAfter": "2018-05-12T00:00:00Z",
    "notValidBefore": "2018-02-11T00:00:00Z",
    "certPem": "-----BEGIN CERTIFICATE-----\n-----END CERTIFICATE-----\n",
    "deviceId": "1234",
    "issuer": "",
    "subject": "",
    "id": "15"
  }
]

Returns historical connectivity data (whether a device is regularly checking in to Dashboard).

API documentation: getNetworkSmDeviceConnectivity

Parameters:

• network_id (str) –

  Network ID.

• device_id (str) –

  Device ID.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkSmDeviceConnectivityResponseItem] –

  Successful operation.

[
  {
    "firstSeenAt": "2018-02-11T00:00:00Z",
    "lastSeenAt": "2018-05-12T00:00:00Z"
  }
]

Return historical records of various Systems Manager network connection details for desktop devices.

API documentation: getNetworkSmDeviceDesktopLogs

Parameters:

• network_id (str) –

  Network ID.

• device_id (str) –

  Device ID.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkSmDeviceDesktopLogsResponseItem] –

  Successful operation.

[
  {
    "measuredAt": "2018-05-12T00:00:00Z",
    "user": "milesmeraki",
    "networkDevice": "NIC",
    "networkDriver": "Driver",
    "wifiChannel": "11",
    "wifiAuth": "wpa-psk",
    "wifiBssid": "00:11:22:33:44:55",
    "wifiSsid": "ssid",
    "wifiRssi": "-11",
    "wifiNoise": "-99",
    "dhcpServer": "1.2.3.4",
    "ip": "1.2.3.4",
    "networkMTU": "1500",
    "subnet": "192.168.1.0/24",
    "gateway": "1.2.3.5",
    "publicIP": "123.123.123.1",
    "dnsServer": "8",
    "ts": "2018-05-12T00:00:00Z"
  }
]

Return historical records of commands sent to Systems Manager devices.

API documentation: getNetworkSmDeviceDeviceCommandLogs

Parameters:

• network_id (str) –

  Network ID.

• device_id (str) –

  Device ID.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkSmDeviceDeviceCommandLogsResponseItem] –

  Successful operation.

[
  {
    "action": "UpdateProfile",
    "name": "My profile",
    "details": "{}",
    "dashboardUser": "Miles Meraki",
    "ts": "2018-05-12T00:00:00Z"
  }
]

Get the installed profiles associated with a device.

API documentation: getNetworkSmDeviceDeviceProfiles

Parameters:

• network_id (str) –

  Network ID.

• device_id (str) –

  Device ID.

Returns:

• PaginatedResponse[GetNetworkSmDeviceDeviceProfilesResponseItem] –

  Successful operation.

[
  {
    "deviceId": "1234",
    "id": "1284392014819",
    "isEncrypted": true,
    "isManaged": true,
    "profileData": "{}",
    "profileIdentifier": "com.test.app",
    "name": "My profile",
    "version": "0.0.1"
  }
]

List the network adapters of a device.

API documentation: getNetworkSmDeviceNetworkAdapters

Parameters:

• network_id (str) –

  Network ID.

• device_id (str) –

  Device ID.

Returns:

• PaginatedResponse[GetNetworkSmDeviceNetworkAdaptersResponseItem] –

  Successful operation.

[
  {
    "dhcpServer": "123.123.123.1",
    "dnsServer": "8.8.8.8, 8.8.4.4",
    "gateway": "1.2.3.5",
    "id": "1284392014819",
    "ip": "1.2.3.4",
    "mac": "00:11:22:33:44:55",
    "name": "en0",
    "subnet": "255.255.255.0"
  }
]

Return historical records of various Systems Manager client metrics for desktop devices.

API documentation: getNetworkSmDevicePerformanceHistory

Parameters:

• network_id (str) –

  Network ID.

• device_id (str) –

  Device ID.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkSmDevicePerformanceHistoryResponseItem] –

  Successful operation.

[
  {
    "cpuPercentUsed": 0.95,
    "memFree": 1024,
    "memWired": 4096,
    "memActive": 1024,
    "memInactive": 2048,
    "networkSent": 512,
    "networkReceived": 512,
    "swapUsed": 768,
    "diskUsage": {
      "c": {
        "used": 2048,
        "space": 9096
      }
    },
    "ts": "2018-05-12T00:00:00Z"
  }
]

List the restrictions on a device.

API documentation: getNetworkSmDeviceRestrictions

Parameters:

• network_id (str) –

  Network ID.

• device_id (str) –

  Device ID.

Returns:

• GetNetworkSmDeviceRestrictionsResponse –

  Successful operation.

{
  "restrictions": [
    {
      "profile": "com.test.app"
    }
  ]
}

List the security centers on a device.

API documentation: getNetworkSmDeviceSecurityCenters

Parameters:

• network_id (str) –

  Network ID.

• device_id (str) –

  Device ID.

Returns:

• PaginatedResponse[GetNetworkSmDeviceSecurityCentersResponseItem] –

  Successful operation.

[
  {
    "isRooted": true,
    "hasAntiVirus": true,
    "antiVirusName": "meraki_av",
    "isFireWallEnabled": true,
    "hasFireWallInstalled": true,
    "fireWallName": "meraki_fw",
    "isDiskEncrypted": true,
    "isAutoLoginDisabled": true,
    "id": "1284392014819",
    "runningProcs": "/software,/software_2"
  }
]

Get a list of softwares associated with a device.

API documentation: getNetworkSmDeviceSoftwares

Parameters:

• network_id (str) –

  Network ID.

• device_id (str) –

  Device ID.

Returns:

• PaginatedResponse[GetNetworkSmDeviceSoftwaresResponseItem] –

  Successful operation.

[
  {
    "appId": "1234",
    "bundleSize": 1024,
    "createdAt": "2018-02-11T00:00:00Z",
    "deviceId": "1234",
    "dynamicSize": 2048,
    "id": "1284392014819",
    "identifier": "com.test.app",
    "installedAt": "2018-05-12T00:00:00Z",
    "toInstall": true,
    "iosRedemptionCode": false,
    "isManaged": true,
    "itunesId": "1234",
    "licenseKey": "Z21234567890",
    "name": "My app",
    "path": "/Path/to/app.app",
    "redemptionCode": 1234,
    "shortVersion": "1.1",
    "status": "Managed",
    "toUninstall": false,
    "uninstalledAt": "2018-02-11T00:00:00Z",
    "updatedAt": "2018-05-12T00:00:00Z",
    "vendor": "Apple",
    "version": "0.1"
  }
]

List the saved SSID names on a device.

API documentation: getNetworkSmDeviceWlanLists

Parameters:

• network_id (str) –

  Network ID.

• device_id (str) –

  Device ID.

Returns:

• PaginatedResponse[GetNetworkSmDeviceWlanListsResponseItem] –

  Successful operation.

[
  {
    "createdAt": "2018-02-11T00:00:00Z",
    "id": "1284392014819",
    "xml": "Preferred networks on en0:"
  }
]

List the devices enrolled in an SM network with various specified fields and filters.

API documentation: getNetworkSmDevices

Parameters:

• network_id (str) –

  Network ID.

• fields (list[str] | None, default: None ) –

  Additional fields that will be displayed for each device. The default fields are: id, name, tags, ssid, wifiMac, osName, systemModel, uuid, and serialNumber. The additional fields are: ip, systemType, availableDeviceCapacity, kioskAppName, biosVersion, lastConnected, missingAppsCount, userSuppliedAddress, location, lastUser, ownerEmail, ownerUsername, osBuild, publicIp, phoneNumber, diskInfoJson, deviceCapacity, isManaged, hadMdm, isSupervised, meid, imei, iccid, simCarrierNetwork, cellularDataUsed, isHotspotEnabled, createdAt, batteryEstCharge, quarantined, avName, avRunning, asName, fwName, isRooted, loginRequired, screenLockEnabled, screenLockDelay, autoLoginDisabled, autoTags, hasMdm, hasDesktopAgent, diskEncryptionEnabled, hardwareEncryptionCaps, passCodeLock, usesHardwareKeystore, androidSecurityPatchVersion, cellular, and url.

• wifi_macs (list[str] | None, default: None ) –

  Filter devices by wifi mac(s).

• serials (list[str] | None, default: None ) –

  Filter devices by serial(s).

• ids (list[str] | None, default: None ) –

  Filter devices by id(s).

• uuids (list[str] | None, default: None ) –

  Filter devices by uuid(s).

• system_types (list[str] | None, default: None ) –

  Filter devices by system type(s).

• scope (list[str] | None, default: None ) –

  Specify a scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkSmDevicesResponseItem] –

  Successful operation.

[
  {
    "id": "1284392014819",
    "name": "Miles's phone",
    "tags": [
      "tag1",
      "tag2"
    ],
    "ssid": "My SSID",
    "wifiMac": "00:11:22:33:44:55",
    "osName": "iOS 9.3.5",
    "systemModel": "iPhone",
    "uuid": "3d990628ede4c628d52",
    "serialNumber": "F5XKHEBX",
    "serial": "F5XKHEBX",
    "ip": "1.2.3.4",
    "notes": "Here's some info about my device"
  }
]

List all profiles in a network.

API documentation: getNetworkSmProfiles

Parameters:

• network_id (str) –

  Network ID.

• payload_types (list[str] | None, default: None ) –

  Filter by payload types.

Returns:

• PaginatedResponse[GetNetworkSmProfilesResponseItem] –

  Successful operation.

[
  {
    "id": "1284392014819",
    "name": "My profile",
    "description": "Some profile description",
    "scope": "withAny",
    "tags": [
      "tag1",
      "tag2"
    ],
    "payloadTypes": [
      "Vpn",
      "ManagedSettings"
    ]
  }
]

Return a target group.

API documentation: getNetworkSmTargetGroup

Parameters:

• network_id (str) –

  Network ID.

• target_group_id (str) –

  Target group ID.

• with_details (bool | None, default: None ) –

  Boolean indicating if the the ids of the devices or users scoped by the target group should be included in the response.

Returns:

• NetworkSmTargetGroupResponse –

  Successful operation.

{
  "id": "1284392014819",
  "name": "Target group name",
  "scope": "withAny",
  "tags": [
    "tag1",
    "tag2"
  ]
}

List the target groups in this network.

API documentation: getNetworkSmTargetGroups

Parameters:

• network_id (str) –

  Network ID.

• with_details (bool | None, default: None ) –

  Boolean indicating if the the ids of the devices or users scoped by the target group should be included in the response.

Returns:

• PaginatedResponse[NetworkSmTargetGroupResponse] –

  Successful operation.

[
  {
    "id": "1284392014819",
    "name": "Target group name",
    "scope": "withAny",
    "tags": [
      "tag1",
      "tag2"
    ]
  }
]

List Trusted Access Configs.

API documentation: getNetworkSmTrustedAccessConfigs

Parameters:

• network_id (str) –

  Network ID.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkSmTrustedAccessConfigsResponseItem] –

  Successful operation.

[
  {
    "id": "1284392014819",
    "ssidName": "My SSID",
    "name": "Cisco Meraki valued client",
    "scope": "withAny",
    "tags": [
      "tag1",
      "tag2"
    ],
    "timeboundType": "static",
    "sendExpirationEmails": true,
    "notifyTimeBeforeAccessEnds": 50000,
    "additionalEmailText": "test",
    "accessStartAt": "2018-02-11T00:00:00Z",
    "accessEndAt": "2018-05-12T00:00:00Z"
  }
]

List User Access Devices and its Trusted Access Connections.

API documentation: getNetworkSmUserAccessDevices

Parameters:

• network_id (str) –

  Network ID.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetNetworkSmUserAccessDevicesResponseItem] –

  Successful operation.

[
  {
    "id": "1284392014819",
    "name": "Cisco Meraki valued client",
    "systemType": "ios",
    "mac": "00:11:22:33:44:55",
    "username": "milesmeraki",
    "email": "miles@meraki.com",
    "tags": [
      "tag1",
      "tag2"
    ],
    "trustedAccessConnections": [
      {
        "trustedAccessConfigId": "1234",
        "downloadedAt": "2018-02-11T00:00:00Z",
        "scepCompletedAt": "2018-05-12T00:00:00Z",
        "lastConnectedAt": "2018-05-12T00:00:00Z"
      }
    ]
  }
]

Get the profiles associated with a user.

API documentation: getNetworkSmUserDeviceProfiles

Parameters:

• network_id (str) –

  Network ID.

• user_id (str) –

  User ID.

Returns:

• PaginatedResponse[GetNetworkSmDeviceDeviceProfilesResponseItem] –

  Successful operation.

[
  {
    "deviceId": "1234",
    "id": "1284392014819",
    "isEncrypted": true,
    "isManaged": true,
    "profileData": "{}",
    "profileIdentifier": "com.test.app",
    "name": "My profile",
    "version": "0.0.1"
  }
]

Get a list of softwares associated with a user.

API documentation: getNetworkSmUserSoftwares

Parameters:

• network_id (str) –

  Network ID.

• user_id (str) –

  User ID.

Returns:

• PaginatedResponse[GetNetworkSmDeviceSoftwaresResponseItem] –

  Successful operation.

[
  {
    "appId": "1234",
    "bundleSize": 1024,
    "createdAt": "2018-02-11T00:00:00Z",
    "deviceId": "1234",
    "dynamicSize": 2048,
    "id": "1284392014819",
    "identifier": "com.test.app",
    "installedAt": "2018-05-12T00:00:00Z",
    "toInstall": true,
    "iosRedemptionCode": false,
    "isManaged": true,
    "itunesId": "1234",
    "licenseKey": "Z21234567890",
    "name": "My app",
    "path": "/Path/to/app.app",
    "redemptionCode": 1234,
    "shortVersion": "1.1",
    "status": "Managed",
    "toUninstall": false,
    "uninstalledAt": "2018-02-11T00:00:00Z",
    "updatedAt": "2018-05-12T00:00:00Z",
    "vendor": "Apple",
    "version": "0.1"
  }
]

List the owners in an SM network with various specified fields and filters.

API documentation: getNetworkSmUsers

Parameters:

• network_id (str) –

  Network ID.

• ids (list[str] | None, default: None ) –

  Filter users by id(s).

• usernames (list[str] | None, default: None ) –

  Filter users by username(s).

• emails (list[str] | None, default: None ) –

  Filter users by email(s).

• scope (list[str] | None, default: None ) –

  Specifiy a scope (one of all, none, withAny, withAll, withoutAny, withoutAll) and a set of tags.

Returns:

• PaginatedResponse[GetNetworkSmUsersResponseItem] –

  Successful operation.

[
  {
    "id": "1234",
    "email": "miles@meraki.com",
    "fullName": "Miles Meraki",
    "username": "",
    "hasPassword": false,
    "tags": " tag1 tag2 ",
    "adGroups": [],
    "azureAdGroups": [],
    "samlGroups": [],
    "asmGroups": [],
    "isExternal": false,
    "displayName": "Miles Meraki <miles@meraki.com>",
    "hasIdentityCertificate": false,
    "userThumbnail": "https://s3.amazonaws.com/image.extension"
  }
]

Return a Limited Access Role.

API documentation: getOrganizationSmAdminsRole

Parameters:

• organization_id (str) –

  Organization ID.

• role_id (str) –

  Role ID.

Returns:

• OrganizationSmAdminsRoleResponse –

  Successful operation.

{
  "roleId": "1284392014819",
  "name": "sample name",
  "scope": "all_tags",
  "tags": [
    "tag"
  ]
}

List the Limited Access Roles for an organization.

API documentation: getOrganizationSmAdminsRoles

Parameters:

• organization_id (str) –

  Organization ID.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[OrganizationSmAdminsRoleResponse] –

  Successful operation.

{
  "items": [
    {
      "roleId": "1284392014819",
      "name": "sample name",
      "scope": "all_tags",
      "tags": [
        "tag"
      ]
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 10,
        "remaining": 0
      }
    }
  }
}

Get the organization's APNS certificate.

API documentation: getOrganizationSmApnsCert

Parameters:

• organization_id (str) –

  Organization ID.

Returns:

• GetOrganizationSmApnsCertResponse –

  Successful operation.

{
  "certificate": "          -----BEGIN CERTIFICATE-----\n          MIIFdjCCBF6gAwIBAgIIM/hhf5ww8MwwDQYJKoZIhvcNAQELBQAwgYwxQDA+BgNV\n          BAMMN0FwcGxlIEFwcGxpY2F0aW9uIEludGVncmF0aW9uIDIgQ2VydGlmaWNhdGlv\n          biBBdXRob3JpdHkxJjAkBgNVBAsMHUFwcGxlIENlcnRpZmljYXRpb24gQXV0aG9y\n          aXR5MRMwEQYDVQQKDApBcHBsZSBJbmMuMQswCQYDVQQGEwJVUzAeFw0yMDAyMjYx\n          ODIzNDJaFw0yMTAyMjUxODIzNDJaMIGPMUwwSgYKCZImiZPyLGQBAQw8Y29tLmFw\n          cGxlLm1nbXQuRXh0ZXJuYWwuOTA3NDJhYmYtZDhhZC00MTc2LTllZmQtMGNiMzg1\n          MTM1MGM0MTIwMAYDVQQDDClBUFNQOjkwNzQyYWJmLWQ4YWQtNDE3Ni05ZWZkLTBj\n          YjM4NTEzNTBjNDELMAkGA1UEBhMCVVMwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw\n          ggEKAoIBAQDANdpo62hfxkP1IpMPXuO1+xKekUkY+iYae6cRaP886bodUaH1OwCj\n          Qd011u9Vng6m8I9rcLdIOS+IkFGKcTAHRYY3noqfEQUPyi5TN6yM1/mVYVoWZUnY\n          TrNWqDN/HfRagdYfZyQ7kAtOY2K8TF78HLLqQm7ez2+r4qibumoSli9+qCzKwDW/\n          hbx7JTeMlbYkhLTFgBkRxlp+usKymsLKm8D7kdbxtct4mx6p9z1FiNu4U1Hi/PgK\n          I/V3zHD4Ww7SzTICiLdCPeAmt042JvXAMQi0qhzrEdDiapmWwUC9xiiORN0BTIRA\n          T+DddTx8Xcly4wj9vQFdGUGLrJnzB3xZAgMBAAGjggHVMIIB0TAJBgNVHRMEAjAA\n          MB8GA1UdIwQYMBaAFPe+fCFgkds9G3vYOjKBad+ebH+bMIIBHAYDVR0gBIIBEzCC\n          AQ8wggELBgkqhkiG92NkBQEwgf0wgcMGCCsGAQUFBwICMIG2DIGzUmVsaWFuY2Ug\n          b24gdGhpcyBjZXJ0aWZpY2F0ZSBieSBhbnkgcGFydHkgYXNzdW1lcyBhY2NlcHRh\n          bmNlIG9mIHRoZSB0aGVuIGFwcGxpY2FibGUgc3RhbmRhcmQgdGVybXMgYW5kIGNv\n          bmRpdGlvbnMgb2YgdXNlLCBjZXJ0aWZpY2F0ZSBwb2xpY3kgYW5kIGNlcnRpZmlj\n          YXRpb24gcHJhY3RpY2Ugc3RhdGVtZW50cy4wNQYIKwYBBQUHAgEWKWh0dHA6Ly93\n          d3cuYXBwbGUuY29tL2NlcnRpZmljYXRlYXV0aG9yaXR5MBMGA1UdJQQMMAoGCCsG\n          AQUFBwMCMDAGA1UdHwQpMCcwJaAjoCGGH2h0dHA6Ly9jcmwuYXBwbGUuY29tL2Fh\n          aTJjYS5jcmwwHQYDVR0OBBYEFDj4Jizt9bQX7dn3ypIanvaNIy8fMAsGA1UdDwQE\n          AwIHgDAQBgoqhkiG92NkBgMCBAIFADANBgkqhkiG9w0BAQsFAAOCAQEARmLmy4Mh\n          80hTBHMj2whrC2LR0dIe2ngAUwYGSocyPZOzlGZYntUvpsNGwflbWSPNxFpVF15z\n          exEcLPKM4f9KGdM27s/m/x1Es2us9Vve+wS+N0C84zMC++FJBIxj3yAINXqSpYJv\n          bA5wccHlzP9F9Ks7sVNQB8y0mibYahtxVV959gC4522t5SRaEEsd82oTCtXE2Ljg\n          fQ1IAmWi4MuMSPwp26oDSwun8Wxyx+sfi/it9YWxD36Ga9mrfIjK1WIHyhge0HHr\n          olnvMfxgwI9E5gGV/4bQzPlmsHdz+/pLupWMkALaAxI9D7ajUG7iyyjJBCOpsr1s\n          FjDvo6WUkaqMHA==\n          -----END CERTIFICATE-----\n"
}

List the Sentry Policies for an organization ordered in ascending order of priority.

API documentation: getOrganizationSmSentryPoliciesAssignmentsByNetwork

Parameters:

• organization_id (str) –

  Organization ID.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• network_ids (list[str] | None, default: None ) –

  Optional parameter to filter Sentry Policies by Network Id.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[GetOrganizationSmSentryPoliciesAssignmentsByNetworkResponseItem] –

  Successful operation.

[
  {
    "items": [
      {
        "networkId": "N_24329156",
        "policies": [
          {
            "policyId": "1284392014819",
            "networkId": "N_24329156",
            "smNetworkId": "N_24329156",
            "tags": [
              "tag1",
              "tag2"
            ],
            "scope": "withAny",
            "groupNumber": "1234",
            "groupPolicyId": "1284392014819",
            "priority": "1",
            "createdAt": "2018-05-12T00:00:00Z",
            "lastUpdatedAt": "2018-05-12T00:00:00Z"
          }
        ]
      }
    ],
    "meta": {
      "counts": {
        "items": {
          "total": 10,
          "remaining": 0
        }
      }
    }
  }
]

Get a hash containing the unparsed token of the VPP account with the given ID.

API documentation: getOrganizationSmVppAccount

Parameters:

• organization_id (str) –

  Organization ID.

• vpp_account_id (str) –

  Vpp account ID.

Returns:

• GetOrganizationSmVppAccountResponse –

  Successful operation.

{
  "vppAccountId": "1284392014819",
  "contentToken": "eyJleHBEYXRlIjoiMzAyMy0xMC0yMVQxMjowOTo0NSswMDAwIiwidG9rZW4iOiIvVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlQiLCJvcmdOYW1lIjoiTWVyYWtpICsgREVWRUxPUEVSIn0=",
  "email": "email@example.com",
  "name": "VPP Account name",
  "allowedAdmins": "Network",
  "networkIdAdmins": "N_24329156",
  "assignableNetworks": "Some",
  "assignableNetworkIds": [
    "N_24329156"
  ],
  "vppLocationId": "22222222222",
  "vppLocationName": "LocationName",
  "lastSyncedAt": "2021-02-25T16:59:23Z",
  "lastForceSyncedAt": "2021-02-25T16:59:23Z",
  "parsedToken": {
    "orgName": "My organization",
    "hashedToken": "f572d396fae9206628714fb2ce00f72e94f2258f",
    "expiresAt": "2023-10-21T12:09:45Z"
  },
  "id": "1284392014819",
  "vppServiceToken": "eyJleHBEYXRlIjoiMzAyMy0xMC0yMVQxMjowOTo0NSswMDAwIiwidG9rZW4iOiIvVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlQiLCJvcmdOYW1lIjoiTWVyYWtpICsgREVWRUxPUEVSIn0="
}

List the VPP accounts in the organization.

API documentation: getOrganizationSmVppAccounts

Parameters:

• organization_id (str) –

  Organization ID.

Returns:

• PaginatedResponse[GetOrganizationSmVppAccountResponse] –

  Successful operation.

[
  {
    "vppAccountId": "1284392014819",
    "contentToken": "eyJleHBEYXRlIjoiMzAyMy0xMC0yMVQxMjowOTo0NSswMDAwIiwidG9rZW4iOiIvVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlQiLCJvcmdOYW1lIjoiTWVyYWtpICsgREVWRUxPUEVSIn0=",
    "email": "email@example.com",
    "name": "VPP Account name",
    "allowedAdmins": "Network",
    "networkIdAdmins": "N_24329156",
    "assignableNetworks": "Some",
    "assignableNetworkIds": [
      "N_24329156"
    ],
    "vppLocationId": "22222222222",
    "vppLocationName": "LocationName",
    "lastSyncedAt": "2021-02-25T16:59:23Z",
    "lastForceSyncedAt": "2021-02-25T16:59:23Z",
    "parsedToken": {
      "orgName": "My organization",
      "hashedToken": "f572d396fae9206628714fb2ce00f72e94f2258f",
      "expiresAt": "2023-10-21T12:09:45Z"
    },
    "id": "1284392014819",
    "vppServiceToken": "eyJleHBEYXRlIjoiMzAyMy0xMC0yMVQxMjowOTo0NSswMDAwIiwidG9rZW4iOiIvVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlRPS0VOVE9LRU5UT0tFTlQiLCJvcmdOYW1lIjoiTWVyYWtpICsgREVWRUxPUEVSIn0="
  }
]

Install applications on a device.

API documentation: installNetworkSmDeviceApps

Parameters:

• network_id (str) –

  Network ID.

• device_id (str) –

  Device ID.

• app_ids (list[str]) –

  ids of applications to be installed.

• force (bool | None, default: None ) –

  By default, installation of an app which is believed to already be present on the device will be skipped. If you'd like to force the installation of the app, set this parameter to true.

Returns:

• DictResponse –

  Successful operation.

Lock a set of devices.

API documentation: lockNetworkSmDevices

Parameters:

• network_id (str) –

  Network ID.

• wifi_macs (list[str] | None, default: None ) –

  The wifiMacs of the devices to be locked.

• ids (list[str] | None, default: None ) –

  The ids of the devices to be locked.

• serials (list[str] | None, default: None ) –

  The serials of the devices to be locked.

• scope (list[str] | None, default: None ) –

  The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be locked.

• pin (int | None, default: None ) –

  The pin number for locking macOS devices (a six digit number). Required only for macOS devices.

Returns:

• NetworkSmDevicesResponse –

  Successful operation.

{
  "ids": [
    "1284392014819",
    "2983092129865"
  ]
}

Add, delete, or update the tags of a set of devices.

API documentation: modifyNetworkSmDevicesTags

Parameters:

• network_id (str) –

  Network ID.

• wifi_macs (list[str] | None, default: None ) –

  The wifiMacs of the devices to be modified.

• ids (list[str] | None, default: None ) –

  The ids of the devices to be modified.

• serials (list[str] | None, default: None ) –

  The serials of the devices to be modified.

• scope (list[str] | None, default: None ) –

  The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be modified.

• tags (list[str]) –

  The tags to be added, deleted, or updated.

• update_action (str) –

  One of add, delete, or update. Only devices that have been modified will be returned.

Returns:

• ModifyNetworkSmDevicesTagsResponse –

  Successful operation.

[
  {
    "id": "1284392014819",
    "tags": [
      "tag1",
      "tag2"
    ],
    "wifiMac": "00:11:22:33:44:55",
    "serial": "F5XKHEBX"
  }
]

Move a set of devices to a new network.

API documentation: moveNetworkSmDevices

Parameters:

• network_id (str) –

  Network ID.

• wifi_macs (list[str] | None, default: None ) –

  The wifiMacs of the devices to be moved.

• ids (list[str] | None, default: None ) –

  The ids of the devices to be moved.

• serials (list[str] | None, default: None ) –

  The serials of the devices to be moved.

• scope (list[str] | None, default: None ) –

  The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the devices to be moved.

• new_network (str) –

  The new network to which the devices will be moved.

Returns:

• MoveNetworkSmDevicesResponse –

  Successful operation.

{
  "ids": [
    "1284392014819",
    "2983092129865"
  ],
  "newNetwork": "1284392014819"
}

Reboot a set of endpoints.

API documentation: rebootNetworkSmDevices

Parameters:

• network_id (str) –

  Network ID.

• wifi_macs (list[str] | None, default: None ) –

  The wifiMacs of the endpoints to be rebooted.

• ids (list[str] | None, default: None ) –

  The ids of the endpoints to be rebooted.

• serials (list[str] | None, default: None ) –

  The serials of the endpoints to be rebooted.

• scope (list[str] | None, default: None ) –

  The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the endpoints to be rebooted.

• kext_paths (list[str] | None, default: None ) –

  The KextPaths of the endpoints to be rebooted. Available for macOS 11+.

• notify_user (bool | None, default: None ) –

  Whether or not to notify the user before rebooting the endpoint. Available for macOS 11.3+.

• rebuild_kernel_cache (bool | None, default: None ) –

  Whether or not to rebuild the kernel cache when rebooting the endpoint. Available for macOS 11+.

• request_requires_network_tether (bool | None, default: None ) –

  Whether or not the request requires network tethering. Available for macOS and supervised iOS or tvOS.

Returns:

• NetworkSmDevicesResponse –

  Successful operation.

{
  "ids": [
    "1284392014819",
    "2983092129865"
  ]
}

Refresh the details of a device.

API documentation: refreshNetworkSmDeviceDetails

Parameters:

• network_id (str) –

  Network ID.

• device_id (str) –

  Device ID.

Returns:

• DictResponse –

  Successful operation.

Shutdown a set of endpoints.

API documentation: shutdownNetworkSmDevices

Parameters:

• network_id (str) –

  Network ID.

• wifi_macs (list[str] | None, default: None ) –

  The wifiMacs of the endpoints to be shutdown.

• ids (list[str] | None, default: None ) –

  The ids of the endpoints to be shutdown.

• serials (list[str] | None, default: None ) –

  The serials of the endpoints to be shutdown.

• scope (list[str] | None, default: None ) –

  The scope (one of all, none, withAny, withAll, withoutAny, or withoutAll) and a set of tags of the endpoints to be shutdown.

Returns:

• NetworkSmDevicesResponse –

  Successful operation.

{
  "ids": [
    "1284392014819",
    "2983092129865"
  ]
}

Unenroll a device.

API documentation: unenrollNetworkSmDevice

Parameters:

• network_id (str) –

  Network ID.

• device_id (str) –

  Device ID.

Returns:

• UnenrollNetworkSmDeviceResponse –

  Successful operation.

{
  "success": true
}

Uninstall applications on a device.

API documentation: uninstallNetworkSmDeviceApps

Parameters:

• network_id (str) –

  Network ID.

• device_id (str) –

  Device ID.

• app_ids (list[str]) –

  ids of applications to be uninstalled.

Returns:

• DictResponse –

  Successful operation.

Modify the fields of a device.

API documentation: updateNetworkSmDevicesFields

Parameters:

• network_id (str) –

  Network ID.

• wifi_mac (str | None, default: None ) –

  The wifiMac of the device to be modified.

• id (str | None, default: None ) –

  The id of the device to be modified.

• serial (str | None, default: None ) –

  The serial of the device to be modified.

• device_fields (UpdateNetworkSmDevicesFieldsDeviceFields) –

  The new fields of the device. Each field of this object is optional.

Returns:

• UpdateNetworkSmDevicesFieldsResponse –

  Successful operation.

[
  {
    "id": "1284392014819",
    "name": "Miles's phone",
    "wifiMac": "00:11:22:33:44:55",
    "serial": "F5XKHEBX",
    "notes": "Here's some info about my device"
  }
]

Update a target group.

API documentation: updateNetworkSmTargetGroup

Parameters:

• network_id (str) –

  Network ID.

• target_group_id (str) –

  Target group ID.

• name (str | None, default: None ) –

  The name of this target group.

• scope (str | None, default: None ) –

  The scope and tag options of the target group. Comma separated values beginning with one of withAny, withAll, withoutAny, withoutAll, all, none, followed by tags. Default to none if empty.

Returns:

• NetworkSmTargetGroupResponse –

  Successful operation.

{
  "id": "1284392014819",
  "name": "Target group name",
  "scope": "withAny",
  "tags": [
    "tag1",
    "tag2"
  ]
}

Update a Limited Access Role.

API documentation: updateOrganizationSmAdminsRole

Parameters:

• organization_id (str) –

  Organization ID.

• role_id (str) –

  Role ID.

• name (str | None, default: None ) –

  The name of the Limited Access Role.

• scope (UpdateOrganizationSmAdminsRoleScope | None, default: None ) –

  The scope of the Limited Access Role.

• tags (list[str] | None, default: None ) –

  The tags of the Limited Access Role.

Returns:

• OrganizationSmAdminsRoleResponse –

  Successful operation.

{
  "roleId": "1284392014819",
  "name": "sample name",
  "scope": "all_tags",
  "tags": [
    "tag"
  ]
}

Update an Organizations Sentry Policies using the provided list.

API documentation: updateOrganizationSmSentryPoliciesAssignments

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[UpdateOrganizationSmSentryPoliciesAssignmentsItemsItem]) –

  Sentry Group Policies for the Organization keyed by Network Id.

Returns:

• UpdateOrganizationSmSentryPoliciesAssignmentsResponse –

  Successful operation.

{
  "items": [
    {
      "networkId": "N_24329156",
      "policies": [
        {
          "policyId": "1284392014819",
          "networkId": "N_24329156",
          "smNetworkId": "N_24329156",
          "tags": [
            "tag1",
            "tag2"
          ],
          "scope": "withAny",
          "groupNumber": "1234",
          "groupPolicyId": "1284392014819",
          "priority": "1",
          "createdAt": "2018-05-12T00:00:00Z",
          "lastUpdatedAt": "2018-05-12T00:00:00Z"
        }
      ]
    }
  ]
}

Wipe a device.

API documentation: wipeNetworkSmDevices

Parameters:

• network_id (str) –

  Network ID.

• wifi_mac (str | None, default: None ) –

  The wifiMac of the device to be wiped.

• id (str | None, default: None ) –

  The id of the device to be wiped.

• serial (str | None, default: None ) –

  The serial of the device to be wiped.

• pin (int | None, default: None ) –

  The pin number (a six digit value) for wiping a macOS device. Required only for macOS devices.

Returns:

• WipeNetworkSmDevicesResponse –

  Successful operation.

{
  "id": "1284392014819"
}