Skip to content

Commit 5b7f720

Browse files
committed
Add In-Task Authorization Code and OAuth 2.0 OBO Credential Injection sections to af-project-files.adoc
Introduced new authentication configurations for in-task authorization and OAuth 2.0 On-Behalf-Of credential injection, including detailed YAML examples for implementation.
1 parent 8198c2b commit 5b7f720

1 file changed

Lines changed: 55 additions & 0 deletions

File tree

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

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -924,6 +924,61 @@ authentication:
924924
headerName: X-Custom-Auth-Token # Custom header name
925925
----
926926

927+
[[in-task-auth]]
928+
==== In-Task Authorization Code
929+
930+
[source,yaml]
931+
----
932+
authentication:
933+
kind: in-task-authorization-code
934+
secondaryAuthProvider: providerName
935+
authorizationEndpoint: https://oauth.provider.com/authorize
936+
tokenEndpoint: https://oauth.provider.com/token
937+
scopes: Read
938+
redirectUri: https://oauth.provider.com/callback
939+
responseType: code
940+
tokenAudience: https://api.example.com/agents/my-agent
941+
codeChallengeMethod: S256
942+
bodyEncoding: form
943+
challengeResponseStatusCode: 200 #Optional, Status code for challenge response. Default: 200.
944+
tokenTimeout: 300 #Optional. Timeout in seconds for token requests. Default: 300.
945+
----
946+
947+
[[obo-credential-injection]]
948+
==== OAuth 2.0 OBO Credential Injection
949+
950+
This authentication type supports OAuth 2.0 Token Exchange and Microsoft Entra ID On-Behalf-Of protocols.
951+
952+
Using OAuth 2.0 Token Exchange:
953+
954+
[source,yaml]
955+
----
956+
authentication:
957+
kind: oauth2-obo
958+
flow: oauth2-token-exchange
959+
tokenEndpoint: https://oauth.provider.com/token
960+
clientId: clientId
961+
clientSecret: clientSecret
962+
targetType: audience
963+
targetValue: https://api.example.com/agents/my-agent
964+
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).
965+
timeout: 50000 #optional, Timeout for token exchange requests in milliseconds. Default: 10000.
966+
----
967+
968+
Using Microsoft Entra ID On-Behalf-Of:
969+
970+
[source,yaml]
971+
----
972+
authentication:
973+
kind: oauth2-obo
974+
flow: microsoft-entra-obo
975+
timeout: 50000 #optional, Timeout for token exchange requests in milliseconds. Default: 10000.
976+
tokenEndpoint: https://oauth.provider.com/token
977+
clientId: clientId
978+
clientSecret: clientSecret
979+
scope: api://downstream-client-id/.default
980+
----
981+
927982
[[exchange-json-file-element]]
928983
== exchange.json File Element
929984

0 commit comments

Comments
 (0)