Documentation

PiiKeysApi

PiiKeysApi Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Table of Contents

$client  : ClientInterface
$config  : Configuration
$headerSelector  : HeaderSelector
__construct()  : mixed
getConfig()  : Configuration
getNetworkPiiPiiKeys()  : object
Operation getNetworkPiiPiiKeys
getNetworkPiiPiiKeysAsync()  : PromiseInterface
Operation getNetworkPiiPiiKeysAsync
getNetworkPiiPiiKeysAsyncWithHttpInfo()  : PromiseInterface
Operation getNetworkPiiPiiKeysAsyncWithHttpInfo
getNetworkPiiPiiKeysWithHttpInfo()  : array<string|int, mixed>
Operation getNetworkPiiPiiKeysWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option
getNetworkPiiPiiKeysRequest()  : Request
Create request for operation 'getNetworkPiiPiiKeys'

Properties

Methods

getNetworkPiiPiiKeys()

Operation getNetworkPiiPiiKeys

public getNetworkPiiPiiKeys(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : object

List the keys required to access Personally Identifiable Information (PII) for a given identifier

Parameters
$network_id : string

network_id (required)

$username : string = null

The username of a Systems Manager user (optional)

$email : string = null

The email of a network user account or a Systems Manager device (optional)

$mac : string = null

The MAC of a network client device or a Systems Manager device (optional)

$serial : string = null

The serial of a Systems Manager device (optional)

$imei : string = null

The IMEI of a Systems Manager device (optional)

$bluetooth_mac : string = null

The MAC of a Bluetooth client (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
object

getNetworkPiiPiiKeysAsync()

Operation getNetworkPiiPiiKeysAsync

public getNetworkPiiPiiKeysAsync(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : PromiseInterface

List the keys required to access Personally Identifiable Information (PII) for a given identifier

Parameters
$network_id : string

(required)

$username : string = null

The username of a Systems Manager user (optional)

$email : string = null

The email of a network user account or a Systems Manager device (optional)

$mac : string = null

The MAC of a network client device or a Systems Manager device (optional)

$serial : string = null

The serial of a Systems Manager device (optional)

$imei : string = null

The IMEI of a Systems Manager device (optional)

$bluetooth_mac : string = null

The MAC of a Bluetooth client (optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getNetworkPiiPiiKeysAsyncWithHttpInfo()

Operation getNetworkPiiPiiKeysAsyncWithHttpInfo

public getNetworkPiiPiiKeysAsyncWithHttpInfo(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : PromiseInterface

List the keys required to access Personally Identifiable Information (PII) for a given identifier

Parameters
$network_id : string

(required)

$username : string = null

The username of a Systems Manager user (optional)

$email : string = null

The email of a network user account or a Systems Manager device (optional)

$mac : string = null

The MAC of a network client device or a Systems Manager device (optional)

$serial : string = null

The serial of a Systems Manager device (optional)

$imei : string = null

The IMEI of a Systems Manager device (optional)

$bluetooth_mac : string = null

The MAC of a Bluetooth client (optional)

Tags
throws
InvalidArgumentException
Return values
PromiseInterface

getNetworkPiiPiiKeysWithHttpInfo()

Operation getNetworkPiiPiiKeysWithHttpInfo

public getNetworkPiiPiiKeysWithHttpInfo(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : array<string|int, mixed>

List the keys required to access Personally Identifiable Information (PII) for a given identifier

Parameters
$network_id : string

(required)

$username : string = null

The username of a Systems Manager user (optional)

$email : string = null

The email of a network user account or a Systems Manager device (optional)

$mac : string = null

The MAC of a network client device or a Systems Manager device (optional)

$serial : string = null

The serial of a Systems Manager device (optional)

$imei : string = null

The IMEI of a Systems Manager device (optional)

$bluetooth_mac : string = null

The MAC of a Bluetooth client (optional)

Tags
throws
ApiException

on non-2xx response

throws
InvalidArgumentException
Return values
array<string|int, mixed>

of object, HTTP status code, HTTP response headers (array of strings)

createHttpClientOption()

Create http client option

protected createHttpClientOption() : array<string|int, mixed>
Tags
throws
RuntimeException

on file opening failure

Return values
array<string|int, mixed>

of http client options

getNetworkPiiPiiKeysRequest()

Create request for operation 'getNetworkPiiPiiKeys'

protected getNetworkPiiPiiKeysRequest(string $network_id[, string $username = null ][, string $email = null ][, string $mac = null ][, string $serial = null ][, string $imei = null ][, string $bluetooth_mac = null ]) : Request
Parameters
$network_id : string

(required)

$username : string = null

The username of a Systems Manager user (optional)

$email : string = null

The email of a network user account or a Systems Manager device (optional)

$mac : string = null

The MAC of a network client device or a Systems Manager device (optional)

$serial : string = null

The serial of a Systems Manager device (optional)

$imei : string = null

The IMEI of a Systems Manager device (optional)

$bluetooth_mac : string = null

The MAC of a Bluetooth client (optional)

Tags
throws
InvalidArgumentException
Return values
Request

Search results