Get a single API mapping.
curl --request GET \
--url https://{tenant}/api/clientidps/{id}/mappings/{apiId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{tenant}/api/clientidps/{id}/mappings/{apiId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{tenant}/api/clientidps/{id}/mappings/{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}/api/clientidps/{id}/mappings/{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 => [
"Authorization: Bearer <token>"
],
]);
$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}/api/clientidps/{id}/mappings/{apiId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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}/api/clientidps/{id}/mappings/{apiId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}/api/clientidps/{id}/mappings/{apiId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"scope_to_policy": {
"read": "665d51505715ec2d76022c87",
"write": "5e4f2c1a3b6d7e8f9a0b1c2d"
}
}Client IdPs
Get a single API mapping.
Returns the scope mapping for the given API within the client IdP.
GET
/
api
/
clientidps
/
{id}
/
mappings
/
{apiId}
Get a single API mapping.
curl --request GET \
--url https://{tenant}/api/clientidps/{id}/mappings/{apiId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{tenant}/api/clientidps/{id}/mappings/{apiId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{tenant}/api/clientidps/{id}/mappings/{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}/api/clientidps/{id}/mappings/{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 => [
"Authorization: Bearer <token>"
],
]);
$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}/api/clientidps/{id}/mappings/{apiId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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}/api/clientidps/{id}/mappings/{apiId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenant}/api/clientidps/{id}/mappings/{apiId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"scope_to_policy": {
"read": "665d51505715ec2d76022c87",
"write": "5e4f2c1a3b6d7e8f9a0b1c2d"
}
}Authorizations
The Tyk Dashboard API Access Credentials
Path Parameters
Internal record ID hex or custom client_idp_id.
The API id.
Response
Mapping fetched.
Scope-to-policy mapping for a single API.
Map of scope name → policy ID.
Show child attributes
Show child attributes
Example:
{
"read": "665d51505715ec2d76022c87",
"write": "5e4f2c1a3b6d7e8f9a0b1c2d"
}
Was this page helpful?
⌘I