Skip to content

Commit 3694e3b

Browse files
committed
Enhance OAuth 2.0 documentation by adding optional parameters for CIBA flow and clarifying existing properties in af-project-files.adoc.
1 parent 76cd9b2 commit 3694e3b

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
@@ -1039,10 +1039,10 @@ authentication:
10391039
tokenEndpoint: https://oauth.provider.com/token
10401040
clientId: clientId
10411041
clientSecret: clientSecret
1042-
targetType: audience
1042+
targetType: audience # Optional. Logical identifier (audience) or physical URI (resource). Default: audience.
10431043
targetValue: https://api.example.com/agents/my-agent
1044-
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).
1045-
timeout: 5000 #optional, Timeout for token exchange requests in milliseconds. Default: 10000.
1044+
scope: Read # Optional for OAuth 2.0 Token Exchange (RFC 8693). Required for Microsoft Entra OBO and CIBA.
1045+
timeout: 5000 # Optional. Timeout for token exchange requests in milliseconds. Default: 10000.
10461046
----
10471047

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

10621080
The `oauth2-obo` authentication has these properties.
@@ -1074,6 +1092,10 @@ The `oauth2-obo` authentication has these properties.
10741092
|`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
10751093
|`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`
10761094
|`timeout` |Timeout for token exchange requests in milliseconds. |Integer |Positive integer. Default: 10000 |No
1095+
|`enableCIBA` |Enables OAuth 2.0 Token Exchange with CIBA flow. Available only for OAuth 2.0 Token Exchange. |Boolean |`true` | No
1096+
|`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`.
1097+
|`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
1098+
|`indingMessage` |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
10771099
|===
10781100

10791101
[[exchange-json-file-element]]

0 commit comments

Comments
 (0)