Authentication

User ID and User Key pair

Authentication with userid and userkey pair. These values can be found on the My Account page in the UI. Learn more about userkey management in this guide.

<?xml version="1.0"?>
<query>
    <userid>[UserID]</userid> <!-- required-->
    <userkey>[UserKey]</userkey> <!-- required-->
    <action>[Action]</action>
    <!-- query params -->
</query>

{
    "query": {
        "userid": "[UserID]", // required
        "userkey": "[UserKey]", // required
        "action": "[Action]" // required
        // query params
    }
}

Parameter	Description	Allowed Values	Default Value
userid	A unique user identifier.	Positive integer number	none
userkey	A user’s unique authentication key string. Created automatically when a user is created.	String	none

OAuth 2.0 API Token Authentication

Authentication with a Refresh Token previously fetched from OIDC Identity Provider. For now, we support Okta as OIDC Identity Provider. Learn more about how to link OIDC Issuer and how to get Refresh Token in the related guide.

<?xml version="1.0"?>
<query>
    <oidc_refresh_token>[RefreshToken]</oidc_refresh_token> <!-- required-->
    <action>[Action]</action>
    <!-- query params -->
</query>

{
    "query": {
        "oidc_refresh_token": "[RefreshToken]", // required
        "action": "[Action]" // required
        // query params
    }
}

Parameter	Description	Allowed Values	Default Value
oidc_refresh_token	Refresh Token fetched from the OIDC Identity Provider.	String	none