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

curl --request GET \
  --url https://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name} \
  --header 'Authorization: <api-key>'

200

{
  "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>"
    }
  ],
  "spicedbAccess": [
    {
      "clusterLink": "<string>"
    }
  ],
  "status": {
    "objectName": "<string>",
    "aws": {
      "lastError": "<string>",
      "usable": true
    },
    "gcp": {
      "lastError": "<string>",
      "usable": true
    },
    "azure": {
      "lastError": "<string>",
      "usable": true
    }
  },
  "gvc": "<string>"
}

Authorizations

serviceAccountKeyjwt

Authorization · string · header · required

Service account key can be used as API keys

Path Parameters

org · string · required

gvc · string · required

name · string · required

Response

200

application/json

Success

id · string · read-only

name · string

Maximum string length: 64

kind · string · read-only

version · integer · read-only

description · string

Maximum string length: 250

tags · object

created · string<date-time> · read-only

lastModified · string<date-time> · read-only

links · object[] · read-only

Show child attributes

aws · object

Show child attributes

gcp · object

Show child attributes

azure · object

Show child attributes

ngs · object

Show child attributes

networkResources · object[]

Show child attributes

nativeNetworkResources · object[]

Show child attributes

memcacheAccess · object[]

Show child attributes

spicedbAccess · object[]

Show child attributes

status · object · read-only

Show child attributes

gvc · string