Get a Session Key (OAuth)

This method is used to authenticate an external provider id token. Unless otherwise noted, this method must be called before any other web service function, as the X-Session-Key header value is required to call most methods. A successful transaction will receive a 200 status code.

Body Params

The oauth id token logon request data

int32
enum
required

The OAuth provider [1(Google), 4(Microsoft), 5(SecureDocumentDelivery), 6(Apple)]

Allowed:
string
required

The OAuth id token

Responses

400

The OAuthIdTokenLogonRequestData model is required in the request body.

401

The id token is invalid || The provider is invalid || Logon restricted by IP address and user IP address is NULL. || Logon restricted by IP address and user IP address is not in the list of allowed IP addresses. || User disabled.

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json