Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add Agama section for consent flows #10765

Merged
merged 1 commit into from
Jan 30, 2025
Merged

docs: add Agama section for consent flows #10765

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/janssen-server/developer/agama/native-applications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ From here onwards, requests must contain the following parameters:
|-|-|
|`use_auth_session`|true|
|`auth_session`|The value obtained in the previous request|
|`data`|A JSON object value which will become the result of the RRF instruction the flow is paused at|
|`data`|A JSON object that will become the result of the RRF instruction the flow is paused at. If the given RRF has no assignment associated, an empty object must be passed: `{ }`|

!!! Note
Whenever a request is missing the `auth_session` param, it is assumed the [inital request](#initial-request) is being attempted.
Expand Down
35 changes: 27 additions & 8 deletions docs/script-catalog/consent_gathering/consent-gathering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,6 @@ acr2 - consentScript2
acrN - consentScriptN
```

**Agama**

If Agama Consent is used then typically `acrToAgamaConsentFlowMapping` AS configuration property has to be used as well
to determine consent flow.
`acrToAgamaConsentFlowMapping` - The acr mapping to agama consent flow name. When AS meets acr it tries to match agama consent name and set it into session attributes under `consent_flow` name.
This makes it available for main Agama Consent script, so it knows which flow to invoke.


## Interface
The consent gathering script implements the [ConsentGathering](https://github.com/JanssenProject/jans/blob/main/jans-core/script/src/main/java/io/jans/model/custom/script/type/authz/ConsentGatheringType.java) interface. This extends methods from the base script type in addition to adding new methods:

Expand Down Expand Up @@ -243,3 +235,30 @@ public class ConsentGathering implements ConsentGatheringType {
}
}
```

## Writing consent flows using Agama

Besides scripts, developers can also use [Agama](../../agama/introduction.md) for writing consent flows. For this, enable the custom script named `agama_consent` and update the authentication server configuration accordingly using `acrToConsentScriptNameMapping` and `acrToAgamaConsentFlowMapping` properties. Suppose the below configuration:

```
"consentGatheringScriptBackwardCompatibility": false,
"acrToConsentScriptNameMapping": {
"basic": "consent_gathering",
"otp": "agama_consent",
"agama_co.acme.myflow": "my_consent_gathering",
"agama_co.acme.mysuperflow": "agama_consent"
},
"acrToAgamaConsentFlowMapping": {
"otp": "io.jans.consent.A",
"agama_co.acme.mysuperflow": "io.jans.consent.B",
}
```

This is how consent will work depending on the authentication request issued:

- With `acr_values=basic`, the consent script named `consent_gathering` will be executed - as long as it is already enabled, of course. This is the default Consent script bundled with the server
- With `acr_values=otp`, the Agama flow `io.jans.consent.A` will be launched for consent
- With `acr_values=agama_co.acme.myflow`, the consent script named `my_consent_gathering` will be executed - assuming it exists and is enabled
- With `agama_co.acme.mysuperflow`, the Agama flow `io.jans.consent.B` will be launched for consent

Agama flows used for consent can be built using the same approach and tooling used for regular authentication flows. Note however there is no need to pass a user identity in the `Finish` instruction. If passed, it will be ignored, thus, it suffices to end a consent flow with `Finish false/true`.
Loading