Exchange a valid bearer token for an authenticated browser session

This endpoint takes an authentication bearer token in the header, or as the query parameter “access_token”. However, for security purposes, it is recommended that the token is passed in by using the POST API call.

It uses “scoped=true” as a query parameter optionally. When “scoped=true” is given, the cookie created is be used to login to app scoped application. If “scoped=true” is not given, the cookie created is used to login to non-app scoped application.

It uses “redirect_url” as a query parameter as optionally. When “redirect_url” is given, the call will redirect to the redirect URL with the authenticated session.

Query Params
boolean

If true, it creates a session for app scoped application login. If false, it creates a session for non app scoped application login

string

The access token used to create the authenticated browser session. Useful for testing, but it is recommended that the token be passed in the Authorization header, as URL parameters can be intercepted.

string

The URL where the request will be redirected after the session is created. The URL should be URL encoded or the authenticated redirect may fail. An error is returned if the URL is not allowed.
A valid URL must match one of these conditions:
- Starts with the tenant name, "https://tenantname.com"
- Is a relative path, it starts with "/"
- It matches one of the URLs in the list of allowed URL in the Session Exchange management API

Responses
201

An access token was successfully exchanged for an IBM Security Verify session credential.

302

Returned when the "redirect_url" parameter is passed in. After a successful token exchange the browser will be redirected to the redirect_url

Language
URL
Choose an example:
*/*