Audit
Note
This Class is not meant to be instantiated directly, but rather accessed through the audit Property on an
instance of Client. For more details, see the Guide.
list_users
list_users(search_pattern: str | None = None) -> list[User]Lists all the Users in the authenticated users default tenant.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
search_pattern
|
str | None
|
Optional filter for users. When provided, case-insensitive matches users with emails containing this string. When None (default), returns all users. |
None
|
Returns:
| Type | Description |
|---|---|
list[User]
|
The List of Users. |
get_user
get_user(user_id: str = 'me') -> UserRetrieves information about the specified user, or the authenticated user if none specified.
Returns:
| Type | Description |
|---|---|
User
|
The requested or currently authenticated User. |
get_events
get_events(days_into_past: int = 30, event_type: Event = 'all') -> listGet audit events from Anaplan Audit API.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
days_into_past
|
int
|
The nuber of days into the past to get events for. The API provides data for up to 30 days. |
30
|
event_type
|
Event
|
The type of events to get. |
'all'
|
Returns:
| Type | Description |
|---|---|
list
|
A list of audit events. |