Get an identity by GVC and name
curl --request GET \
--url https://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name} \
--header 'Authorization: <api-key>'import requests
url = "https://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name}', 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://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name}",
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: <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://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("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://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"kind": "<string>",
"version": 123,
"description": "<string>",
"tags": {},
"created": "2023-11-07T05:31:56Z",
"lastModified": "2023-11-07T05:31:56Z",
"links": [
{
"rel": "<string>",
"href": "<string>"
}
],
"aws": {
"cloudAccountLink": "<string>",
"policyRefs": [
"<string>"
],
"trustPolicy": {
"Version": "2012-10-17",
"Statement": [
{}
]
},
"roleName": "<string>"
},
"gcp": {
"cloudAccountLink": "<string>",
"scopes": [
"<string>"
],
"serviceAccount": "<string>",
"bindings": [
{
"resource": "<string>",
"roles": [
"<string>"
]
}
]
},
"azure": {
"cloudAccountLink": "<string>",
"roleAssignments": [
{
"scope": "<string>",
"roles": [
"<string>"
]
}
]
},
"ngs": {
"cloudAccountLink": "<string>",
"pub": {
"allow": [
"<string>"
],
"deny": [
"<string>"
]
},
"sub": {
"allow": [
"<string>"
],
"deny": [
"<string>"
]
},
"resp": {
"max": 123,
"ttl": "<string>"
},
"subs": 123,
"data": 123,
"payload": 123
},
"networkResources": [
{
"name": "<string>",
"agentLink": "<string>",
"IPs": [
"<string>"
],
"FQDN": "<string>",
"resolverIP": "<string>",
"ports": [
123
]
}
],
"nativeNetworkResources": [
{
"name": "<string>",
"FQDN": "<string>",
"ports": [
123
],
"awsPrivateLink": {
"endpointServiceName": "<string>"
},
"gcpServiceConnect": {
"targetService": "<string>"
}
}
],
"memcacheAccess": [
{
"clusterLink": "<string>",
"role": "readWrite"
}
],
"spicedbAccess": [
{
"clusterLink": "<string>"
}
],
"status": {
"objectName": "<string>",
"aws": {
"lastError": "<string>",
"usable": true
},
"gcp": {
"lastError": "<string>",
"usable": true
},
"azure": {
"lastError": "<string>",
"usable": true
}
},
"gvc": "<string>"
}{
"status": 123,
"message": "<string>",
"code": "<string>",
"details": {},
"id": "<string>"
}Identity
Get an identity by GVC and name
Response will contain the requested identity if the caller is authorized to view it
GET
/
org
/
{org}
/
gvc
/
{gvc}
/
identity
/
{name}
Get an identity by GVC and name
curl --request GET \
--url https://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name} \
--header 'Authorization: <api-key>'import requests
url = "https://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name}', 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://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name}",
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: <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://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("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://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"kind": "<string>",
"version": 123,
"description": "<string>",
"tags": {},
"created": "2023-11-07T05:31:56Z",
"lastModified": "2023-11-07T05:31:56Z",
"links": [
{
"rel": "<string>",
"href": "<string>"
}
],
"aws": {
"cloudAccountLink": "<string>",
"policyRefs": [
"<string>"
],
"trustPolicy": {
"Version": "2012-10-17",
"Statement": [
{}
]
},
"roleName": "<string>"
},
"gcp": {
"cloudAccountLink": "<string>",
"scopes": [
"<string>"
],
"serviceAccount": "<string>",
"bindings": [
{
"resource": "<string>",
"roles": [
"<string>"
]
}
]
},
"azure": {
"cloudAccountLink": "<string>",
"roleAssignments": [
{
"scope": "<string>",
"roles": [
"<string>"
]
}
]
},
"ngs": {
"cloudAccountLink": "<string>",
"pub": {
"allow": [
"<string>"
],
"deny": [
"<string>"
]
},
"sub": {
"allow": [
"<string>"
],
"deny": [
"<string>"
]
},
"resp": {
"max": 123,
"ttl": "<string>"
},
"subs": 123,
"data": 123,
"payload": 123
},
"networkResources": [
{
"name": "<string>",
"agentLink": "<string>",
"IPs": [
"<string>"
],
"FQDN": "<string>",
"resolverIP": "<string>",
"ports": [
123
]
}
],
"nativeNetworkResources": [
{
"name": "<string>",
"FQDN": "<string>",
"ports": [
123
],
"awsPrivateLink": {
"endpointServiceName": "<string>"
},
"gcpServiceConnect": {
"targetService": "<string>"
}
}
],
"memcacheAccess": [
{
"clusterLink": "<string>",
"role": "readWrite"
}
],
"spicedbAccess": [
{
"clusterLink": "<string>"
}
],
"status": {
"objectName": "<string>",
"aws": {
"lastError": "<string>",
"usable": true
},
"gcp": {
"lastError": "<string>",
"usable": true
},
"azure": {
"lastError": "<string>",
"usable": true
}
},
"gvc": "<string>"
}{
"status": 123,
"message": "<string>",
"code": "<string>",
"details": {},
"id": "<string>"
}Authorizations
serviceAccountKeyjwt
Service account key can be used as API keys
Response
Success
Maximum string length:
64Maximum string length:
250Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I