Skip to content

Commit 2233120

Browse files
cmackenzie1harshil1712
authored andcommitted
[Logs]: update field reference (#18177)
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.
1 parent a50504c commit 2233120

20 files changed

+759
-696
lines changed
Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,100 @@
11
---
2+
# Code generator. DO NOT EDIT.
3+
24
title: Access requests
35
pcx_content_type: configuration
46
sidebar:
57
order: 21
6-
78
---
89

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

1112
## Action
1213

13-
Type: string
14+
Type: `string`
1415

15-
What type of record is this. <em>login</em> | <em>logout</em>.
16+
What type of record is this. <em>login</em> \| <em>logout</em>.
1617

1718
## Allowed
1819

19-
Type: bool
20+
Type: `bool`
2021

2122
If request was allowed or denied.
2223

2324
## AppDomain
2425

25-
Type: string
26+
Type: `string`
2627

2728
The domain of the Application that Access is protecting.
2829

2930
## AppUUID
3031

31-
Type: string
32+
Type: `string`
3233

3334
Access Application UUID.
3435

3536
## Connection
3637

37-
Type: string
38+
Type: `string`
3839

3940
Identity provider used for the login.
4041

4142
## Country
4243

43-
Type: string
44+
Type: `string`
4445

4546
Request's country of origin.
4647

4748
## CreatedAt
4849

49-
Type: int or string
50+
Type: `int or string`
5051

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

5354
## Email
5455

55-
Type: string
56+
Type: `string`
5657

5758
Email of the user who logged in.
5859

5960
## IPAddress
6061

61-
Type: string
62+
Type: `string`
6263

6364
The IP address of the client.
6465

6566
## PurposeJustificationPrompt
6667

67-
Type: string
68+
Type: `string`
6869

6970
Message prompted to the client when accessing the application.
7071

7172
## PurposeJustificationResponse
7273

73-
Type: string
74+
Type: `string`
7475

7576
Justification given by the client when accessing the application.
7677

7778
## RayID
7879

79-
Type: string
80+
Type: `string`
8081

8182
Identifier of the request.
8283

8384
## TemporaryAccessApprovers
8485

85-
Type: array\[string]
86+
Type: `array[string]`
8687

8788
List of approvers for this access request.
8889

8990
## TemporaryAccessDuration
9091

91-
Type: int
92+
Type: `int`
9293

9394
Approved duration for this access request.
9495

9596
## UserUID
9697

97-
Type: string
98+
Type: `string`
9899

99100
The uid of the user who logged in.
Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,100 @@
11
---
2+
# Code generator. DO NOT EDIT.
3+
24
title: Audit logs
35
pcx_content_type: configuration
46
sidebar:
57
order: 21
6-
78
---
89

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

1112
## ActionResult
1213

13-
Type: bool
14+
Type: `bool`
1415

1516
Whether the action was successful.
1617

1718
## ActionType
1819

19-
Type: string
20+
Type: `string`
2021

2122
Type of action taken.
2223

2324
## ActorEmail
2425

25-
Type: string
26+
Type: `string`
2627

2728
Email of the actor.
2829

2930
## ActorID
3031

31-
Type: string
32+
Type: `string`
3233

3334
Unique identifier of the actor in Cloudflare's system.
3435

3536
## ActorIP
3637

37-
Type: string
38+
Type: `string`
3839

3940
Physical network address of the actor.
4041

4142
## ActorType
4243

43-
Type: string
44+
Type: `string`
4445

4546
Type of user that started the audit trail.
4647

4748
## ID
4849

49-
Type: string
50+
Type: `string`
5051

5152
Unique identifier of an audit log.
5253

5354
## Interface
5455

55-
Type: string
56+
Type: `string`
5657

5758
Entry point or interface of the audit log.
5859

5960
## Metadata
6061

61-
Type: object
62+
Type: `object`
6263

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

6566
## NewValue
6667

67-
Type: object
68+
Type: `object`
6869

6970
Contains the new value for the audited item.
7071

7172
## OldValue
7273

73-
Type: object
74+
Type: `object`
7475

7576
Contains the old value for the audited item.
7677

7778
## OwnerID
7879

79-
Type: string
80+
Type: `string`
8081

8182
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.
8283

8384
## ResourceID
8485

85-
Type: string
86+
Type: `string`
8687

8788
Unique identifier of the resource within Cloudflare's system.
8889

8990
## ResourceType
9091

91-
Type: string
92+
Type: `string`
9293

9394
The type of resource that was changed.
9495

9596
## When
9697

97-
Type: int or string
98+
Type: `int or string`
9899

99100
When the change happened.
Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,82 @@
11
---
2+
# Code generator. DO NOT EDIT.
3+
24
title: CASB Findings
35
pcx_content_type: configuration
46
sidebar:
57
order: 21
6-
78
---
89

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

1112
## AssetDisplayName
1213

13-
Type: string
14+
Type: `string`
1415

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

1718
## AssetExternalID
1819

19-
Type: string
20+
Type: `string`
2021

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

2324
## AssetLink
2425

25-
Type: string
26+
Type: `string`
2627

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

2930
## AssetMetadata
3031

31-
Type: object
32+
Type: `object`
3233

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

3536
## DetectedTimestamp
3637

37-
Type: int or string
38+
Type: `int or string`
3839

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

4142
## FindingTypeDisplayName
4243

43-
Type: string
44+
Type: `string`
4445

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

4748
## FindingTypeID
4849

49-
Type: string
50+
Type: `string`
5051

5152
UUID of the finding type in Cloudflare's system.
5253

5354
## FindingTypeSeverity
5455

55-
Type: string
56+
Type: `string`
5657

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

5960
## InstanceID
6061

61-
Type: string
62+
Type: `string`
6263

6364
UUID of the finding in Cloudflare's system.
6465

6566
## IntegrationDisplayName
6667

67-
Type: string
68+
Type: `string`
6869

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

7172
## IntegrationID
7273

73-
Type: string
74+
Type: `string`
7475

7576
UUID of the integration in Cloudflare's system.
7677

7778
## IntegrationPolicyVendor
7879

79-
Type: string
80+
Type: `string`
8081

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

0 commit comments

Comments
 (0)