-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #8 from auth0/schema-update-20240313155943
Update schema definitions - 20240313155943
- Loading branch information
Showing
2 changed files
with
281 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -764,6 +764,9 @@ | |
| }, | ||
| "TenantLog": { | ||
| "anyOf": [ | ||
| { | ||
| "$ref": "#/definitions/elevated_rate_limit" | ||
| }, | ||
| { | ||
| "$ref": "#/definitions/api_limit" | ||
| }, | ||
|
|
@@ -1683,6 +1686,133 @@ | |
| ], | ||
| "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": [ | ||
| [ | ||
| "[email protected]", | ||
| "+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": { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| { | ||
| "$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", | ||
| "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" | ||
| }, | ||
| "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": [ | ||
| [ | ||
| "[email protected]", | ||
| "+14155554321" | ||
| ] | ||
| ], | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "required": [ | ||
| "client_name", | ||
| "description", | ||
| "details", | ||
| "log_id", | ||
| "type" | ||
| ], | ||
| "type": "object" | ||
| } |