Exchange must be able to authenticate with your application on behalf of Exchange users that syndicate event or audience data that you provide or consume. The same Exchange users are also valid users of your solution or product.

Exchange requires that users register your solution or product as an Exchange endpoint in their Exchange account. During registration, Exchange requires that Exchange users provide the credentials that they use to access your solution or product. Exchange submits these credentials to authenticate with your application on behalf of the user.

As part of the process to define your Exchange application, you must give Exchange your authentication requirements. Indicate to Exchange the type of access credentials and authentication method that your endpoint requires. You must also indicate how Exchange users can provide their access credentials.

Exchange supports the following authentication methods.

• API key
• Basic
• OAuth
• OAuth with a refresh token

Exchange supports two ways for users to enter their access credentials.

• Direct connect. Exchange displays fields in the endpoint registration wizard to enable users to directly enter their user credentials.
• Instructions only. Exchange displays instructions that you provide. In your instructions, describe the steps that the Exchange user must take to provide their credentials.

The following procedure specifies the API calls that you make to Exchange to indicate your authentication requirements.

• To specify or update the connection information for a deployed application:

  Call: PUT <base URL>/v1/application/{applicationid}/deployment/{deploymentid}/onboarding.

  • Specify how Exchange users enter their user credentials during registration.
    • Direct connect. Specify DIRECTCONNECT as the onboarding type to have Exchange prompt the user to enter credentials in the Exchange user interface. Provide the URL for the provisioning system that accepts the registration request. Optionally, enter any additional instructions that should display to Exchange users during registration.
    • Instructions only. Specify INSTRUCTIONSONLY as the onboarding type to display instructions to the use in the Exchange endpoint wizard. Enter the exact wording that you want to display to Exchange users during registration.
  • Specify the authentication method and provide the required authentication information.
  • Optionally, request that Exchange notify you when Exchange users subscribe to events. Provide a URL to receive the notifications.
• To remove information that defines how to connect to a deployed application:

  Call: DELETE /v1/application/{applicationid}/deployment/{deploymentid}/onboarding.