SUsuperwall
Audit Logs V2

Retrieve Audit Log Entry

Changed on

Retrieves a single audit log entry by id within the specified organization. Requires audit_logs:read scope.

get/v2/audit-logs/{id}

Request

  • Base URL
    https://api.superwall.com
  • URL
    https://api.superwall.com/v2/audit-logs/{id}
  • Auth
    • HTTP bearer
    • or API key in cookie accounts_superwall_token
    • or HTTP bearer

Path parameters

idstring required

Audit log entry id (UUID)

Query parameters

organization_idstring required

Response

AuditLogEntryWithActor

idstring required

Unique audit log entry id (UUID)

object'audit_log_entry' required

Object type, always audit_log_entry

timestampstring required

ISO 8601 timestamp of when the request was served

request_idstring required

Request identifier (x-request-id header, or auto-generated UUID)

route_family'public_v2' | 'internal_v2' required

Which route family served the request

methodstring required

HTTP method

request_urlstring required

Full request URL with query string

pathstring required

URL path with query string

endpoint_idstring nullable required

Resolved OpenAPI endpoint name (e.g. listPaywalls)

auth_method'api_key' | 'cookie' | 'oauth' | 'agent_token' | 'service_token' | 'delegated_service_token' | 'workspace_token' nullable required

Authentication method used

attempted_auth_method'api_key' | 'cookie' | 'oauth' | 'agent_token' | 'service_token' | 'delegated_service_token' | 'workspace_token' nullable required

Authentication method used

user_idnumber nullable required

User id if authenticated via cookie/oauth

token_idinteger nullable required

API token id if authenticated via api_key

token_namestring nullable required

Credential label at time of request

service_principal_idinteger nullable required

Service principal id if authenticated via service_token or delegated_service_token. For delegated requests user_id is the user the service acted for.

organization_idinteger nullable required

Organization the request was scoped to

authorizedboolean required

Whether the request cleared authn + authz checks

status_codenumber required

HTTP response status code

failure_stage'authn' | 'authz' nullable required

Stage at which the request was rejected, if any

failure_codestring nullable required

Machine-readable failure code (e.g. MissingApiKey, insufficient_scope)

mutationboolean required

Whether the endpoint mutates state (POST/PUT/PATCH/DELETE except read endpoints)

resource_typestring nullable required

Resource type touched by the mutation (e.g. paywall, product), if known

resource_idstring nullable required

Stringified id of the resource touched by the mutation, if known

ip_addressstring nullable required

Client IP address the request originated from

countrystring nullable required

ISO-3166 country code resolved from the client IP

citystring nullable required

City resolved from the client IP, if available

regionstring nullable required

Region/state resolved from the client IP, if available

timezonestring nullable required

IANA timezone resolved from the client IP, if available

user_agentstring nullable required

Raw User-Agent header of the request

session_idstring nullable required

Identifier of the login session (OAuth sid/jti claim). Groups every entry from one session. Null for api_key and cookie auth.

Changes

  • 778a11cd2c15Revision changes
    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the response body anyOf list for the response status

  • 7e65bcbd2cceRevision changes
    • warning

      added the new workspace_token enum value to the / response property for the response status

    • warning

      added the new workspace_token enum value to the / response property for the response status