kustomer-client
Preparing search index...
KustomerApi
getAuditLogs
Function getAuditLogs
getAuditLogs
<
ThrowOnError
extends
boolean
=
true
>
(
options
:
Options
<
GetAuditLogsData
,
ThrowOnError
>
,
)
:
RequestResult
<
{
data
:
{
attributes
:
{
changes
?:
{
attributes
?:
{
[
key
:
string
]:
unknown
}
;
relationships
?:
{
[
key
:
string
]:
unknown
}
;
}
;
client
?:
string
;
createdAt
?:
string
;
eventName
:
string
;
eventVerb
:
string
;
expiresAt
?:
string
;
ip
?:
string
;
objectId
?:
string
;
objectType
?:
string
;
org
:
string
;
publishedAt
?:
string
;
userId
?:
string
;
userType
?:
string
;
}
;
id
:
string
;
links
:
{
first
:
string
;
next
:
string
;
previous
:
string
;
self
:
string
}
;
relationships
:
{
user
:
{
data
:
{
id
:
string
;
type
:
string
}
;
links
:
{
self
:
string
}
}
;
}
;
type
:
string
;
}
;
}
,
unknown
,
ThrowOnError
,
>
Query events associated with your organization
Legacy Role
Equivalent Permission Set Role
org.user.audit_logs.read
org.permission.audit_logs.read
Type Parameters
ThrowOnError
extends
boolean
=
true
Parameters
options
:
Options
<
GetAuditLogsData
,
ThrowOnError
>
Returns
RequestResult
<
{
data
:
{
attributes
:
{
changes
?:
{
attributes
?:
{
[
key
:
string
]:
unknown
}
;
relationships
?:
{
[
key
:
string
]:
unknown
}
;
}
;
client
?:
string
;
createdAt
?:
string
;
eventName
:
string
;
eventVerb
:
string
;
expiresAt
?:
string
;
ip
?:
string
;
objectId
?:
string
;
objectType
?:
string
;
org
:
string
;
publishedAt
?:
string
;
userId
?:
string
;
userType
?:
string
;
}
;
id
:
string
;
links
:
{
first
:
string
;
next
:
string
;
previous
:
string
;
self
:
string
}
;
relationships
:
{
user
:
{
data
:
{
id
:
string
;
type
:
string
}
;
links
:
{
self
:
string
}
}
;
}
;
type
:
string
;
}
;
}
,
unknown
,
ThrowOnError
,
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
kustomer-client
Loading...
Query events associated with your organization