Client

Used to interact with the Client Object.

Get Current Client

Returns the current client that is present either in the browser cookies or authorization header.

SecurityDevBrowser
Responses
200

Returns the current session object.

400

Request was not successful

401

Request was not successful

get/v1/client
Response samples
application/json
{
  • "client": { },
  • "response": {
    }
}

Create New Client

Creates a new Client and sets it either in the response cookies or the response authorization header.

SecurityDevBrowser
Responses
200

Returns the current session object.

307

Redirect, no body.

put/v1/client
Response samples
application/json
{
  • "client": { },
  • "response": {
    }
}

Create New Client

Creates a new Client and sets it either in the response cookies or the response authorization header.

SecurityDevBrowser
Responses
200

Returns the current session object.

307

Redirect, no body.

post/v1/client
Response samples
application/json
{
  • "client": { },
  • "response": {
    }
}

Delete Client's Sessions

Ends all Sessions of the Current Client

SecurityDevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Responses
200

Returns the response for DELETE session object.

307

Redirect, no body.

404

Request was not successful

delete/v1/client
Response samples
application/json
{
  • "response": {
    },
  • "client": { }
}

Generate and returns a new session token for a given client.

When the authentication status cannot be determined from the current session token, we initiate a handshake to refresh the token and send it back to the application. Called in server environments.

SecurityDevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
query Parameters
redirect_url
string

The URL to redirect back to after the handshake

Responses
307

Redirect

400

Request was not successful

403

Request was not successful

422

Request was not successful

500

Request was not successful

get/v1/client/handshake
Response samples
application/json
{
  • "errors": [
    ],
  • "meta": { }
}