Pii

Module: Pii

Members

Methods

Personal Idetifying Information

pii.js:5
pii.js:5

Methods

pii.js:305

(static) deletePiiRequest(orgId, piiId) → {Promise}

Delete a restrict processing PII request

Examples

Example request

meraki.deletePiiRequest(orgId).then((res) => {
 console.log(res);
});

Example response

        Successful HTTP Status: 204
Parameters
Name Type Description
orgId string
piiId string
Returns

A promise holding the status code, 204 for success

Type
Promise
pii.js:62

(static) getPiiKeys(orgId, pii, value) → {Promise}

List the keys required to access Personally Identifiable Information (PII) for a given identifier. Exactly one identifier will be accepted. If the organization contains org-wide Systems Manager users matching the key provided then there will be an entry with the key "0" containing the applicable keys. PARAMETERS username The username of a Systems Manager user email The email of a network user account or a Systems Manager device mac The MAC of a network client device or a Systems Manager device serial The serial of a Systems Manager device imei The IMEI of a Systems Manager device

Examples

Example request

      meraki.getPiiKeys(orgId, pii).then((res) => {
        console.log(res);
      });

Example response

    Successful HTTP Status: 200
        {
        [networkId]:{
            "macs":[
            "00:77:00:77:00:77"
            ],
            "emails":[
            "fake@example.com"
            ],
            "usernames":[
            "fakename"
            ],
            "serials":[
            "abcd1234"
            ],
            "imei":[
            990000862471854
            ]
        }
        }
Parameters
Name Type Description
orgId string
pii string
value string
Returns

A promise holding the PII keys

Type
Promise
pii.js:213

(static) getPiiRequest(orgId, piiId) → {Promise}

Return a PII request

Examples

Example request

        meraki.getPiiRequest(orgId, piiId).then((res) => {
            console.log(res.data);
        });

Example response

        {
        "id": "1234",
        "organizationWide": false,
        "networkId": "N_1234",
        "type": "delete",
        "mac": "00:77:00:77:00:77",
        "datasets": "['usage', 'events']",
        "createdAt": 1524692227,
        "completedAt": 1524702227
        }
Parameters
Name Type Description
orgId string
piiId string
Returns

A promise holding the PII requests for a pii ID

Type
Promise
pii.js:181

(static) getPiiRequests(orgId) → {Promise}

List the PII requests for this organization

Examples

Example request

      meraki.getPiiRequests(orgId).then((res) => {
       console.log(res);
      });

Example response

        [
        {
            "id": "1234",
            "organizationWide": false,
            "networkId": "N_1234",
            "type": "delete",
            "mac": "00:77:00:77:00:77",
            "datasets": "['usage', 'events']",
            "createdAt": 1524692227,
            "completedAt": 1524702227
        }
        ]
Parameters
Name Type Description
orgId string
Returns

A promise holding the PII requests for an organization

Type
Promise
pii.js:99

(static) getSmDevicesForKey(orgId, pii, value) → {Promise}

Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that identifier. These device IDs can be used with the Systems Manager API endpoints to retrieve device details. Exactly one identifier will be accepted.

Examples

Example request

PARAMETERS
        username
        The username of a Systems Manager user
        email
        The email of a network user account or a Systems Manager device
        mac
        The MAC of a network client device or a Systems Manager device
        serial
        The serial of a Systems Manager device
        imei
        The IMEI of a Systems Manager device

meraki.getSmDevicesForKey(orgId, pii, value).then((res) => {
 console.log(res.data);
});

Example response

        {
        [networkId]:["1099541095293", "8348382288234"]
        }
Parameters
Name Type Description
orgId string
pii string
value string
Returns

A promise holding the device identifier

Type
Promise
pii.js:141

(static) getSmOwnersForKey(orgId, pii, value) → {Promise}

Given a piece of Personally Identifiable Information (PII), return the Systems Manager owner ID(s) associated with that identifier. These owner IDs can be used with the Systems Manager API endpoints to retrieve owner details. Exactly one identifier will be accepted.

Examples

Example request

PARAMETERS
        username
        The username of a Systems Manager user
        email
        The email of a network user account or a Systems Manager device
        mac
        The MAC of a network client device or a Systems Manager device
        serial
        The serial of a Systems Manager device
        imei
        The IMEI of a Systems Manager device

meraki.getSmOwnersForKey(orgId, pii, value).then((res) => {
 console.log(res.data);
});

Example response

        {
            [networkId]:["1099541095293"]
        }
Parameters
Name Type Description
orgId string
pii string
value string
Returns

A promise holding the Systems Manager owner ID(s) associated with that identifier.

Type
Promise
pii.js:280

(static) submitPiiRequest(orgId, options) → {Promise}

Submit a new delete or restrict processing PII request

Options type One of "delete" or "restrict processing"

datasets The datasets related to the provided key that should be deleted. Only applies to "delete" requests. The value "all" will be expanded to all datasets applicable to this pii_type.

username The username of a network log in. Only applies to "delete" requests.

email The email of a network user account. Only applies to "delete" requests.

mac The MAC of a network client device. Applies to both "restrict processing" and "delete" requests.

smDeviceId The sm_device_id of a Systems Manager device. The only way to "restrict processing" or "delete" a Systems Manager device. Must include "device" in the dataset for a "delete" request to destroy the device.

smUserId The sm_user_id of a Systems Manager user. The only way to "restrict processing" or "delete" a Systems Manager user. Must include "user" in the dataset for a "delete" request to destroy the user.

Examples

Example request

    const options = { 
        "type":"delete", 
        "datasets":"["usage","events"]",
        "mac":"00:77:00:77:00:77"
    }

    meraki.submitPiiRequest(orgId, options).then((res) => {
      console.log(res.data);
     });

Example response

        {
            "id": "1234",
            "organizationWide": false,
            "networkId": "N_1234",
            "type": "delete",
            "mac": "00:77:00:77:00:77",
            "datasets": "['usage', 'events']",
            "status": "in progress"
        }
Parameters
Name Type Description
orgId string
options options
Returns

A promise holding the PII request and status

Type
Promise