Generate authentication token.

The Dashboard exposes the /api/sso Dashboard API which allows you to generate a temporary authentication token, valid for 60 seconds.

POST /api/sso

Generate authentication token.

cURL

curl --request POST \
  --url https://{tenant}/api/sso \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "DisplayName": "",
  "EmailAddress": "[e-mail]",
  "ForSection": "dashboard",
  "GroupID": "",
  "OrgID": "588b4f0bb275ff0001cc7471",
  "SSOOnlyForRegisteredUsers": false,
  "UserNotAllowed": false
}
'

import requests

url = "https://{tenant}/api/sso"

payload = {
    "DisplayName": "",
    "EmailAddress": "[e-mail]",
    "ForSection": "dashboard",
    "GroupID": "",
    "OrgID": "588b4f0bb275ff0001cc7471",
    "SSOOnlyForRegisteredUsers": False,
    "UserNotAllowed": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    DisplayName: '',
    EmailAddress: '[e-mail]',
    ForSection: 'dashboard',
    GroupID: '',
    OrgID: '588b4f0bb275ff0001cc7471',
    SSOOnlyForRegisteredUsers: false,
    UserNotAllowed: false
  })
};

fetch('https://{tenant}/api/sso', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenant}/api/sso",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'DisplayName' => '',
    'EmailAddress' => '[e-mail]',
    'ForSection' => 'dashboard',
    'GroupID' => '',
    'OrgID' => '588b4f0bb275ff0001cc7471',
    'SSOOnlyForRegisteredUsers' => false,
    'UserNotAllowed' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenant}/api/sso"

	payload := strings.NewReader("{\n  \"DisplayName\": \"\",\n  \"EmailAddress\": \"[e-mail]\",\n  \"ForSection\": \"dashboard\",\n  \"GroupID\": \"\",\n  \"OrgID\": \"588b4f0bb275ff0001cc7471\",\n  \"SSOOnlyForRegisteredUsers\": false,\n  \"UserNotAllowed\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{tenant}/api/sso")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"DisplayName\": \"\",\n  \"EmailAddress\": \"[e-mail]\",\n  \"ForSection\": \"dashboard\",\n  \"GroupID\": \"\",\n  \"OrgID\": \"588b4f0bb275ff0001cc7471\",\n  \"SSOOnlyForRegisteredUsers\": false,\n  \"UserNotAllowed\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}/api/sso")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"DisplayName\": \"\",\n  \"EmailAddress\": \"[e-mail]\",\n  \"ForSection\": \"dashboard\",\n  \"GroupID\": \"\",\n  \"OrgID\": \"588b4f0bb275ff0001cc7471\",\n  \"SSOOnlyForRegisteredUsers\": false,\n  \"UserNotAllowed\": false\n}"

response = http.request(request)
puts response.read_body

200

{
  "Message": "SSO Nonce created.",
  "Meta": "YTNiOGUzZjctYWZkYi00OTNhLTYwODItZTAzMDI3MjM0OTEw",
  "Status": "OK"
}

{
  "Message": "Request body malformed.",
  "Meta": null,
  "Status": "Error"
}

{
  "Message": "Not authorised",
  "Meta": null,
  "Status": "Error"
}

{
  "Message": "SSO not enabled for org.",
  "Meta": null,
  "Status": "Error"
}

{
  "Message": "Failed to read response body, body empty.",
  "Meta": null,
  "Status": "Error"
}

Authorizations

Authorization · string · header · required

The Tyk Dashboard API Access Credentials

Body

application/json

DisplayName · string

EmailAddress · string

ForSection · enum<string>

Available options: dashboard, portal

GroupID · string

OrgID · string

SSOOnlyForRegisteredUsers · boolean

UserNotAllowed · boolean

Response

200

application/json

Created successfully.

ID · string

Message · string

Meta · any

Status · string