curl --request GET \
--url https://universal.rollout.com/api/credentials \
--header 'Authorization: Bearer <token>'import requests
url = "https://universal.rollout.com/api/credentials"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://universal.rollout.com/api/credentials', 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://universal.rollout.com/api/credentials",
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://universal.rollout.com/api/credentials"
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://universal.rollout.com/api/credentials")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://universal.rollout.com/api/credentials")
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[
{
"id": "<string>",
"createdAt": "<string>",
"appKey": "<string>",
"credentialKey": "<string>",
"plan": "<string>",
"invalidatedAt": "<string>",
"lastInboundSyncCompletedAt": "<string>",
"numInboundSyncFailedAttempts": 123,
"entitiesToSync": {},
"label": "<string>",
"avatar": "<string>",
"permissions": {},
"requirements": {},
"data": {}
}
]{
"errors": [
{
"message": "<string>"
}
]
}List Credentials
Lists the consumer’s valid credentials.
Setting includeData=true additionally requires a token whose rollout.com.scopes claim contains credentials:read_data, and the request must not originate from browser JavaScript. Without includeData, no scope beyond a valid consumer token is needed.
curl --request GET \
--url https://universal.rollout.com/api/credentials \
--header 'Authorization: Bearer <token>'import requests
url = "https://universal.rollout.com/api/credentials"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://universal.rollout.com/api/credentials', 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://universal.rollout.com/api/credentials",
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://universal.rollout.com/api/credentials"
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://universal.rollout.com/api/credentials")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://universal.rollout.com/api/credentials")
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[
{
"id": "<string>",
"createdAt": "<string>",
"appKey": "<string>",
"credentialKey": "<string>",
"plan": "<string>",
"invalidatedAt": "<string>",
"lastInboundSyncCompletedAt": "<string>",
"numInboundSyncFailedAttempts": 123,
"entitiesToSync": {},
"label": "<string>",
"avatar": "<string>",
"permissions": {},
"requirements": {},
"data": {}
}
]{
"errors": [
{
"message": "<string>"
}
]
}Authorizations
Consumer JWT minted by the tenant's backend
Query Parameters
Include the decrypted credential data in each result. Requires a token carrying the credentials:read_data scope, sent from a server-to-server request; otherwise the request fails with 403.
Response
Response for status 200
Show child attributes
Show child attributes
What this credential can do, per entity and operation. Omitted when the connector checks the credential's permissions but no result is available yet.
Show child attributes
Show child attributes
What writing each entity needs beyond the request schema, per operation. Entities without such rules are left out.
Show child attributes
Show child attributes
Show child attributes
Show child attributes