Identity

class oci.audit.models.Identity(**kwargs)

Bases: object

A container object for identity attributes.

Example:

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

__init__(**kwargs)

Initializes a new Identity object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • principal_name (str) -- The value to assign to the principal_name property of this Identity.
  • principal_id (str) -- The value to assign to the principal_id property of this Identity.
  • auth_type (str) -- The value to assign to the auth_type property of this Identity.
  • caller_name (str) -- The value to assign to the caller_name property of this Identity.
  • caller_id (str) -- The value to assign to the caller_id property of this Identity.
  • tenant_id (str) -- The value to assign to the tenant_id property of this Identity.
  • ip_address (str) -- The value to assign to the ip_address property of this Identity.
  • credentials (str) -- The value to assign to the credentials property of this Identity.
  • user_agent (str) -- The value to assign to the user_agent property of this Identity.
  • console_session_id (str) -- The value to assign to the console_session_id property of this Identity.
auth_type

Gets the auth_type of this Identity. The type of authentication used.

Example: natv

Returns:The auth_type of this Identity.
Return type:str
caller_id

Gets the caller_id of this Identity. The OCID of the caller. The caller that made a request on behalf of the prinicpal.

Returns:The caller_id of this Identity.
Return type:str
caller_name

Gets the caller_name of this Identity. The name of the user or service. This value is the friendly name associated with callerId.

Returns:The caller_name of this Identity.
Return type:str
console_session_id

Gets the console_session_id of this Identity. This value identifies any Console session associated with this request.

Returns:The console_session_id of this Identity.
Return type:str
credentials

Gets the credentials of this Identity. 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 (/).

Returns:The credentials of this Identity.
Return type:str
ip_address

Gets the ip_address of this Identity. The IP address of the source of the request.

Example: 172.24.80.88

Returns:The ip_address of this Identity.
Return type:str
principal_id

Gets the principal_id of this Identity. The OCID of the principal.

Returns:The principal_id of this Identity.
Return type:str
principal_name

Gets the principal_name of this Identity. The name of the user or service. This value is the friendly name associated with principalId.

Example: ExampleName

Returns:The principal_name of this Identity.
Return type:str
tenant_id

Gets the tenant_id of this Identity. The OCID of the tenant.

Returns:The tenant_id of this Identity.
Return type:str
user_agent

Gets the user_agent of this Identity. The user agent of the client that made the request.

Example: Jersey/2.23 (HttpUrlConnection 1.8.0_212)

Returns:The user_agent of this Identity.
Return type:str