You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Enhance authentication documentation in af-project-files.adoc by adding detailed property tables for 'basic', 'oauth2-client-credentials', 'apikey-client-credentials', 'in-task-authorization-code', and 'oauth2-obo' types. Updated YAML examples and descriptions for clarity and consistency.
|`apiKey` |The value of the API key. |String |Any string |Yes
977
+
|`headerName` |The name of the header in which to set the key. If not specified, `Authorization` is used. |String |Any string |No
978
+
|===
979
+
927
980
[[in-task-auth]]
928
981
==== In-Task Authorization Code
929
982
983
+
Use `in-task authorization code` when the connection needs secondary credentials obtained during a task using the OAuth 2.0 Authorization Code flow. OAuth2 tokens are extracted from message data and injected into the `Authorization` header for upstream calls. This supports step-up or in-task authentication (for example, when a user must re-authenticate for a sensitive action). For more information about the associated policy, see xref:gateway::policies-outbound-a2a-intask-authorization-code.adoc[].
984
+
930
985
[source,yaml]
931
986
----
932
987
authentication:
@@ -944,10 +999,31 @@ authentication:
944
999
tokenTimeout: 300 #Optional. Timeout in seconds for token requests. Default: 300.
945
1000
----
946
1001
1002
+
The `in-task-authorization-code` authentication has these properties.
|`tokenAudience` |Intended recipient of the token (e.g. agent or API URL). |String |Any string |No
1017
+
|`bodyEncoding` |Encoding for the token request body. |String |`form`, `json`. Default: `form` |No
1018
+
|`tokenTimeout` |Timeout in seconds for token requests. |Integer |Positive integer. Default: 300 |No
1019
+
|`challengeResponseStatusCode` |HTTP status code returned for auth-required challenge responses. Typically 200 for JSON-RPC compatibility. |Integer |HTTP status code. Default: 200 |No
1020
+
|===
1021
+
1022
+
947
1023
[[obo-credential-injection]]
948
1024
==== OAuth 2.0 OBO Credential Injection
949
1025
950
-
This authentication type supports OAuth 2.0 Token Exchange and Microsoft Entra ID On-Behalf-Of protocols.
1026
+
This authentication type supports OAuth 2.0 Token Exchange and Microsoft Entra ID On-Behalf-Of protocols. For more information about the associated policy, see xref:gateway::policies-outbound-oauth-obo.adoc[].
951
1027
952
1028
Using OAuth 2.0 Token Exchange:
953
1029
@@ -977,7 +1053,24 @@ authentication:
977
1053
clientSecret: clientSecret
978
1054
scope: api://downstream-client-id/.default
979
1055
timeout: 5000 #optional, Timeout for token exchange requests in milliseconds. Default: 10000.
980
-
----
1056
+
----
1057
+
1058
+
The `oauth2-obo` authentication has these properties.
|`targetType` |Parameter type for specifying the target service (audience for logical name, resource for physical URI). Used for OAuth 2.0 Token Exchange. |String |`audience`, `resource`. Default: `audience` |No
1070
+
|`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
1071
+
|`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`
1072
+
|`timeout` |Timeout for token exchange requests in milliseconds. |Integer |Positive integer. Default: 10000 |No
0 commit comments