# Get all audit logs

Endpoint: GET /audit-logs
Version: 5.1.42
Security: api_key

## Query parameters:

  - `user_name` (string)
    The name of the user that took the action for this entry.

  - `action_type` (string)
    The type of action that occurred for this Audit Log entry.
    Enum: "CANCEL", "CREATE", "CONFIG_INSTALL", "CONNECT", "DELETE", "DISCONNECT", "EDIT", "EXPORT", "FORGOT_PASSWORD", "GET", "GET_ALL", "IMPORT", "LOCK", "DISABLE", "LOGIN", "LOGOUT", "RESET_PASSWORD", "RUN", "TEST", "UNLOCK"

  - `target` (string)
    The type object or operation that the action occurred on for this Audit Log entry.
    Enum: "ALGORITHM", "ANALYTIC", "APPLICATION", "APPLICATION_LOG", "APPLICATION_SETTING", "ASYNC_TASK", "AUDIT_LOG", "BILLING_PERIOD", "BILLING_REPORT", "BILLING_USAGE", "CLASSIFIER", "COLUMN_METADATA", "CREDENTIAL_PATH", "DATABASE_CONNECTOR", "DATABASE_RULESET", "DATABASE_USAGE", "DEBUG_BREAKPOINT", "DOMAIN", "ENCRYPTION_KEY", "ENVIRONMENT", "EXECUTION", "EXECUTION_COMPONENT_LOG", "EXECUTION_EVENT", "EXECUTION_LOG", "EXECUTION_REPORT", "FILE_CONNECTOR", "FILE_DOWNLOAD", "FILE_FIELD_METADATA", "FILE_FORMAT", "FILE_METADATA", "FILE_RULESET", "FILE_UPLOAD", "INSTALLATION", "INVENTORY_APPROVAL", "JDBC_DRIVER", "JOB_TASK", "JOB_UTILIZATION_REPORT", "KNOWLEDGE_BASE_INFO", "LDAP", "LICENSE", "MAINFRAME_DATASET_CONNECTOR", "MAINFRAME_DATASET_FIELD_METADATA", "MAINFRAME_DATASET_FORMAT", "MAINFRAME_DATASET_METADATA", "MAINFRAME_DATASET_RECORD_TYPE", "MAINFRAME_DATASET_RULESET", "MASKING_JOB", "MONITOR_JOBS_INFORMATION", "MONITOR_TASK", "MOUNT_FILESYSTEM", "NON_CONFORMING_DATA_SAMPLE", "OAUTH2", "PASSWORD_VAULT", "PLUGIN", "PROFILE_EXPRESSION", "PROFILE_TYPE_EXPRESSION", "PROFILE_JOB", "PROFILE_RESULT", "PROFILE_SET", "RECORD_TYPE", "RECORD_TYPE_QUALIFIER", "REIDENTIFICATION_JOB", "ROLE", "SSH_KEY", "SSO", "SUPPORT_BUNDLE", "SYNCABLE_OBJECT", "SYSTEM_INFORMATION", "TABLE_METADATA", "TASK", "TOKENIZATION_JOB", "UNIFIED_AUTH", "USER"

  - `status` (string)
    The status of the action that occurred for this Audit Log entry. This can change over time as ATTEMPTED actions are completed.
    Enum: "ATTEMPTED", "FAILED", "SUCCEEDED"

  - `start_time` (string)
    The date after which all audit logs should be retrieved. Note that the format of the string should be the same date-time format as in the response bodies.

  - `end_time` (string)
    The date before which all audit logs should be retrieved. Note that the format of the string should be the same date-time format as in the response bodies.

  - `search_string` (string)
    Search for activity description containing substring.

  - `sort_by` (string)
    Sort by field.
    Enum: "activityTime", "userName", "status", "activityDescription", "identity"

  - `sort_dir` (string)
    Sort by direction.
    Enum: "asc", "desc"

  - `page_number` (integer)
    The page number for which to get logs. This will default to the first page if excluded

  - `page_size` (integer)
    The maximum number of objects to return. This will default to the DefaultApiPageSize setting if not provided

## Response 201 fields (application/json):

  - `_pageInfo` (object)

  - `_pageInfo.numberOnPage` (integer)
    The number of items on this page. This should always match the page size unless it is the last page.

  - `_pageInfo.total` (integer)
    The total number of items

  - `responseList` (array)
    Example: [{"userName":"maskingUser","activityDescription":"Created Database Connector 'con' in Environment 'env'.","activityTime":"2018-11-06T04:14:46.929+0000","actionType":"CREATE","target":"DATABASE_CONNECTOR","status":"SUCCEEDED"}]

  - `responseList.auditId` (integer)
    The ID of the Audit Log. This field will be generated by the Masking Engine.

  - `responseList.userName` (string)
    The name for the user that took the action for this entry.
    Example: "maskingUser"

  - `responseList.activityDescription` (string)
    A description of the action that occurred for this Audit Log entry. This will usually include the user friendly names of the involved objects.
    Example: "Created Database Connector 'con' in Environment 'env'."

  - `responseList.activityTime` (string)
    The date and time that the action for this Audit Log entry occurred.
    Example: "2018-11-06T04:14:46.929+0000"

  - `responseList.actionType` (string)
    The type of action that occurred for this Audit Log entry.
    Enum: "CANCEL", "CREATE", "CONNECT", "CONFIG_INSTALL", "DELETE", "DISCONNECT", "EDIT", "EXPORT", "FORGOT_PASSWORD", "GET", "GET_ALL", "IMPORT", "LOCK", "DISABLE", "LOGIN", "LOGOUT", "RESET_PASSWORD", "RUN", "TEST", "UNLOCK"

  - `responseList.target` (string)
    The type object or operation that the action occurred on for this Audit Log entry.
    Enum: "ALGORITHM", "ANALYTIC", "APPLICATION", "APPLICATION_LOG", "APPLICATION_SETTING", "ASYNC_TASK", "AUDIT_LOG", "BILLING_PERIOD", "BILLING_REPORT", "BILLING_USAGE", "CLASSIFIER", "COLUMN_METADATA", "CREDENTIAL_PATH", "DATABASE_CONNECTOR", "DATABASE_RULESET", "DATABASE_USAGE", "DEBUG_BREAKPOINT", "DOMAIN", "ENCRYPTION_KEY", "ENVIRONMENT", "EXECUTION", "EXECUTION_COMPONENT_LOG", "EXECUTION_EVENT", "EXECUTION_LOG", "EXECUTION_REPORT", "FILE_CONNECTOR", "FILE_DOWNLOAD", "FILE_FIELD_METADATA", "FILE_FORMAT", "FILE_METADATA", "FILE_RULESET", "FILE_UPLOAD", "INSTALLATION", "INVENTORY_APPROVAL", "JDBC_DRIVER", "JOB_TASK", "JOB_UTILIZATION_REPORT", "KNOWLEDGE_BASE_INFO", "LDAP", "LICENSE", "MAINFRAME_DATASET_CONNECTOR", "MAINFRAME_DATASET_FIELD_METADATA", "MAINFRAME_DATASET_FORMAT", "MAINFRAME_DATASET_METADATA", "MAINFRAME_DATASET_RECORD_TYPE", "MAINFRAME_DATASET_RULESET", "MASKING_JOB", "MONITOR_JOBS_INFORMATION", "MONITOR_TASK", "MOUNT_FILESYSTEM", "NON_CONFORMING_DATA_SAMPLE", "OAUTH2", "PASSWORD_VAULT", "PLUGIN", "PROFILE_EXPRESSION", "PROFILE_TYPE_EXPRESSION", "PROFILE_JOB", "PROFILE_RESULT", "PROFILE_SET", "RECORD_TYPE", "RECORD_TYPE_QUALIFIER", "REIDENTIFICATION_JOB", "ROLE", "SSH_KEY", "SSO", "SUPPORT_BUNDLE", "SYNCABLE_OBJECT", "SYSTEM_INFORMATION", "TABLE_METADATA", "TASK", "TOKENIZATION_JOB", "UNIFIED_AUTH", "USER"

  - `responseList.status` (string)
    The status of the action that occurred for this Audit Log entry. This can change over time as ATTEMPTED actions are completed.
    Enum: "ATTEMPTED", "FAILED", "SUCCEEDED"

  - `responseList.ipAddress` (string)
    The IP address of the user who performed the action for this Audit Log entry.


## Response 401 fields