diff --git a/main/docs.json b/main/docs.json index 8cfabe7917..f5d96234bc 100644 --- a/main/docs.json +++ b/main/docs.json @@ -1361,9 +1361,7 @@ "pages": [ "docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger", "docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/post-login-event-object", - "docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/post-login-api-object", - "docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions", - "docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/releases" + "docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/post-login-api-object" ] }, { @@ -1442,6 +1440,7 @@ }, "docs/customize/actions/use-cases", "docs/customize/actions/transaction-metadata", + "docs/customize/actions/redirect-with-actions", "docs/customize/actions/limitations", "docs/customize/actions/actions-real-time-logs", "docs/customize/actions/actions-templates", @@ -1450,7 +1449,6 @@ "docs/customize/actions/manage-dependencies", "docs/customize/actions/manage-versions", "docs/customize/actions/test-actions", - "docs/customize/actions/releases", { "group": "Migrate to Actions", "pages": [ @@ -4176,8 +4174,7 @@ "pages": [ "docs/fr-ca/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger", "docs/fr-ca/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/post-login-event-object", - "docs/fr-ca/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/post-login-api-object", - "docs/fr-ca/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions" + "docs/fr-ca/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/post-login-api-object" ] }, { @@ -4241,6 +4238,7 @@ "docs/fr-ca/customize/actions/use-cases", "docs/fr-ca/customize/actions/action-coding-guidelines", "docs/fr-ca/customize/actions/transaction-metadata", + "docs/fr-ca/customize/actions/redirect-with-actions", "docs/fr-ca/customize/actions/limitations", "docs/fr-ca/customize/actions/actions-real-time-logs", "docs/fr-ca/customize/actions/actions-templates", @@ -6634,8 +6632,7 @@ "pages": [ "docs/ja-jp/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger", "docs/ja-jp/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/post-login-event-object", - "docs/ja-jp/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/post-login-api-object", - "docs/ja-jp/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions" + "docs/ja-jp/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/post-login-api-object" ] }, { @@ -6699,6 +6696,7 @@ "docs/ja-jp/customize/actions/use-cases", "docs/ja-jp/customize/actions/action-coding-guidelines", "docs/ja-jp/customize/actions/transaction-metadata", + "docs/ja-jp/customize/actions/redirect-with-actions", "docs/ja-jp/customize/actions/limitations", "docs/ja-jp/customize/actions/actions-real-time-logs", "docs/ja-jp/customize/actions/actions-templates", @@ -20191,27 +20189,43 @@ }, { "source": "/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/releases", - "destination": "/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger" + "destination": "/docs/customize/actions/actions-overview" + }, + { + "source": "/docs/customize/actions/flows-and-triggers/login-flow/releases", + "destination": "/docs/customize/actions/actions-overview" }, { "source": "/docs/customize/actions/releases", - "destination": "/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger" + "destination": "/docs/customize/actions/actions-overview" }, { - "source": "/docs/customize/actions/flows-and-triggers/login-flow/releases", - "destination": "/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger" + "source": "/docs/releases", + "destination": "/docs/customize/actions/actions-overview" }, { "source": "/docs/customize/actions/flows-and-triggers/login-flow/redirect-with-actions", - "destination": "/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions" + "destination": "/docs/customize/actions/redirect-with-actions" }, { "source": "/docs/customize/actions/triggers/post-login/redirect-with-actions", - "destination": "/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions" + "destination": "/docs/customize/actions/redirect-with-actions" }, { "source": "/docs/actions/triggers/post-login/redirect-with-actions", - "destination": "/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions" + "destination": "/docs/customize/actions/redirect-with-actions" + }, + { + "source": "/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions", + "destination": "/docs/customize/actions/redirect-with-actions" + }, + { + "source": "docs/fr-ca/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions", + "destination": "/docs/fr-ca/customize/actions/redirect-with-actions" + }, + { + "source": "docs/ja-jp/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions", + "destination": "/docs/ja-jp/customize/actions/redirect-with-actions" }, { "source": "/docs/customize/actions/flows-and-triggers/login-flow/api-object", diff --git a/main/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/releases.mdx b/main/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/releases.mdx deleted file mode 100644 index 110f7fad34..0000000000 --- a/main/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/releases.mdx +++ /dev/null @@ -1,97 +0,0 @@ ---- -description: Learn about released versions of Actions, including breaking changes and new features. -title: Releases ---- -Features and breaking changes released in Actions are listed below. - -## v3 - -### Login Flow - -New features and breaking changes were released to triggers in the Login Flow. To learn about these changes, read [Login Flow: Releases](/docs/releases). - -## v2 (GA) - -### Query and body parameters - -Direct access to the query and body parameters is available using the `event.request.query` and `event.request.body` objects. These are exposed regardless of whether the authorization was initiated via a `GET` or `POST` request. Many protocol-specific query or body parameters sent as part of an authorization request are now also available as first-class values on the `event.transaction` object. We recommend that you use `event.transaction` rather than `event.request.query` and `event.request.body` unless your use case is not supported. A complete mapping of these changes is below: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Pre-GA PropertyGA Property
event.actor.ipevent.request.ip
event.actor.hostnameevent.request.hostname
event.actor.geoIpevent.request.geoip
event.actor.languageevent.request.language
event.actor.methodevent.request.method
event.actor.userAgentevent.request.user_agent
event.actor.bodyevent.request.body
event.actor.queryevent.request.query
event.actor.query.audienceevent.resource_server.identifier
event.actor.query.scopeevent.transaction.requested_scopes
event.actor.query.acr_valuesevent.transaction.acr_values
event.actor.query.ui_localesevent.transaction.ui_locales
event.protocolevent.transaction.protocol
context.secretsevent.secrets
- -### User Profile properties - -In general, the `event.user` object has had its properties changed from camel case to snake case in order to match the [Auth0 User Profile structure](/docs/manage-users/user-accounts/user-profiles/user-profile-structure). For example, `event.user.appMetadata` has been changed to `event.user.app_metadata`. - -### Performing side effects - -In the pre-GA version of the post-login trigger, side effects were performed by returning an object from an Action. In Actions GA, an `api` object is provided to encapsulate these changes and provide better in-editor type hints and inline documentation. - -To learn more about these changes and see code examples, read [Login Flow: Releases](/docs/releases). - -### Manipulating scopes - -Although we experimented with providing direct manipulation of ID and Access Token scopes during the Actions Beta, we do not support this functionality in Actions GA. diff --git a/main/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions.mdx b/main/docs/customize/actions/redirect-with-actions.mdx similarity index 100% rename from main/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions.mdx rename to main/docs/customize/actions/redirect-with-actions.mdx diff --git a/main/docs/customize/actions/releases.mdx b/main/docs/customize/actions/releases.mdx deleted file mode 100644 index 110f7fad34..0000000000 --- a/main/docs/customize/actions/releases.mdx +++ /dev/null @@ -1,97 +0,0 @@ ---- -description: Learn about released versions of Actions, including breaking changes and new features. -title: Releases ---- -Features and breaking changes released in Actions are listed below. - -## v3 - -### Login Flow - -New features and breaking changes were released to triggers in the Login Flow. To learn about these changes, read [Login Flow: Releases](/docs/releases). - -## v2 (GA) - -### Query and body parameters - -Direct access to the query and body parameters is available using the `event.request.query` and `event.request.body` objects. These are exposed regardless of whether the authorization was initiated via a `GET` or `POST` request. Many protocol-specific query or body parameters sent as part of an authorization request are now also available as first-class values on the `event.transaction` object. We recommend that you use `event.transaction` rather than `event.request.query` and `event.request.body` unless your use case is not supported. A complete mapping of these changes is below: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Pre-GA PropertyGA Property
event.actor.ipevent.request.ip
event.actor.hostnameevent.request.hostname
event.actor.geoIpevent.request.geoip
event.actor.languageevent.request.language
event.actor.methodevent.request.method
event.actor.userAgentevent.request.user_agent
event.actor.bodyevent.request.body
event.actor.queryevent.request.query
event.actor.query.audienceevent.resource_server.identifier
event.actor.query.scopeevent.transaction.requested_scopes
event.actor.query.acr_valuesevent.transaction.acr_values
event.actor.query.ui_localesevent.transaction.ui_locales
event.protocolevent.transaction.protocol
context.secretsevent.secrets
- -### User Profile properties - -In general, the `event.user` object has had its properties changed from camel case to snake case in order to match the [Auth0 User Profile structure](/docs/manage-users/user-accounts/user-profiles/user-profile-structure). For example, `event.user.appMetadata` has been changed to `event.user.app_metadata`. - -### Performing side effects - -In the pre-GA version of the post-login trigger, side effects were performed by returning an object from an Action. In Actions GA, an `api` object is provided to encapsulate these changes and provide better in-editor type hints and inline documentation. - -To learn more about these changes and see code examples, read [Login Flow: Releases](/docs/releases). - -### Manipulating scopes - -Although we experimented with providing direct manipulation of ID and Access Token scopes during the Actions Beta, we do not support this functionality in Actions GA. diff --git a/main/docs/fr-ca/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/releases.mdx b/main/docs/fr-ca/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/releases.mdx deleted file mode 100644 index 23c4d83167..0000000000 --- a/main/docs/fr-ca/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/releases.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: "Versions publiées" -'description': "Découvrez les versions d’Actions publiées, comprenant les modifications majeures et les nouvelles fonctionnalités." ---- - -Vous trouverez ci-dessous la liste des fonctionnalités et modifications majeures apportées à Actions. - -## v3 - -### Flux de connexion - -De nouvelles fonctionnalités et des modifications majeures ont été apportées aux déclencheurs du flux de connexion. Pour en savoir plus sur ces modifications, veuillez consulter [Flux de connexion : Versions publiées](/docs/fr-ca/releases) - -## v2 (GA) - -### Paramètres de requête ou de corps - -L’accès direct aux paramètres de requête ou de corps est possible à l’aide des objets `event.request.query` et `event.request.body`. Ces derniers sont exposés, que l’autorisation ait été initiée par une demande `GET` ou une demande `POST`. De nombreux paramètres de requête ou de corps spécifiques au protocole, envoyés dans le cadre d’une demande d’autorisation, sont désormais également disponibles en tant que valeurs de première classe sur l’objet `event.transaction`. Nous vous recommandons d’utiliser `event.transaction` plutôt que `event.request.query` et `event.request.body`, à moins que votre cas d’utilisation ne soit pas pris en charge. Voici ci-dessous un mappage complet de ces changements : - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Pre-GA PropertyGA Property
`event.actor.ip``event.request.ip`
`event.actor.hostname``event.request.hostname`
`event.actor.geoIp``event.request.geoip`
`event.actor.language``event.request.language`
`event.actor.method``event.request.method`
`event.actor.userAgent``event.request.user_agent`
`event.actor.body``event.request.body`
`event.actor.query``event.request.query`
`event.actor.query.audience``event.resource_server.identifier`
`event.actor.query.scope``event.transaction.requested_scopes`
`event.actor.query.acr_values``event.transaction.acr_values`
`event.actor.query.ui_locales``event.transaction.ui_locales`
`event.protocol``event.transaction.protocol`
`context.secrets``event.secrets`
- -### Propriétés du profil utilisateur - -En règle générale, les propriétés de l’objet `event.user` passent de la casse mixte à la casse serpentine afin de s’adapter à la [Structure du profil utilisateur Auth0](/docs/fr-ca/manage-users/user-accounts/user-profiles/user-profile-structure). Par exemple, `event.user.appMetadata` est devenu `event.user.app_metadata`. - -### Exécution des effets secondaires - -Dans la version du déclencheur post-connexion précédant la mise à disposition générale, les effets secondaires étaient exécutés en renvoyant un objet à partir d’une action. Concernant les actions mises à disposition générale, un objet `api` permet d’encapsuler ces changements et de fournir de meilleures suggestions dans l’éditeur ainsi qu’une documentation en ligne. - -Pour en savoir plus sur ces modifications et voir des exemples de code, veuillez consulter [Flux de connexion : Versions publiées](/docs/fr-ca/releases) - -### Manipuler les permissions - -Bien que nous ayons testé la manipulation directe des permissions de jeton d’ID et d’accès dans la version bêta des actions, nous ne prenons pas en charge cette fonctionnalité dans la version finale. \ No newline at end of file diff --git a/main/docs/fr-ca/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions.mdx b/main/docs/fr-ca/customize/actions/redirect-with-actions.mdx similarity index 100% rename from main/docs/fr-ca/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions.mdx rename to main/docs/fr-ca/customize/actions/redirect-with-actions.mdx diff --git a/main/docs/fr-ca/customize/actions/releases.mdx b/main/docs/fr-ca/customize/actions/releases.mdx deleted file mode 100644 index 23c4d83167..0000000000 --- a/main/docs/fr-ca/customize/actions/releases.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: "Versions publiées" -'description': "Découvrez les versions d’Actions publiées, comprenant les modifications majeures et les nouvelles fonctionnalités." ---- - -Vous trouverez ci-dessous la liste des fonctionnalités et modifications majeures apportées à Actions. - -## v3 - -### Flux de connexion - -De nouvelles fonctionnalités et des modifications majeures ont été apportées aux déclencheurs du flux de connexion. Pour en savoir plus sur ces modifications, veuillez consulter [Flux de connexion : Versions publiées](/docs/fr-ca/releases) - -## v2 (GA) - -### Paramètres de requête ou de corps - -L’accès direct aux paramètres de requête ou de corps est possible à l’aide des objets `event.request.query` et `event.request.body`. Ces derniers sont exposés, que l’autorisation ait été initiée par une demande `GET` ou une demande `POST`. De nombreux paramètres de requête ou de corps spécifiques au protocole, envoyés dans le cadre d’une demande d’autorisation, sont désormais également disponibles en tant que valeurs de première classe sur l’objet `event.transaction`. Nous vous recommandons d’utiliser `event.transaction` plutôt que `event.request.query` et `event.request.body`, à moins que votre cas d’utilisation ne soit pas pris en charge. Voici ci-dessous un mappage complet de ces changements : - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Pre-GA PropertyGA Property
`event.actor.ip``event.request.ip`
`event.actor.hostname``event.request.hostname`
`event.actor.geoIp``event.request.geoip`
`event.actor.language``event.request.language`
`event.actor.method``event.request.method`
`event.actor.userAgent``event.request.user_agent`
`event.actor.body``event.request.body`
`event.actor.query``event.request.query`
`event.actor.query.audience``event.resource_server.identifier`
`event.actor.query.scope``event.transaction.requested_scopes`
`event.actor.query.acr_values``event.transaction.acr_values`
`event.actor.query.ui_locales``event.transaction.ui_locales`
`event.protocol``event.transaction.protocol`
`context.secrets``event.secrets`
- -### Propriétés du profil utilisateur - -En règle générale, les propriétés de l’objet `event.user` passent de la casse mixte à la casse serpentine afin de s’adapter à la [Structure du profil utilisateur Auth0](/docs/fr-ca/manage-users/user-accounts/user-profiles/user-profile-structure). Par exemple, `event.user.appMetadata` est devenu `event.user.app_metadata`. - -### Exécution des effets secondaires - -Dans la version du déclencheur post-connexion précédant la mise à disposition générale, les effets secondaires étaient exécutés en renvoyant un objet à partir d’une action. Concernant les actions mises à disposition générale, un objet `api` permet d’encapsuler ces changements et de fournir de meilleures suggestions dans l’éditeur ainsi qu’une documentation en ligne. - -Pour en savoir plus sur ces modifications et voir des exemples de code, veuillez consulter [Flux de connexion : Versions publiées](/docs/fr-ca/releases) - -### Manipuler les permissions - -Bien que nous ayons testé la manipulation directe des permissions de jeton d’ID et d’accès dans la version bêta des actions, nous ne prenons pas en charge cette fonctionnalité dans la version finale. \ No newline at end of file diff --git a/main/docs/ja-jp/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/releases.mdx b/main/docs/ja-jp/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/releases.mdx deleted file mode 100644 index d3d5c38926..0000000000 --- a/main/docs/ja-jp/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/releases.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: "リリース" -'description': "破壊的変更および新機能を含む、Actionsのリリース済みバージョンについて説明します。" ---- - -Actionsでリリースされた機能および破壊的変更は、以下です。 - -## v3 - -### ログインフロー - -新機能および破壊的変更は、ログインフローのトリガーに対してリリースされています。これらの変更については、[ログインフロー：リリース](/docs/ja-jp/releases)をご覧ください。 - -## v2（GA） - -### クエリおよび本文パラメーター - -`event.request.query`および`event.request.body`オブジェクトを使用して、クエリおよびボディーパラメーターへの直接アクセスが利用できます。これらは、`GET`または`POST`要求を介して認可が開始されたかどうかに関わらず、公開されます。また認可要求の一環として送信された多くのプロトコル固有のクエリまたはボディーパラメーターは、`event.transaction`オブジェクトのファーストクラス値として利用できます。ユースケースがサポートされていない場合を除き、`event.request.query`および`event.request.body`ではなく`event.transaction`を使用することをお勧めします。これらの変更の完全なマッピングは以下のとおりです。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
GA前のプロパティGAのプロパティ
`event.actor.ip``event.request.ip`
`event.actor.hostname``event.request.hostname`
`event.actor.geoIp``event.request.geoip`
`event.actor.language``event.request.language`
`event.actor.method``event.request.method`
`event.actor.userAgent``event.request.user_agent`
`event.actor.body``event.request.body`
`event.actor.query``event.request.query`
`event.actor.query.audience``event.resource_server.identifier`
`event.actor.query.scope``event.transaction.requested_scopes`
`event.actor.query.acr_values``event.transaction.acr_values`
`event.actor.query.ui_locales``event.transaction.ui_locales`
`event.protocol``event.transaction.protocol`
`context.secrets``event.secrets`
- -### ユーザープロファイルプロパティ - -一般的に、[Auth0ユーザープロファイル構造](/docs/ja-jp/manage-users/user-accounts/user-profiles/user-profile-structure)と一致させるために、`event.user`オブジェクトは、そのプロパティをキャメルケースからスネークケースに変更しています。たとえば、`event.user.appMetadata`は、`event.user.app_metadata`に変更されています。 - -### 副作用の実行 - -ログイン後トリガーのGA前のバージョンでは、副作用は、Actionからオブジェクトを返すことで実行されました。Actions GAでは、これらの変更をカプセル化し、より良いエディター内ヒントおよびインラインドキュメントを提供するために、`api`オブジェクトが用意されています。 - -これらの変更についての詳細およびコード例を確認するには「[ログインフロー：リリース](/docs/ja-jp/releases)」をご覧ください。 - -### スコープの操作 - -Actions BetaでIDおよびアクセストークンスコープの直接操作の提供を試みていますが、Actions GAではこの機能をサポートしていません。 \ No newline at end of file diff --git a/main/docs/ja-jp/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions.mdx b/main/docs/ja-jp/customize/actions/redirect-with-actions.mdx similarity index 100% rename from main/docs/ja-jp/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions.mdx rename to main/docs/ja-jp/customize/actions/redirect-with-actions.mdx diff --git a/main/docs/ja-jp/customize/actions/releases.mdx b/main/docs/ja-jp/customize/actions/releases.mdx deleted file mode 100644 index d3d5c38926..0000000000 --- a/main/docs/ja-jp/customize/actions/releases.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: "リリース" -'description': "破壊的変更および新機能を含む、Actionsのリリース済みバージョンについて説明します。" ---- - -Actionsでリリースされた機能および破壊的変更は、以下です。 - -## v3 - -### ログインフロー - -新機能および破壊的変更は、ログインフローのトリガーに対してリリースされています。これらの変更については、[ログインフロー：リリース](/docs/ja-jp/releases)をご覧ください。 - -## v2（GA） - -### クエリおよび本文パラメーター - -`event.request.query`および`event.request.body`オブジェクトを使用して、クエリおよびボディーパラメーターへの直接アクセスが利用できます。これらは、`GET`または`POST`要求を介して認可が開始されたかどうかに関わらず、公開されます。また認可要求の一環として送信された多くのプロトコル固有のクエリまたはボディーパラメーターは、`event.transaction`オブジェクトのファーストクラス値として利用できます。ユースケースがサポートされていない場合を除き、`event.request.query`および`event.request.body`ではなく`event.transaction`を使用することをお勧めします。これらの変更の完全なマッピングは以下のとおりです。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
GA前のプロパティGAのプロパティ
`event.actor.ip``event.request.ip`
`event.actor.hostname``event.request.hostname`
`event.actor.geoIp``event.request.geoip`
`event.actor.language``event.request.language`
`event.actor.method``event.request.method`
`event.actor.userAgent``event.request.user_agent`
`event.actor.body``event.request.body`
`event.actor.query``event.request.query`
`event.actor.query.audience``event.resource_server.identifier`
`event.actor.query.scope``event.transaction.requested_scopes`
`event.actor.query.acr_values``event.transaction.acr_values`
`event.actor.query.ui_locales``event.transaction.ui_locales`
`event.protocol``event.transaction.protocol`
`context.secrets``event.secrets`
- -### ユーザープロファイルプロパティ - -一般的に、[Auth0ユーザープロファイル構造](/docs/ja-jp/manage-users/user-accounts/user-profiles/user-profile-structure)と一致させるために、`event.user`オブジェクトは、そのプロパティをキャメルケースからスネークケースに変更しています。たとえば、`event.user.appMetadata`は、`event.user.app_metadata`に変更されています。 - -### 副作用の実行 - -ログイン後トリガーのGA前のバージョンでは、副作用は、Actionからオブジェクトを返すことで実行されました。Actions GAでは、これらの変更をカプセル化し、より良いエディター内ヒントおよびインラインドキュメントを提供するために、`api`オブジェクトが用意されています。 - -これらの変更についての詳細およびコード例を確認するには「[ログインフロー：リリース](/docs/ja-jp/releases)」をご覧ください。 - -### スコープの操作 - -Actions BetaでIDおよびアクセストークンスコープの直接操作の提供を試みていますが、Actions GAではこの機能をサポートしていません。 \ No newline at end of file diff --git a/main/docs/releases.mdx b/main/docs/releases.mdx deleted file mode 100644 index ae6a5e0c8f..0000000000 --- a/main/docs/releases.mdx +++ /dev/null @@ -1,294 +0,0 @@ ---- -title: Releases -description: Learn about released versions of Triggers in the Actions Login Flow, including breaking changes and new features. ---- -Features and breaking changes released in versions of Triggers in the Login Flow are listed below. - -## v3 (GA) - -### Post-login - - - -We strongly recommend upgrading and using the latest GA version (v3) of the post-login flow for the best user experience possible. - - - -#### Breaking changes - -* `api.redirect.canRedirect()` marked as deprecated. -* `api.redirect.sendUserTo()` will no longer skip redirecting when in a non-interactive flow. This means that calls to `api.redirect.sendUserTo()` should first check if the redirect is needed before issuing the redirect. Information like `event.authentication.methods` can be consulted to see if a redirect was successfully completed and recorded via `api.authentication.recordMethod()`. Attempting to trigger a redirect in a non-interactive flow will correctly trigger an `interaction_required` error. - -#### New features - -* `event.authentication.methods` may now also contain custom methods completed by users within that session and recorded using `api.authentication.recordMethod()` from the `onContinuePostLogin` handler. -* `api.authentication.recordMethod()` is added as a way to store a record for the completion of a custom method in the user’s session. These APIs allow you to strictly require custom factors for certain scenarios. The user (on a specific device) will be required to complete the custom factor, regardless of whether or not an interactive login is happening. - If the conditions are met for requiring the custom factor and the user’s session doesn’t have a record of its completion, the interactivity of the flow shouldn’t influence whether the factor is required or not. - For example, if you wanted to implement a required custom factor, you would set up the following: - - 1. In `onExecutePostLogin`, search for a record in the `event.authentication.methods` array with the custom method’s identifier URL. If the method is there and has a current enough timestamp, allow the login to continue. Otherwise, trigger a redirect to the URL implementing the custom factor using `api.redirect.sendUserTo()`. Custom data can be encoded into a JWT and signed using `api.redirect.encodeToken()`. - 2. When the user is redirected to `/continue`, the `onContinuePostLogin` handler will be invoked. Within that handler, validate any data coming back from the custom factor (if needed) and signal its completion by calling `api.authentication.recordMethod()`. - -## v2 (GA) - -### Post-login - -#### Breaking changes - -##### Perform side effects - -In the pre-GA version of the post-login trigger, side effects were performed by returning an object from an Action. In Actions GA, an `api` object is provided to encapsulate these changes and provide better in-editor type hints and inline documentation. - -**Update user user_metadata** - -Pre-GA Trigger: - -```js lines -async function myFunction(event, context) { - return { - user: { - userMetadata: { - myParam: "foo" - } - } - }; -} -``` - - - - - - -GA Trigger: - -```js lines -async function onExecutePostLogin(event, api) { - api.user.setUserMetadata('myParam', 'foo'); -} -``` - - - - - - - - -You should not use this method in callbacks because invoking this method won't update metadata immediately. Instead, you can call this method several times throughout multiple Actions in the same flow (metadata set in one Action is applied to the transient object and is therefore available in subsequent Actions), and the engine will aggregate the changes and update the metadata all at once before the flow is completed. - - - -**Update user app_metadata** - -Pre-GA Trigger: - -```js lines -async function myFunction(event, context) { - return { - user: { - appMetadata: { - myParam: "foo" - } - } - }; -} -``` - - - - - - -GA Trigger: - -```js lines -async function onExecutePostLogin(event, api) { - api.user.setAppMetadata('myParam', 'foo'); -} -``` - - - - - - - - -You should not use this method in callbacks because invoking this method won't update metadata immediately. Instead, you can call this method several times throughout multiple Actions in the same flow (metadata set in one Action is applied to the transient object and is therefore available in subsequent Actions), and the engine will aggregate the changes and update the metadata all at once before the flow is completed. - - - -**Deny a login** - -Pre-GA Trigger: - -```js lines -async function myFunction(event, context) { - throw new Error("Access denied."); -} -``` - - - - - - -GA Trigger: - -```js lines -async function onExecutePostLogin(event, api) { - api.access.deny("Access denied."); -} -``` - - - - - - - - -Throwing an error will also deny a login, but calling `api.access.deny` is the preferred approach. - - - -**Add Custom Claims to the Access Token** - -Pre-GA Trigger: - -```js lines -async function myFunc(event, context) { - return { - accessToken: { - customClaims: { - 'https://example.com/custom/claim': 'Custom claim value', - } - } - }; -} -``` - - - - - - -GA Trigger: - -```js lines -async function myFunc(event, api) { - api.accessToken.setCustomClaim('https://example.com/custom/claim', 'Custom claim value'); -} -``` - - - - - - -**Add Custom Claims to the ID Token** - -Pre-GA Trigger: - -```js lines -async function myFunc(event, context) { - return { - idToken: { - customClaims: { - 'https://example.com/custom/claim': 'Custom claim value', - } - } - }; -} -``` - - - - - - -GA Trigger: - -```js lines -async function myFunc(event, api) { - api.idToken.setCustomClaim('https://example.com/custom/claim', 'Custom claim value'); -} -``` - - - - - - -**Dynamically enable multi-factor authentication** - -Pre-GA Trigger: - -```js lines -async function myFunction(event, context) { - return { - command: { - type: "multifactor", - provider: "any" - } - }; -} -``` - - - - - - -GA Trigger: - -```js lines -async function onExecutePostLogin(event, api) { - api.multifactor.enable("duo"); -} -``` - - - - - - -**Redirect the user** - -Pre-GA Trigger: - -```js lines -async function myFunction(event, context) { - return { - command: { - type: "redirect", - url: "https://my-app.example.com" - } - }; -} -``` - - - - - - -GA Trigger: - -```js lines -async function onExecutePostLogin(event, api) { - api.redirect.sendUserTo("https://my-app.example.com"); -} -``` - - - - - - -To ensure parameters are being sent securely and to avoid replay attacks, passing data via redirects has changed significantly in Actions GA. For more information, see [Redirect with Actions](/docs/customize/actions/explore-triggers/signup-and-login-triggers/login-trigger/redirect-with-actions). - -##### Manipulate scopes - -Although we experimented with providing direct manipulation of ID and Access Token scopes during the Actions Beta, we do not support this functionality in Actions GA.