Skip to content

Commit

Permalink
[Logs]: update field reference (#18177)
Browse files Browse the repository at this point in the history
This also switches the files from `.mdx` back to `.md` since using MDX
causes us to have to escape all the `[`, `{` and `<` characters during
generation.
  • Loading branch information
cmackenzie1 authored Nov 18, 2024
1 parent a4f2d73 commit 60e6004
Show file tree
Hide file tree
Showing 20 changed files with 759 additions and 696 deletions.
Original file line number Diff line number Diff line change
@@ -1,99 +1,100 @@
---
# Code generator. DO NOT EDIT.

title: Access requests
pcx_content_type: configuration
sidebar:
order: 21

---

The descriptions below detail the fields available for `access_requests`.

## Action

Type: string
Type: `string`

What type of record is this. <em>login</em> | <em>logout</em>.
What type of record is this. <em>login</em> \| <em>logout</em>.

## Allowed

Type: bool
Type: `bool`

If request was allowed or denied.

## AppDomain

Type: string
Type: `string`

The domain of the Application that Access is protecting.

## AppUUID

Type: string
Type: `string`

Access Application UUID.

## Connection

Type: string
Type: `string`

Identity provider used for the login.

## Country

Type: string
Type: `string`

Request's country of origin.

## CreatedAt

Type: int or string
Type: `int or string`

The date and time the corresponding access request was made (for example, '2021-07-27T00:01:07Z').

## Email

Type: string
Type: `string`

Email of the user who logged in.

## IPAddress

Type: string
Type: `string`

The IP address of the client.

## PurposeJustificationPrompt

Type: string
Type: `string`

Message prompted to the client when accessing the application.

## PurposeJustificationResponse

Type: string
Type: `string`

Justification given by the client when accessing the application.

## RayID

Type: string
Type: `string`

Identifier of the request.

## TemporaryAccessApprovers

Type: array\[string]
Type: `array[string]`

List of approvers for this access request.

## TemporaryAccessDuration

Type: int
Type: `int`

Approved duration for this access request.

## UserUID

Type: string
Type: `string`

The uid of the user who logged in.
Original file line number Diff line number Diff line change
@@ -1,99 +1,100 @@
---
# Code generator. DO NOT EDIT.

title: Audit logs
pcx_content_type: configuration
sidebar:
order: 21

---

The descriptions below detail the fields available for `audit_logs`.

## ActionResult

Type: bool
Type: `bool`

Whether the action was successful.

## ActionType

Type: string
Type: `string`

Type of action taken.

## ActorEmail

Type: string
Type: `string`

Email of the actor.

## ActorID

Type: string
Type: `string`

Unique identifier of the actor in Cloudflare's system.

## ActorIP

Type: string
Type: `string`

Physical network address of the actor.

## ActorType

Type: string
Type: `string`

Type of user that started the audit trail.

## ID

Type: string
Type: `string`

Unique identifier of an audit log.

## Interface

Type: string
Type: `string`

Entry point or interface of the audit log.

## Metadata

Type: object
Type: `object`

Additional audit log-specific information. Metadata is organized in key:value pairs. Key and Value formats can vary by ResourceType.

## NewValue

Type: object
Type: `object`

Contains the new value for the audited item.

## OldValue

Type: object
Type: `object`

Contains the old value for the audited item.

## OwnerID

Type: string
Type: `string`

The identifier of the user that was acting or was acted on behalf of. If a user did the action themselves, this value will be the same as the ActorID.

## ResourceID

Type: string
Type: `string`

Unique identifier of the resource within Cloudflare's system.

## ResourceType

Type: string
Type: `string`

The type of resource that was changed.

## When

Type: int or string
Type: `int or string`

When the change happened.
Original file line number Diff line number Diff line change
@@ -1,81 +1,82 @@
---
# Code generator. DO NOT EDIT.

title: CASB Findings
pcx_content_type: configuration
sidebar:
order: 21

---

The descriptions below detail the fields available for `casb_findings`.

## AssetDisplayName

Type: string
Type: `string`

Asset display name (for example, 'My File Name.docx').

## AssetExternalID

Type: string
Type: `string`

Unique identifier for an asset of this type. Format will vary by policy vendor.

## AssetLink

Type: string
Type: `string`

URL to the asset. This may not be available for some policy vendors and asset types.

## AssetMetadata

Type: object
Type: `object`

Metadata associated with the asset. Structure will vary by policy vendor.

## DetectedTimestamp

Type: int or string
Type: `int or string`

Date and time the finding was first identified (for example, '2021-07-27T00:01:07Z').

## FindingTypeDisplayName

Type: string
Type: `string`

Human-readable name of the finding type (for example, 'File Publicly Accessible Read Only').

## FindingTypeID

Type: string
Type: `string`

UUID of the finding type in Cloudflare's system.

## FindingTypeSeverity

Type: string
Type: `string`

Severity of the finding type (for example, 'High').

## InstanceID

Type: string
Type: `string`

UUID of the finding in Cloudflare's system.

## IntegrationDisplayName

Type: string
Type: `string`

Human-readable name of the integration (for example, 'My Google Workspace Integration').

## IntegrationID

Type: string
Type: `string`

UUID of the integration in Cloudflare's system.

## IntegrationPolicyVendor

Type: string
Type: `string`

Human-readable vendor name of the integration's policy (for example, 'Google Workspace Standard Policy').
Loading

0 comments on commit 60e6004

Please sign in to comment.