Documentation

IclFields
in package

Holds metadata to pass to the Tenant Security Proxy for logging purposes.

Table of Contents

$dataLabel  : string
$objectId  : string
$requestId  : string
$requestingId  : string
$sourceIp  : string
__construct()  : mixed

Properties

$dataLabel

public string $dataLabel

(Optional) Classification of data being processed

$objectId

public string $objectId

(Optional) ID of the object/document being acted on in the host system

$requestId

public string $requestId

(Optional) Unique ID that ties application request ID to Tenant Security Proxy logs

$requestingId

public string $requestingId

(Required) Unique ID of user/service that is processing data

$sourceIp

public string $sourceIp

(Optional) IP address of the initiator of this document request

Methods

__construct()

public __construct(string $requestingId[, string $dataLabel = null ][, string $sourceIp = null ][, string $objectId = null ][, string $requestId = null ]) : mixed
Parameters
$requestingId : string

(Required) Unique ID of user/service that is processing data

$dataLabel : string = null

(Optional) Classification of data being processed

$sourceIp : string = null

(Optional) IP address of the initiator of this document request

$objectId : string = null

(Optional) ID of the object/document being acted on in the host system

$requestId : string = null

(Optional) Unique ID that ties application request ID to Tenant Security Proxy logs

Return values
mixed

Search results