Skip to content

Commit ea65c73

Browse files
Merge branch 'latest' into W-20701354-acb-troubleshooting-update
2 parents a85ab59 + 517ae4f commit ea65c73

1 file changed

Lines changed: 49 additions & 7 deletions

File tree

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

Lines changed: 49 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -738,7 +738,7 @@ connections:
738738
ref:
739739
name: my-openAI
740740
spec:
741-
url: ${}
741+
url: https://api.openai.com/v1/
742742
configuration:
743743
apiKey: ${openai.apiKey}
744744
@@ -748,13 +748,21 @@ connections:
748748
name: talent-pool-mcp
749749
spec:
750750
url: https://talent-pool-mcp-server-inkbh1.paga8m.usa-w1.cloudhub.io/
751+
authentication:
752+
kind: apiKey
753+
apiKey: ${talentPool.apiKey} # Define variable in exchange.json
754+
headerName: X-MCP-API-Key # Optional, defaults to Authorization
751755
752756
slack-mcp:
753757
kind: mcp
754758
ref:
755759
name: slack-mcp
756760
spec:
757761
url: https://slack-mcp-server-inkbh1.paga8m.usa-w1.cloudhub.io/
762+
authentication:
763+
kind: apiKey
764+
apiKey: ${slack.apiKey} # Define variable in exchange.json
765+
headerName: X-API-Key
758766
----
759767

760768
The `connections` element has these properties.
@@ -847,41 +855,75 @@ Connection authentication is always expressed in accordance with https://swagger
847855

848856
These examples show how to define each type in YAML.
849857

858+
Both agents and MCP servers support the same authentication types with custom header capabilities API Key Authentication and Basic Authentication.
859+
860+
850861
[[basic-authentication]]
851-
==== Basic authentication
862+
==== Basic Authentication
852863

853864
[source,yaml]
854865
----
855866
authentication:
856-
type: basic
867+
Kind: basic
868+
username: "username"
869+
password: "password"
870+
----
871+
872+
Using custom header:
873+
874+
[source,yaml]
875+
----
876+
kind: basic
857877
username: "username"
858878
password: "password"
879+
headerName: X-API-Authorization # Custom header instead of default "Authorization"
859880
----
860881

861882
[[oauth-client-credentials]]
862-
==== OAuth 2.0 client credentials
883+
==== OAuth 2.0 Client Credentials
863884

864885
[source,yaml]
865886
----
866887
authentication:
867-
type: oauth2-client-credentials
888+
kind: oauth2-client-credentials
868889
clientId: "client_id"
869890
clientSecret: "client_secret"
870891
tokenUrl: "https://oauth.provider.com/token"
871892
scopes: ["read", "write"] # Optional
872893
----
873894

874895
[[anypoint-client-credentials]]
875-
==== Anypoint client credentials
896+
==== Anypoint Client Credentials
876897

877898
[source,yaml]
878899
----
879900
authentication:
880-
type: apikey-client-credentials
901+
kind: apikey-client-credentials
881902
clientId: "client_id"
882903
clientSecret: "client_secret"
883904
----
884905

906+
[[api-key]]
907+
==== API Key Authentication
908+
909+
[source,yaml]
910+
----
911+
authentication:
912+
kind: api-key
913+
apiKey: ${agent.apiKey} # Define variable in exchange.json
914+
headerName: X-API-Key # Optional, defaults to Authorization
915+
----
916+
917+
Using custom header:
918+
919+
[source,yaml]
920+
----
921+
authentication:
922+
kind: apiKey
923+
apiKey: ${agent.apiKey}
924+
headerName: X-Custom-Auth-Token # Custom header name
925+
----
926+
885927
[[exchange-json-file-element]]
886928
== exchange.json File Element
887929

0 commit comments

Comments
 (0)