Skip to content

Commit 5b798ef

Browse files
Merge pull request #611 from mulesoft/W-21887816-new-params-for-OAuth-OBO-policy
W-21887816 new params for OAuth OBO policy
2 parents e895da6 + fc5c8a1 commit 5b798ef

1 file changed

Lines changed: 27 additions & 5 deletions

File tree

modules/ROOT/pages/af-project-files.adoc

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1040,10 +1040,10 @@ authentication:
10401040
tokenEndpoint: https://oauth.provider.com/token
10411041
clientId: clientId
10421042
clientSecret: clientSecret
1043-
targetType: audience
1043+
targetType: audience # Optional. Logical identifier (audience) or physical URI (resource). Default: audience.
10441044
targetValue: https://api.example.com/agents/my-agent
1045-
scope: Read #optional, OAuth 2.0 scope to request. Required for Microsoft Entra OBO (for example, api://downstream-client-id/.default). Optional for OAuth 2.0 Token Exchange (RFC 8693).
1046-
timeout: 5000 #optional, Timeout for token exchange requests in milliseconds. Default: 10000.
1045+
scope: Read # Optional for OAuth 2.0 Token Exchange (RFC 8693). Required for Microsoft Entra OBO and CIBA.
1046+
timeout: 5000 # Optional. Timeout for token exchange requests in milliseconds. Default: 10000.
10471047
----
10481048

10491049
Using Microsoft Entra ID On-Behalf-Of:
@@ -1053,11 +1053,29 @@ Using Microsoft Entra ID On-Behalf-Of:
10531053
authentication:
10541054
kind: oauth2-obo
10551055
flow: microsoft-entra-obo
1056+
tokenEndpoint: https://login.microsoftonline.com/{tenant}/oauth2/v2.0/token
1057+
clientId: clientId
1058+
clientSecret: clientSecret
1059+
scope: api://downstream-client-id/.default # Required for Microsoft Entra OBO flows.
1060+
timeout: 8000 # Optional. Timeout for token exchange requests in milliseconds. Default: 10000.
1061+
----
1062+
1063+
Using OAuth 2.0 Token Exchange with CIBA (client-initiated backchannel authentication):
1064+
1065+
[source,yaml]
1066+
----
1067+
authentication:
1068+
kind: oauth2-obo
1069+
flow: oauth2-token-exchange
10561070
tokenEndpoint: https://oauth.provider.com/token
10571071
clientId: clientId
10581072
clientSecret: clientSecret
1059-
scope: api://downstream-client-id/.default
1060-
timeout: 5000 #optional, Timeout for token exchange requests in milliseconds. Default: 10000.
1073+
scope: openid # Required for CIBA flow.
1074+
enableCIBA: true # Optional. Enables OAuth 2.0 Token Exchange with CIBA flow. Available only for OAuth 2.0 Token Exchange.
1075+
CIBABackchannelEndpoint: https://oauth.provider.com/bc-authorize # Required when enableCIBA is true. The backchannel authentication endpoint.
1076+
loginHintClaim: email # Optional. JWT claim from incoming subject token to send as login_hint in CIBA request. Default: email.
1077+
bindingMessage: "Please approve this request on your device" # Optional. Human-readable message displayed on authentication device.
1078+
timeout: 10000 # Optional. Timeout for token exchange requests in milliseconds. Default: 10000.
10611079
----
10621080

10631081
The `oauth2-obo` authentication has these properties.
@@ -1075,6 +1093,10 @@ The `oauth2-obo` authentication has these properties.
10751093
|`targetValue` |Target audience URI or resource URI for the exchanged token. Required for OAuth 2.0 Token Exchange. |String |Valid URI |Required when using `oauth2-token-exchange` with a target
10761094
|`scope` |OAuth scope to request. Required for Microsoft Entra OBO (e.g. `api://downstream-client-id/.default`). Optional for OAuth 2.0 Token Exchange. |String |Any string |Required for `microsoft-entra-obo`
10771095
|`timeout` |Timeout for token exchange requests in milliseconds. |Integer |Positive integer. Default: 10000 |No
1096+
|`enableCIBA` |Enables OAuth 2.0 Token Exchange with CIBA flow. Available only for OAuth 2.0 Token Exchange. |Boolean |`true` | No
1097+
|`CIBABackchannelEndpoint`` |The backchannel authentication endpoint (`bc-authorize`) used to initiate the CIBA flow. |String | `https://oauth.provider.com/bc-authorize` | Required when *enableCIBA* is `true`.
1098+
|`loginHintClaim` |JWT claim from the incoming subject token to send as `login_hint` in the CIBA request. If no hint is specified, `email` is used. |String |`preferred_username` |No
1099+
|`bindingMessage` |Human-readable message sent as `binding_message` in the CIBA request and displayed on the authentication device. |String |`Please approve the transaction on your device` |No
10781100
|===
10791101

10801102
[[exchange-json-file-element]]

0 commit comments

Comments
 (0)