Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Identity

A container object for identity attributes.

Example:

----- { \"principalName\": \"ExampleName\", \"principalId\": \"ocid1.user.oc1..\", \"authType\": \"natv\", \"callerName\": null, \"callerId\": null, \"tenantId\": \"ocid1.tenancy.oc1..\", \"ipAddress\": \"172.24.80.88\", \"credentials\": null, \"userAgent\": \"Jersey/2.23 (HttpUrlConnection 1.8.0_212)\", \"consoleSessionId\": null } -----

Properties

Optional authType

authType: undefined | string

The type of authentication used.

Example: `natv`

Optional callerId

callerId: undefined | string

The OCID of the caller. The caller that made a request on behalf of the prinicpal.

Optional callerName

callerName: undefined | string

The name of the user or service. This value is the friendly name associated with callerId.

Optional consoleSessionId

consoleSessionId: undefined | string

This value identifies any Console session associated with this request.

Optional credentials

credentials: undefined | string

The credential ID of the user. This value is extracted from the HTTP 'Authorization' request header. It consists of the tenantId, userId, and user fingerprint, all delimited by a slash (/).

Optional ipAddress

ipAddress: undefined | string

The IP address of the source of the request.

Example: `172.24.80.88`

Optional principalId

principalId: undefined | string

The OCID of the principal.

Optional principalName

principalName: undefined | string

The name of the user or service. This value is the friendly name associated with principalId.

Example: `ExampleName`

Optional tenantId

tenantId: undefined | string

The OCID of the tenant.

Optional userAgent

userAgent: undefined | string

The user agent of the client that made the request.

Example: `Jersey/2.23 (HttpUrlConnection 1.8.0_212)`

Functions

getJsonObj