Skip to content

Commit

Permalink
docs: add initial description of all events (#1927)
Browse files Browse the repository at this point in the history 
* docs: add initial description of all events

* fix: layout

---------

Co-authored-by: vinckr <[email protected]>
  • Loading branch information
@jonas-jonas @vinckr
jonas-jonas and vinckr authored Oct 23, 2024
1 parent eb17767 commit c275b43
Showing 1 changed file with 67 additions and 8 deletions.
75 changes: 67 additions & 8 deletions docs/actions/live-events.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,73 @@ choice, and use them to power your own analytics, dashboards, data science, and
Live event streams are available for Ory Network enterprise contracts. Talk to your account manager or reach out
[directly](https://www.ory.sh/contact/) to find out more.

:::info

You workload is not running on AWS or you don't want to use SNS? [Reach out](https://www.ory.sh/contact/) to discuss your
requirements!

:::

## Stream to AWS SNS
## Event descriptions

Ory emits events for many different actions. The following is a list of all events that are currently supported. This list is not
exhaustive, and there might by additional events being emitted.

### Ory Identities

| **Event** | **Description** |
| --------------------------- | ------------------------------------------------------------------------------------------------ |
| **SessionIssued** | A new session has been initiated for a user. |
| **SessionChanged** | The session details have been modified or updated. |
| **SessionLifespanExtended** | The duration of the session has been extended, allowing the user to remain authenticated longer. |
| **SessionRevoked** | The session has been explicitly terminated or invalidated. |
| **SessionChecked** | A check has been performed to verify the session's validity or status. |
| **SessionTokenizedAsJWT** | The session has been converted into a JWT (JSON Web Token) for authentication purposes. |
| **RegistrationFailed** | A user's attempt to register has failed due to errors or invalid data. |
| **RegistrationSucceeded** | A user has successfully registered and created an account. |
| **LoginFailed** | A user's login attempt has failed, possibly due to incorrect credentials. |
| **LoginSucceeded** | A user has successfully logged into their account. |
| **SettingsFailed** | An attempt to change account or session settings has failed. |
| **SettingsSucceeded** | Changes to account or session settings have been successfully applied. |
| **RecoveryFailed** | A password or account recovery attempt has failed. |
| **RecoverySucceeded** | A password or account recovery attempt has succeeded. |
| **VerificationFailed** | A user's identity verification attempt has failed. |
| **VerificationSucceeded** | A user's identity verification has been successfully completed. |
| **IdentityCreated** | A new identity (user or account) has been successfully created. |
| **IdentityUpdated** | An existing identity's details have been modified or updated. |
| **IdentityDeleted** | An identity has been deleted from the system. |
| **WebhookDelivered** | A webhook has been sent to the configured endpoint for processing. |
| **WebhookSucceeded** | A webhook has been successfully processed and acknowledged by the receiving endpoint. |
| **WebhookFailed** | A webhook delivery or processing has failed at the receiving endpoint. |

### Ory OAuth2

| **Event** | **Description** |
| ------------------------------ | --------------------------------------------------------------------------------------------------- |
| **OAuth2LoginAccepted** | A user's OAuth2 login has been accepted and the authentication process is successful. |
| **OAuth2LoginRejected** | A user's OAuth2 login attempt has been rejected due to invalid credentials or authorization issues. |
| **OAuth2ConsentAccepted** | The user has accepted the consent screen, granting requested permissions to the OAuth2 client. |
| **OAuth2ConsentRejected** | The user has rejected the consent screen, refusing to grant the requested permissions. |
| **OAuth2ConsentRevoked** | The user has revoked previously granted consent for an OAuth2 client, removing its permissions. |
| **OAuth2ClientCreated** | A new OAuth2 client (application) has been created and registered in the system. |
| **OAuth2ClientDeleted** | An OAuth2 client has been deleted from the system. |
| **OAuth2ClientUpdated** | An existing OAuth2 client's details have been updated or modified. |
| **OAuth2AccessTokenIssued** | An OAuth2 access token has been successfully issued to a client or user. |
| **OAuth2TokenExchangeError** | An error occurred during the OAuth2 token exchange process, possibly due to invalid requests. |
| **OAuth2AccessTokenInspected** | An OAuth2 access token has been inspected to verify its validity or check its claims. |
| **OAuth2AccessTokenRevoked** | An OAuth2 access token has been revoked, invalidating it for future use. |
| **OAuth2RefreshTokenIssued** | A refresh token has been successfully issued, allowing the client to obtain a new access token. |
| **OIDCIdentityTokenIssued** | An OpenID Connect (OIDC) identity token has been issued to authenticate the user's identity. |

### Ory Permissions

| **Event** | **Description** |
| ------------------------- | ----------------------------------------------------------------------------------------------------- |
| **RelationtuplesCreated** | A new relation tuple has been created, representing a relationship between entities. |
| **RelationtuplesDeleted** | An existing relation tuple has been deleted, removing the relationship between entities. |
| **RelationtuplesChanged** | A relation tuple has been modified, indicating a change in the relationship between entities. |
| **PermissionsExpanded** | Permissions have been expanded, likely increasing access or privileges for certain users or entities. |
| **PermissionsChecked** | A permission check has been performed to verify if access is allowed for a given action or resource. |

## Configure event streams

Is your workload not running on AWS or you don't want to use SNS? [Reach out](https://www.ory.sh/contact/) to discuss your
requirements! Event streams can be implemented for any data warehouse, data lake, or equivalent solution.

### Stream to AWS SNS

Configuring AWS SNS as an event stream destination is easy and requires no exchange of confidential information.

Expand Down

0 comments on commit c275b43

Please sign in to comment.