Skip to content

Commit

Permalink
Merge pull request #4798 from malithie/actions-docs
Browse files Browse the repository at this point in the history
Update timelines.
  • Loading branch information
himeshsiriwardana authored Oct 2, 2024
2 parents bcc55e0 + 1c3c9a7 commit 6f88114
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ You can use this functionality to:

- Add, modify, or remove scopes.
- Add, modify, or remove audience values.
- Modify or remove [OIDC scopes]({{base_path}}/guides/users/attributes/manage-scopes/) incorporated into the access token.
- Modify or remove user attributes incorporated into the access token.
- Add custom claims (only string, number, boolean, and string type arrays are allowed).
- Update the validity period of the access token.

Expand Down Expand Up @@ -345,7 +345,7 @@ The response can have two possible states: <code>SUCCESS</code> and <code>ERROR<
<code>ERROR</code>: Indicates a failure in processing, accompanied by an error message that should be communicated to the application. This error message should adhere to OAuth 2.0 error response definitions to ensure compliance. However, it is your responsibility to ensure this compliance when extending the flow.

!!! note
Currently, <code>ERROR</code> responses are not communicated back to the client, but this functionality is planned for inclusion by September 2024.
Currently, <code>ERROR</code> responses are not communicated back to the client, but this functionality is planned for inclusion by end October 2024.

#### Response for SUCCESS state:

Expand Down Expand Up @@ -407,6 +407,6 @@ Http Status Code: 400, 401 or 500
</table>

!!! note
Currently, <code>ERROR</code> responses are not communicated back to the client, but this functionality is planned for inclusion by September 2024.
Currently, <code>ERROR</code> responses are not communicated back to the client, but this functionality is planned for inclusion by end October 2024.

If the defined error response is not received, or if the external service fails to respond, this is identified as an error in executing the action. In such cases, the flow will proceed as if the action was not applied, ensuring that the process continues without disruption.
12 changes: 6 additions & 6 deletions en/includes/guides/customize/actions/understanding-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The capabilities of an action are determined by its execution point within the {
{{product_name}} defines several types of actions, each tailored to customize a specific flow within the product. While all action types use the same general syntax for requests and responses exchanged between {{product_name}} and the external web service, they differ in the specifics of the JSON objects involved. When implementing your external service, you must develop your code according to the REST API contract associated with the type of action you are using. The following flows support customization with custom code.

!!! note
Currently, the product supports only the <code>pre issue access token</code> trigger. The other action types listed below are planned for inclusion by September 2024.
Currently, the product supports only the <code>pre issue access token</code> trigger. The other action types listed below are planned for inclusion by early December 2024.

<table>
<thead>
Expand All @@ -24,7 +24,7 @@ The capabilities of an action are determined by its execution point within the {
<tr class="odd">
<td>Login</td>
<td>Authenticate</td>
<td>October 2024</td>
<td>Early November 2024</td>
<td>
<ul>
<li><p>Call an external service to authenticate the user.</p></li>
Expand All @@ -48,7 +48,7 @@ The capabilities of an action are determined by its execution point within the {
<tr class="odd">
<td>Registration</td>
<td>Pre registration</td>
<td>November 2024</td>
<td>Early December 2024</td>
<td>
<ul>
<li><p>Deny registration by location.</p></li>
Expand All @@ -61,7 +61,7 @@ The capabilities of an action are determined by its execution point within the {
<tr class="even">
<td>Password update</td>
<td>Pre password update</td>
<td>October 2024</td>
<td>Early November 2024</td>
<td>
<ul>
<li><p>Challenge with an additional verification factor before allowing to update password.</p></li>
Expand All @@ -72,7 +72,7 @@ The capabilities of an action are determined by its execution point within the {
<tr class="odd">
<td>Profile update</td>
<td>Pre profile update</td>
<td>November 2024</td>
<td>Early December 2024</td>
<td>
<ul>
<li><p>Challenge with an additional verification factor before allowing to update sensitive attributes.</p></li>
Expand Down Expand Up @@ -183,6 +183,6 @@ Requests will not be retried if the external service responds with HTTP status c
### Troubleshooting

!!! note
Troubleshooting logs are not yet incorporated but are planned for inclusion by end August 2024.
Troubleshooting logs are not yet incorporated but are planned for inclusion by end October 2024.


0 comments on commit 6f88114

Please sign in to comment.