Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update schema definitions - 20240425163031 #12

Merged
merged 1 commit into from
Apr 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
256 changes: 128 additions & 128 deletions schemas/all-log-types.schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -765,7 +765,7 @@
"TenantLog": {
"anyOf": [
{
"$ref": "#/definitions/elevated_rate_limit"
"$ref": "#/definitions/appi"
},
{
"$ref": "#/definitions/api_limit"
Expand Down Expand Up @@ -1204,6 +1204,133 @@
],
"type": "object"
},
"appi": {
"description": "API Peak Performance Rate is initiated",
"properties": {
"$event_schema": {
"description": "Event schema meta",
"allOf": [
{
"$ref": "#/definitions/SchemaMeta"
}
]
},
"auth0_client": {
"anyOf": [
{
"$ref": "#/definitions/Auth0ClientProp"
},
{
"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"
},
"connection": {
"description": "Name of the connection, when available. The connection here matches the `connection_id` field.",
"type": "string"
},
"connection_id": {
"description": "ID of the connection on which the auth flow is happening or connection of the user doing the action, when applicable. For failure logs this field may contain an invalid ID.",
"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": {
"docs": {
"type": "string"
},
"request": {
"properties": {
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
"response": {
"type": "string"
},
"total_hours_allocated": {
"type": "number"
},
"total_hours_remaining": {
"type": "number"
},
"total_hours_used": {
"type": "number"
}
},
"required": [
"total_hours_allocated",
"total_hours_used",
"total_hours_remaining",
"docs"
],
"type": "object"
},
"log_id": {
"description": "Log id",
"type": "string"
},
"type": {
"const": "appi",
"description": "Notice for API Peak Performance Initiated",
"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": [
[
"example@example.com",
"+14155554321"
]
],
"type": "string"
}
},
"required": [
"client_name",
"description",
"details",
"log_id",
"type"
],
"type": "object"
},
"cls": {
"description": "Passwordless Login Code/Link Sent",
"properties": {
Expand Down Expand Up @@ -1689,133 +1816,6 @@
],
"type": "object"
},
"elevated_rate_limit": {
"description": "The maximum number of requests to the Authentication or Management APIs in given time was reached",
"properties": {
"$event_schema": {
"description": "Event schema meta",
"allOf": [
{
"$ref": "#/definitions/SchemaMeta"
}
]
},
"auth0_client": {
"anyOf": [
{
"$ref": "#/definitions/Auth0ClientProp"
},
{
"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"
},
"connection": {
"description": "Name of the connection, when available. The connection here matches the `connection_id` field.",
"type": "string"
},
"connection_id": {
"description": "ID of the connection on which the auth flow is happening or connection of the user doing the action, when applicable. For failure logs this field may contain an invalid ID.",
"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": {
"docs": {
"type": "string"
},
"request": {
"properties": {
"method": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
"response": {
"type": "string"
},
"total_hours_allocated": {
"type": "number"
},
"total_hours_remaining": {
"type": "number"
},
"total_hours_used": {
"type": "number"
}
},
"required": [
"total_hours_allocated",
"total_hours_used",
"total_hours_remaining",
"docs"
],
"type": "object"
},
"log_id": {
"description": "Log id",
"type": "string"
},
"type": {
"const": "elevated_rate_limit",
"description": "Elevated Rate Limit notice on Authentication or Management API",
"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": [
[
"example@example.com",
"+14155554321"
]
],
"type": "string"
}
},
"required": [
"client_name",
"description",
"details",
"log_id",
"type"
],
"type": "object"
},
"f": {
"description": "Failed Login This is only emitted if the error is not covered by the `fp` or `fu` log types",
"properties": {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "The maximum number of requests to the Authentication or Management APIs in given time was reached",
"description": "API Peak Performance Rate is initiated",
"properties": {
"$event_schema": {
"description": "Event schema meta",
Expand Down Expand Up @@ -114,8 +114,8 @@
"type": "string"
},
"type": {
"const": "elevated_rate_limit",
"description": "Elevated Rate Limit notice on Authentication or Management API",
"const": "appi",
"description": "Notice for API Peak Performance Initiated",
"type": "string"
},
"user_agent": {
Expand Down
Loading