Skip to content

Commit

Permalink
Link to AccountConnection documentation for connection names
Browse files Browse the repository at this point in the history
There are two parts to implementing Connection Names:
1) Define and use the variables that vary based on connection in the AuthProcess
2) Define the Connection Names to present in the UI, using the AccountConnection section

This adds a link to the second part, from the docs on the first part.
  • Loading branch information
joshuaflanagan committed Dec 18, 2023
1 parent 9f3a405 commit 80dcd61
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions oauth/connection-names.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ In order to support multiple environments, your `AuthProcess` definition must
include a `connections` section. It requires two attributes: `connection_names`
and `default_connection_name`.

> This page only describes the OAuth aspects of connection names. If you want
the user to be presented with a choice of connections in the UI, you must also
declare the possible connection names in the `OrderSources.AccountConnection` section.
See the [Metadata Definition documentation](../../orders).

The `default_connection_name` must define the connection to use when one is
not specified by the end user. In some situations, the end user will not have
a choice, so the connection they use is driven by the `default_connection_name`.
Expand Down

0 comments on commit 80dcd61

Please sign in to comment.