Skip to content

Commit

Permalink
Merge pull request #13 from auth0/schema-update-20240430134923
Browse files Browse the repository at this point in the history 
Update schema definitions - 20240430134923
  • Loading branch information
@tafarij
tafarij authored Apr 30, 2024
2 parents 49b68e1 + bf5eb5f commit f3ce158
Show file tree
Hide file tree
Showing 4 changed files with 536 additions and 0 deletions.
245 changes: 245 additions & 0 deletions schemas/all-log-types.schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -995,6 +995,9 @@
{
"$ref": "#/definitions/resource_cleanup"
},
{
"$ref": "#/definitions/refresh_tokens_revoked_by_session"
},
{
"$ref": "#/definitions/s"
},
Expand Down Expand Up @@ -1049,6 +1052,9 @@
{
"$ref": "#/definitions/sepft"
},
{
"$ref": "#/definitions/session_revoked"
},
{
"$ref": "#/definitions/sercft"
},
Expand Down Expand Up @@ -9999,6 +10005,124 @@
],
"type": "object"
},
"refresh_tokens_revoked_by_session": {
"description": "Successfully revoked a refresh token",
"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": {
"session_id": {
"type": "string"
}
},
"required": [
"session_id"
],
"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"
},
"ip": {
"anyOf": [
{
"$ref": "#/definitions/IPV4"
},
{
"$ref": "#/definitions/IPV6"
}
],
"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"
},
"type": {
"const": "srrt",
"description": "Successful Refresh Token Revocation",
"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",
"type"
],
"type": "object"
},
"resource_cleanup": {
"description": "Emitted when resources exceeding defined limits were removed. Normally related to refresh tokens",
"properties": {
Expand Down Expand Up @@ -12879,6 +13003,124 @@
],
"type": "object"
},
"session_revoked": {
"description": "Successfully revoked a session",
"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": {
"session_id": {
"type": "string"
}
},
"required": [
"session_id"
],
"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"
},
"ip": {
"anyOf": [
{
"$ref": "#/definitions/IPV4"
},
{
"$ref": "#/definitions/IPV6"
}
],
"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"
},
"type": {
"const": "session_revoked",
"description": "Sucessful session revocation",
"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",
"type"
],
"type": "object"
},
"si": {
"description": "Successfully accepted a user invitation",
"properties": {
Expand Down Expand Up @@ -13244,6 +13486,9 @@
"originalUrl": {
"type": "string"
},
"session_id": {
"type": "string"
},
"xhr": {
"type": "string"
}
Expand Down
Loading

0 comments on commit f3ce158

Please sign in to comment.