Skip to main content
GET
Generate OAuth window URI

Authorizations

MD-SESSION-TOKEN
string
header
required

MX Session Token

  • Request an API token using the read API token endpoint in the MX SSO API.
  • Exchange an API token for a session token.
    • A session token is obtained by sending a POST request to /sessions
    • The session token will be used in each request made for the user. It should be passed in an MD-SESSION-TOKEN HTTP header as shown below.
    • This session token is valid for 30 minutes from the time it was created. The 30 minute expiration counter is refreshed with each call.
    • If you send a request with an expired session token you'll receive an error code of 4011.

In documentation code examples, replace <API_KEY_VALUE> with the session token.

Path Parameters

member_guid
string
required

The unique identifier for the member. Defined by MX.

Query Parameters

client_redirect_url
string

A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with oauth_referral_source as APP or is_mobile_webview as true.

referral_source
string

Must be either BROWSER or APP depending on the implementation. Defaults to BROWSER.

ui_message_webview_url_scheme
string

A scheme for routing the user back to the application state they were previously in.

skip_aggregation
string

Setting this parameter to true will prevent the member from automatically aggregating after being redirected from the authorization page.

Response

200 - application/vnd.mx.nexus.v1+json

OK