Request oauth window uri

This endpoint will generate an oauth_window_uri for the specified member.

GET

/users/{user_identifier}/members/{member_identifier}/oauth_window_uri

Path Parameters

Field	Required	Type
member_identifier Use either the member id you defined or the MX-defined member guid. See MX-Defined GUIDs vs IDs Defined by You.	Required	String
user_identifier Use either the user id you defined or the MX-defined user guid. See MX-Defined GUIDs vs IDs Defined by You​.	Required	String

Query Parameters

Field	Required	Type
client_redirect_url A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with referral_source=APP.	Optional	String
enable_app2app This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to true. When set to false, any oauth_window_uri generated will not direct the end user to the institution's mobile application. This setting is not persistent. This setting currently only affects Chase institutions.	Optional	String
referral_source Must be either BROWSER or APP depending on the implementation. Defaults to BROWSER.	Optional	String
skip_aggregation Setting this parameter to true will prevent the member from automatically aggregating after being redirected from the authorization page.	Optional	Boolean
ui_message_webview_url_scheme A scheme for routing the user back to the application state they were previously in. Only available with referral_source=APP.	Optional	String

Header Parameters

Field	Required	Type
Accept-Version MX Platform API version.	Required	String

Loading...