Documentation

SmDevicesForKeyApi

SmDevicesForKeyApi 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
getNetworkPiiSmDevicesForKey()  : object
Operation getNetworkPiiSmDevicesForKey
getNetworkPiiSmDevicesForKeyAsync()  : PromiseInterface
Operation getNetworkPiiSmDevicesForKeyAsync
getNetworkPiiSmDevicesForKeyAsyncWithHttpInfo()  : PromiseInterface
Operation getNetworkPiiSmDevicesForKeyAsyncWithHttpInfo
getNetworkPiiSmDevicesForKeyWithHttpInfo()  : array<string|int, mixed>
Operation getNetworkPiiSmDevicesForKeyWithHttpInfo
createHttpClientOption()  : array<string|int, mixed>
Create http client option
getNetworkPiiSmDevicesForKeyRequest()  : Request
Create request for operation 'getNetworkPiiSmDevicesForKey'

Properties

Methods

getNetworkPiiSmDevicesForKey()

Operation getNetworkPiiSmDevicesForKey

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

Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that 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

getNetworkPiiSmDevicesForKeyAsync()

Operation getNetworkPiiSmDevicesForKeyAsync

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

Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that 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

getNetworkPiiSmDevicesForKeyAsyncWithHttpInfo()

Operation getNetworkPiiSmDevicesForKeyAsyncWithHttpInfo

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

Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that 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

getNetworkPiiSmDevicesForKeyWithHttpInfo()

Operation getNetworkPiiSmDevicesForKeyWithHttpInfo

public getNetworkPiiSmDevicesForKeyWithHttpInfo(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>

Given a piece of Personally Identifiable Information (PII), return the Systems Manager device ID(s) associated with that 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

getNetworkPiiSmDevicesForKeyRequest()

Create request for operation 'getNetworkPiiSmDevicesForKey'

protected getNetworkPiiSmDevicesForKeyRequest(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