Skip to content

Commit

Permalink
Updated pulic schemas
Browse files Browse the repository at this point in the history
  • Loading branch information
@alexkoumarianos-okta
alexkoumarianos-okta committed Jan 7, 2025
1 parent bd32958 commit e0bae57
Show file tree
Hide file tree
Showing 140 changed files with 14,137 additions and 3,360 deletions.
11,533 changes: 8,174 additions & 3,359 deletions schemas/all-log-types.schema.json
View file

Large diffs are not rendered by default.

120 changes: 120 additions & 0 deletions schemas/log-types/acls_summary.schema.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"$event_schema": {
"description": "Event schema meta",
"allOf": [
{
"properties": {
"version": {
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
}
]
},
"description": {
"description": "Description of the event. This can also contain a description of the issue for failure logs.",
"type": "string"
},
"details": {
"description": "Log details",
"properties": {
"end_time": {
"format": "date-time",
"type": "string"
},
"start_time": {
"format": "date-time",
"type": "string"
},
"stats": {
"items": {
"properties": {
"acl_id": {
"type": "string"
},
"action": {
"type": "string"
},
"description": {
"type": "string"
},
"match": {
"properties": {
"successes": {
"type": "number"
}
},
"required": [
"successes"
],
"type": "object"
},
"not_match": {
"properties": {
"successes": {
"type": "number"
}
},
"required": [
"successes"
],
"type": "object"
},
"priority": {
"type": "number"
}
},
"required": [
"acl_id",
"description",
"priority",
"action"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"start_time",
"end_time",
"stats"
],
"type": "object"
},
"log_id": {
"description": "Log id",
"type": "string"
},
"tenant_name": {
"description": "Tenant name",
"type": "string"
},
"type": {
"const": "acls_summary",
"description": "Network ACLs summary",
"type": "string"
},
"user_agent": {
"description": "The user_agent behind this log, when available",
"examples": [
"Chrome 120.0.0 / Mac OS X 10.15.7"
],
"type": "string"
}
},
"required": [
"description",
"details",
"log_id",
"tenant_name",
"type"
],
"type": "object"
}
31 changes: 31 additions & 0 deletions schemas/log-types/api_limit.schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,25 @@
"details": {
"description": "Log details",
"properties": {
"limit": {
"properties": {
"bucket": {
"type": "string"
},
"global": {
"type": "boolean"
},
"size": {
"type": "number"
}
},
"required": [
"size",
"bucket",
"global"
],
"type": "object"
},
"request": {
"properties": {
"method": {
Expand All @@ -89,16 +108,27 @@
"type": "string"
}
},
"required": [
"limit"
],
"type": "object"
},
"hostname": {
"description": "The hostname associated with the request. For forwarded requests, this should resolve to the original hostname. For failure logs, this may include invalid hostnames.",
"type": "string"
},
"identity_user_id": {
"description": "ID for the user as reported by the IdP.",
"type": "string"
},
"log_id": {
"description": "Log id",
"type": "string"
},
"tenant_name": {
"description": "Tenant name",
"type": "string"
},
"type": {
"const": "api_limit",
"description": "Rate Limit notice on Authentication or Management API",
Expand Down Expand Up @@ -132,6 +162,7 @@
"details",
"hostname",
"log_id",
"tenant_name",
"type"
],
"type": "object"
Expand Down
9 changes: 9 additions & 0 deletions schemas/log-types/appi.schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,18 @@
],
"type": "object"
},
"identity_user_id": {
"description": "ID for the user as reported by the IdP.",
"type": "string"
},
"log_id": {
"description": "Log id",
"type": "string"
},
"tenant_name": {
"description": "Tenant name",
"type": "string"
},
"type": {
"const": "appi",
"description": "Notice for API Peak Performance Initiated",
Expand Down Expand Up @@ -145,6 +153,7 @@
"description",
"details",
"log_id",
"tenant_name",
"type"
],
"type": "object"
Expand Down
160 changes: 160 additions & 0 deletions schemas/log-types/ciba_exchange_failed.schema.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Failed CIBA Exchange",
"properties": {
"$event_schema": {
"description": "Event schema meta",
"allOf": [
{
"properties": {
"version": {
"type": "string"
}
},
"required": [
"version"
],
"type": "object"
}
]
},
"auth0_client": {
"anyOf": [
{
"properties": {
"env": {
"type": "object"
},
"name": {
"type": "string"
},
"version": {
"type": "string"
}
},
"required": [
"name",
"version"
],
"type": "object"
},
{
"type": "object"
},
{
"items": {},
"type": "array"
}
],
"description": "The client or SDK used to do this request, if any. This is based on the `Auth0-Client` HTTP header."
},
"client_id": {
"description": "Client related to the API call. Clients are also called applications. The underlying application may not be owned by your tenant and may not be accessible. For failure logs, this may be a valid ID, an invalid one, or any ID.",
"type": [
"string",
"null"
]
},
"client_name": {
"description": "Client name associated with the client_id, when available. May be empty string.",
"type": "string"
},
"description": {
"description": "Description of the event. This can also contain a description of the issue for failure logs.",
"type": "string"
},
"details": {
"description": "Log details",
"properties": {
"client_authentication_error": {
"type": "string"
},
"error": {
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
}
},
"required": [
"error"
],
"type": "object"
},
"hostname": {
"description": "The hostname associated with the request. For forwarded requests, this should resolve to the original hostname. For failure logs, this may include invalid hostnames.",
"type": "string"
},
"identity_user_id": {
"description": "ID for the user as reported by the IdP.",
"type": "string"
},
"ip": {
"anyOf": [
{
"format": "ipv4",
"type": "string"
},
{
"format": "ipv6",
"type": "string"
}
],
"description": "The IP address associated with the request. For an auth related log this should be the end user IP. For a machine-to-machine auth flow this should be the IP of the computer doing the authentication. For management logs like `sapi` and `mgmt_api_read` this should be the IP of the admin using the manage dashboard."
},
"log_id": {
"description": "Log id",
"type": "string"
},
"mtls_thumbprint_sha256": {
"description": "Representation of the client certificate used to authenticate the client as per RFC 8705 section 3.1. Only included in authorization and token exchanges using mtls as a client authentication method.",
"type": "string"
},
"tenant_name": {
"description": "Tenant name",
"type": "string"
},
"type": {
"const": "ciba_exchange_failed",
"description": "Failed CIBA Exchange",
"type": "string"
},
"user_agent": {
"description": "The user_agent behind this log, when available",
"examples": [
"Chrome 120.0.0 / Mac OS X 10.15.7"
],
"type": "string"
},
"user_id": {
"description": "ID of the user behind the auth flow, or of the user executing the action, whichever applies. For machine to machine auth flows, this field may contain an empty string. For failure logs, the value may be a valid ID, an invalid ID, or empty string",
"type": "string"
},
"user_name": {
"description": "Username of the user related to the ID is shown in `user_id`, when available. For failure logs, the value may be a valid username, an invalid username, or empty string.",
"examples": [
[
"[email protected]",
"+14155554321"
]
],
"type": "string"
}
},
"required": [
"client_name",
"description",
"details",
"hostname",
"ip",
"log_id",
"tenant_name",
"type"
],
"type": "object"
}
Loading

0 comments on commit e0bae57

Please sign in to comment.