List oAuth clients

OAuth Clients are organised by API ID, and therefore are queried as such.

GET /tyk/oauth/clients/{apiID}

List oAuth clients

cURL

curl --request GET \
  --url https://{tenant}/tyk/oauth/clients/{apiID} \
  --header 'X-Tyk-Authorization: <api-key>'

import requests

url = "https://{tenant}/tyk/oauth/clients/{apiID}"

headers = {"X-Tyk-Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Tyk-Authorization': '<api-key>'}};

fetch('https://{tenant}/tyk/oauth/clients/{apiID}', 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}/tyk/oauth/clients/{apiID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Tyk-Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{tenant}/tyk/oauth/clients/{apiID}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Tyk-Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{tenant}/tyk/oauth/clients/{apiID}")
  .header("X-Tyk-Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}/tyk/oauth/clients/{apiID}")

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

request = Net::HTTP::Get.new(url)
request["X-Tyk-Authorization"] = '<api-key>'

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

200

[
  {
    "api_id": "b84fe1a04e5648927971c0557971565c",
    "client_id": "2a06b398c17f46908de3dffcb71ef87df",
    "description": "google client",
    "meta_data": {
      "user_id": "362b3fb9a1d5e4f00017226f5"
    },
    "redirect_uri": "https://httpbin.org/ip",
    "secret": "MmQwNTI5NGQtYjU0YS00NjMyLWIwZjktNTZjY2M1ZjhjYWY0"
  }
]

{
  "message": "Attempted administrative access with invalid or missing key!",
  "status": "error"
}

Authorizations

X-Tyk-Authorization · string · header · required

Api key

Path Parameters

apiID · string · required

The API ID

Response

200

application/json

Get OAuth client details or a list of OAuth clients

api_id · string

Example:

"keyless"

client_id · string

Example:

"2a06b398c17f46908de3dffcb71ef87b"

description · string

Example:

"google client login"

meta_data · object | null

Show child attributes

policy_id · string

redirect_uri · string

Example:

"https://httpbin.org/ip"

secret · string

Example:

"MmQwNTI5NGQtYjU0YS00NjMyLWIwZjktNTZjY2M1ZjhjYWY0"