identity
Perform a Patch on an identity by name
Overview
agent
auditctx
cloudaccount
- GETGet a cloud account by name
- DELDelete an cloud account by name
- PATCHPerform a Patch on a cloud account by name
- GETGet all cloud accounts
- POSTCreate a cloud account
- POSTGet all cloud accounts based on a query
- GETGet the access report for a cloud account by name
- GETGet available permissions for a cloud account resource type
domain
group
gvc
identity
- GETGet an identity by GVC and name
- DELDelete an identity by GVC and name
- PATCHPerform a Patch on an identity by name
- GETGet all identities in a GVC
- POSTCreate an identity
- GETGet all identities from all GVCs
- POSTGet all GVC identities based on a query
- GETGet the access report for an identity by GVC and name
- GETGet available permissions for an identity
image
location
org
policy
quota
secret
- GETGet a secret by name
- DELDelete a secret by name
- PATCHPerform a Patch on an IP Set by name
- GETGet all secrets
- POSTCreate a secret
- GETGet the sensitive content of a secret by name
- POSTGet all secrets based on a query
- GETGet the access report for a secret by name
- GETGet available permissions for a secret resource type
serviceaccount
- GETGet a service account by name
- DELDelete a service account by name
- PATCHPerform a Patch on a service account by name
- GETGet all service accounts
- POSTCreate a service account
- POSTGet all service accounts based on a query
- GETGet the access report for a service account by name
- POSTAdd a key to a service account
- GETGet available permissions for a service account resource type
task
user
volumeset
- GETGet a volumeset by GVC and name
- DELDelete a volumeset by name
- PATCHPerform a Patch on a volumeset by name
- GETList volumesets in a GVC you are authorized to view
- POSTCreate a volumeset
- GETGet all volumesets
- POSTGet all volumesets based on a query
- GETGet the access report for a volumeset by GVC and name
- GETGet available permissions for a volumeset resource type
workload
- GETGet a workload by GVC and name
- DELDelete a workload by name
- PATCHPerform a Patch on a workload by name
- GETGet a deployment by GVC, workload and name
- GETList workloads in a GVC you are authorized to view
- POSTCreate a workload
- GETGet all workloads
- GETList deployments in a workload
- POSTGet all workloads based on a query
- GETGet the access report for a workload by GVC and name
- GETGet available permissions for a workload resource type
identity
Perform a Patch on an identity by name
PATCH
/
org
/
{org}
/
gvc
/
{gvc}
/
identity
/
{name}
curl --request PATCH \
--url https://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name} \
--header 'Content-Type: application/json' \
--data '{
"$drop": [
"description"
],
"description": "<string>",
"tags": {},
"$replace/tags": {},
"aws": {
"$drop": [
"cloudAccountLink"
],
"cloudAccountLink": "<string>",
"policyRefs": [
"<string>"
],
"$drop/policyRefs": [
"<string>"
],
"$append/policyRefs": [
"<string>"
],
"$retain/policyRefs": [
"<string>"
],
"trustPolicy": {
"$drop": [
"Version"
],
"Version": "2012-10-17",
"Statement": [
{}
],
"$drop/Statement": [
"<string>"
],
"$append/Statement": [
{}
],
"$patch/Statement": [
{}
],
"$retain/Statement": [
"<string>"
]
},
"$replace/trustPolicy": {
"Version": "2012-10-17",
"Statement": [
{}
]
},
"roleName": "<string>"
},
"$replace/aws": {
"cloudAccountLink": "<string>",
"policyRefs": [
"<string>"
],
"trustPolicy": {
"Version": "2012-10-17",
"Statement": [
{}
]
},
"roleName": "<string>"
},
"gcp": {
"$drop": [
"cloudAccountLink"
],
"cloudAccountLink": "<string>",
"scopes": [
"<string>"
],
"$drop/scopes": [
"<string>"
],
"$append/scopes": [
"<string>"
],
"$retain/scopes": [
"<string>"
],
"serviceAccount": "<string>",
"bindings": [
{
"resource": "<string>",
"roles": [
"<string>"
]
}
],
"$drop/bindings": [
"<string>"
],
"$append/bindings": [
{
"resource": "<string>",
"roles": [
"<string>"
]
}
],
"$patch/bindings": [
{
"$drop": [
"resource"
],
"resource": "<string>",
"roles": [
"<string>"
],
"$drop/roles": [
"<string>"
],
"$append/roles": [
"<string>"
],
"$retain/roles": [
"<string>"
]
}
],
"$retain/bindings": [
"<string>"
]
},
"$replace/gcp": {
"cloudAccountLink": "<string>",
"scopes": [
"<string>"
],
"serviceAccount": "<string>",
"bindings": [
{
"resource": "<string>",
"roles": [
"<string>"
]
}
]
},
"azure": {
"$drop": [
"cloudAccountLink"
],
"cloudAccountLink": "<string>",
"roleAssignments": [
{
"scope": "<string>",
"roles": [
"<string>"
]
}
],
"$drop/roleAssignments": [
"<string>"
],
"$append/roleAssignments": [
{
"scope": "<string>",
"roles": [
"<string>"
]
}
],
"$patch/roleAssignments": [
{
"$drop": [
"scope"
],
"scope": "<string>",
"roles": [
"<string>"
],
"$drop/roles": [
"<string>"
],
"$append/roles": [
"<string>"
],
"$retain/roles": [
"<string>"
]
}
],
"$retain/roleAssignments": [
"<string>"
]
},
"$replace/azure": {
"cloudAccountLink": "<string>",
"roleAssignments": [
{
"scope": "<string>",
"roles": [
"<string>"
]
}
]
},
"ngs": {
"$drop": [
"cloudAccountLink"
],
"cloudAccountLink": "<string>",
"pub": {
"$drop": [
"allow"
],
"allow": [
"<string>"
],
"$drop/allow": [
"<string>"
],
"$append/allow": [
"<string>"
],
"$retain/allow": [
"<string>"
],
"deny": [
"<string>"
],
"$drop/deny": [
"<string>"
],
"$append/deny": [
"<string>"
],
"$retain/deny": [
"<string>"
]
},
"$replace/pub": {
"allow": [
"<string>"
],
"deny": [
"<string>"
]
},
"sub": {
"$drop": [
"allow"
],
"allow": [
"<string>"
],
"$drop/allow": [
"<string>"
],
"$append/allow": [
"<string>"
],
"$retain/allow": [
"<string>"
],
"deny": [
"<string>"
],
"$drop/deny": [
"<string>"
],
"$append/deny": [
"<string>"
],
"$retain/deny": [
"<string>"
]
},
"$replace/sub": {
"allow": [
"<string>"
],
"deny": [
"<string>"
]
},
"resp": {
"$drop": [
"max"
],
"max": 123,
"ttl": "<string>"
},
"$replace/resp": {
"max": 123,
"ttl": "<string>"
},
"subs": 123,
"data": 123,
"payload": 123
},
"$replace/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
]
}
],
"$drop/networkResources": [
"<string>"
],
"$append/networkResources": [
{
"name": "<string>",
"agentLink": "<string>",
"IPs": [
"<string>"
],
"FQDN": "<string>",
"resolverIP": "<string>",
"ports": [
123
]
}
],
"$retain/networkResources": [
"<string>"
],
"$patch/networkResources": [
{
"$drop": [
"agentLink"
],
"$replace/name": "<string>",
"name": "<any>",
"agentLink": "<string>",
"IPs": [
"<string>"
],
"$drop/IPs": [
"<string>"
],
"$append/IPs": [
"<string>"
],
"$retain/IPs": [
"<string>"
],
"FQDN": "<string>",
"resolverIP": "<string>",
"ports": [
123
],
"$drop/ports": [
123
],
"$append/ports": [
123
],
"$retain/ports": [
123
]
}
],
"nativeNetworkResources": [
{
"name": "<string>",
"FQDN": "<string>",
"ports": [
123
],
"awsPrivateLink": {
"endpointServiceName": "<string>"
},
"gcpServiceConnect": {
"targetService": "<string>"
}
}
],
"$drop/nativeNetworkResources": [
"<string>"
],
"$append/nativeNetworkResources": [
{
"name": "<string>",
"FQDN": "<string>",
"ports": [
123
],
"awsPrivateLink": {
"endpointServiceName": "<string>"
},
"gcpServiceConnect": {
"targetService": "<string>"
}
}
],
"$patch/nativeNetworkResources": [
{
"$drop": [
"FQDN"
],
"$replace/name": "<string>",
"name": "<any>",
"FQDN": "<string>",
"ports": [
123
],
"$drop/ports": [
123
],
"$append/ports": [
123
],
"$retain/ports": [
123
],
"awsPrivateLink": {
"$drop": [
"endpointServiceName"
],
"endpointServiceName": "<string>"
},
"$replace/awsPrivateLink": {
"endpointServiceName": "<string>"
},
"gcpServiceConnect": {
"$drop": [
"targetService"
],
"targetService": "<string>"
},
"$replace/gcpServiceConnect": {
"targetService": "<string>"
}
}
],
"$retain/nativeNetworkResources": [
"<string>"
],
"memcacheAccess": [
{
"clusterLink": "<string>",
"role": "readWrite"
}
],
"$drop/memcacheAccess": [
"<string>"
],
"$append/memcacheAccess": [
{
"clusterLink": "<string>",
"role": "readWrite"
}
],
"$patch/memcacheAccess": [
{
"$drop": [
"clusterLink"
],
"clusterLink": "<string>",
"role": "readWrite"
}
],
"$retain/memcacheAccess": [
"<string>"
],
"spicedbAccess": [
{
"clusterLink": "<string>",
"role": "checkPermission"
}
],
"$drop/spicedbAccess": [
"<string>"
],
"$append/spicedbAccess": [
{
"clusterLink": "<string>",
"role": "checkPermission"
}
],
"$patch/spicedbAccess": [
{
"$drop": [
"clusterLink"
],
"clusterLink": "<string>",
"role": "checkPermission"
}
],
"$retain/spicedbAccess": [
"<string>"
],
"gvc": "<string>"
}'
{
"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>",
"role": "checkPermission"
}
],
"status": {
"objectName": "<string>",
"aws": {
"lastError": "<string>",
"usable": true
},
"gcp": {
"lastError": "<string>",
"usable": true
},
"azure": {
"lastError": "<string>",
"usable": true
}
},
"gvc": "<string>"
}
Authorizations
Service account key can be used as API keys
Body
application/json
Available options:
description
, tags
, aws
, gcp
, azure
, ngs
, networkResources
, nativeNetworkResources
, memcacheAccess
, spicedbAccess
, gvc
Maximum length:
250
Available options:
cloudAccountLink
, policyRefs
, trustPolicy
, roleName
Available options:
Version
, Statement
Maximum length:
64
Available options:
cloudAccountLink
, scopes
, serviceAccount
, bindings
Available options:
cloudAccountLink
, roleAssignments
Available options:
scope
, roles
Available options:
cloudAccountLink
, pub
, sub
, resp
, subs
, data
, payload
Max number of subscriptions per connection
Max number of bytes a connection can send
Max message payload
Max number of subscriptions per connection
Max number of bytes a connection can send
Max message payload
Available options:
agentLink
, IPs
, FQDN
, resolverIP
, ports
Maximum length:
64
Maximum length:
64
Maximum length:
64
Available options:
FQDN
, ports
, awsPrivateLink
, gcpServiceConnect
Maximum length:
64
Response
200
application/json
Success
Maximum length:
64
Maximum length:
250
Max number of subscriptions per connection
Max number of bytes a connection can send
Max message payload
Maximum length:
64
curl --request PATCH \
--url https://api.cpln.io/org/{org}/gvc/{gvc}/identity/{name} \
--header 'Content-Type: application/json' \
--data '{
"$drop": [
"description"
],
"description": "<string>",
"tags": {},
"$replace/tags": {},
"aws": {
"$drop": [
"cloudAccountLink"
],
"cloudAccountLink": "<string>",
"policyRefs": [
"<string>"
],
"$drop/policyRefs": [
"<string>"
],
"$append/policyRefs": [
"<string>"
],
"$retain/policyRefs": [
"<string>"
],
"trustPolicy": {
"$drop": [
"Version"
],
"Version": "2012-10-17",
"Statement": [
{}
],
"$drop/Statement": [
"<string>"
],
"$append/Statement": [
{}
],
"$patch/Statement": [
{}
],
"$retain/Statement": [
"<string>"
]
},
"$replace/trustPolicy": {
"Version": "2012-10-17",
"Statement": [
{}
]
},
"roleName": "<string>"
},
"$replace/aws": {
"cloudAccountLink": "<string>",
"policyRefs": [
"<string>"
],
"trustPolicy": {
"Version": "2012-10-17",
"Statement": [
{}
]
},
"roleName": "<string>"
},
"gcp": {
"$drop": [
"cloudAccountLink"
],
"cloudAccountLink": "<string>",
"scopes": [
"<string>"
],
"$drop/scopes": [
"<string>"
],
"$append/scopes": [
"<string>"
],
"$retain/scopes": [
"<string>"
],
"serviceAccount": "<string>",
"bindings": [
{
"resource": "<string>",
"roles": [
"<string>"
]
}
],
"$drop/bindings": [
"<string>"
],
"$append/bindings": [
{
"resource": "<string>",
"roles": [
"<string>"
]
}
],
"$patch/bindings": [
{
"$drop": [
"resource"
],
"resource": "<string>",
"roles": [
"<string>"
],
"$drop/roles": [
"<string>"
],
"$append/roles": [
"<string>"
],
"$retain/roles": [
"<string>"
]
}
],
"$retain/bindings": [
"<string>"
]
},
"$replace/gcp": {
"cloudAccountLink": "<string>",
"scopes": [
"<string>"
],
"serviceAccount": "<string>",
"bindings": [
{
"resource": "<string>",
"roles": [
"<string>"
]
}
]
},
"azure": {
"$drop": [
"cloudAccountLink"
],
"cloudAccountLink": "<string>",
"roleAssignments": [
{
"scope": "<string>",
"roles": [
"<string>"
]
}
],
"$drop/roleAssignments": [
"<string>"
],
"$append/roleAssignments": [
{
"scope": "<string>",
"roles": [
"<string>"
]
}
],
"$patch/roleAssignments": [
{
"$drop": [
"scope"
],
"scope": "<string>",
"roles": [
"<string>"
],
"$drop/roles": [
"<string>"
],
"$append/roles": [
"<string>"
],
"$retain/roles": [
"<string>"
]
}
],
"$retain/roleAssignments": [
"<string>"
]
},
"$replace/azure": {
"cloudAccountLink": "<string>",
"roleAssignments": [
{
"scope": "<string>",
"roles": [
"<string>"
]
}
]
},
"ngs": {
"$drop": [
"cloudAccountLink"
],
"cloudAccountLink": "<string>",
"pub": {
"$drop": [
"allow"
],
"allow": [
"<string>"
],
"$drop/allow": [
"<string>"
],
"$append/allow": [
"<string>"
],
"$retain/allow": [
"<string>"
],
"deny": [
"<string>"
],
"$drop/deny": [
"<string>"
],
"$append/deny": [
"<string>"
],
"$retain/deny": [
"<string>"
]
},
"$replace/pub": {
"allow": [
"<string>"
],
"deny": [
"<string>"
]
},
"sub": {
"$drop": [
"allow"
],
"allow": [
"<string>"
],
"$drop/allow": [
"<string>"
],
"$append/allow": [
"<string>"
],
"$retain/allow": [
"<string>"
],
"deny": [
"<string>"
],
"$drop/deny": [
"<string>"
],
"$append/deny": [
"<string>"
],
"$retain/deny": [
"<string>"
]
},
"$replace/sub": {
"allow": [
"<string>"
],
"deny": [
"<string>"
]
},
"resp": {
"$drop": [
"max"
],
"max": 123,
"ttl": "<string>"
},
"$replace/resp": {
"max": 123,
"ttl": "<string>"
},
"subs": 123,
"data": 123,
"payload": 123
},
"$replace/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
]
}
],
"$drop/networkResources": [
"<string>"
],
"$append/networkResources": [
{
"name": "<string>",
"agentLink": "<string>",
"IPs": [
"<string>"
],
"FQDN": "<string>",
"resolverIP": "<string>",
"ports": [
123
]
}
],
"$retain/networkResources": [
"<string>"
],
"$patch/networkResources": [
{
"$drop": [
"agentLink"
],
"$replace/name": "<string>",
"name": "<any>",
"agentLink": "<string>",
"IPs": [
"<string>"
],
"$drop/IPs": [
"<string>"
],
"$append/IPs": [
"<string>"
],
"$retain/IPs": [
"<string>"
],
"FQDN": "<string>",
"resolverIP": "<string>",
"ports": [
123
],
"$drop/ports": [
123
],
"$append/ports": [
123
],
"$retain/ports": [
123
]
}
],
"nativeNetworkResources": [
{
"name": "<string>",
"FQDN": "<string>",
"ports": [
123
],
"awsPrivateLink": {
"endpointServiceName": "<string>"
},
"gcpServiceConnect": {
"targetService": "<string>"
}
}
],
"$drop/nativeNetworkResources": [
"<string>"
],
"$append/nativeNetworkResources": [
{
"name": "<string>",
"FQDN": "<string>",
"ports": [
123
],
"awsPrivateLink": {
"endpointServiceName": "<string>"
},
"gcpServiceConnect": {
"targetService": "<string>"
}
}
],
"$patch/nativeNetworkResources": [
{
"$drop": [
"FQDN"
],
"$replace/name": "<string>",
"name": "<any>",
"FQDN": "<string>",
"ports": [
123
],
"$drop/ports": [
123
],
"$append/ports": [
123
],
"$retain/ports": [
123
],
"awsPrivateLink": {
"$drop": [
"endpointServiceName"
],
"endpointServiceName": "<string>"
},
"$replace/awsPrivateLink": {
"endpointServiceName": "<string>"
},
"gcpServiceConnect": {
"$drop": [
"targetService"
],
"targetService": "<string>"
},
"$replace/gcpServiceConnect": {
"targetService": "<string>"
}
}
],
"$retain/nativeNetworkResources": [
"<string>"
],
"memcacheAccess": [
{
"clusterLink": "<string>",
"role": "readWrite"
}
],
"$drop/memcacheAccess": [
"<string>"
],
"$append/memcacheAccess": [
{
"clusterLink": "<string>",
"role": "readWrite"
}
],
"$patch/memcacheAccess": [
{
"$drop": [
"clusterLink"
],
"clusterLink": "<string>",
"role": "readWrite"
}
],
"$retain/memcacheAccess": [
"<string>"
],
"spicedbAccess": [
{
"clusterLink": "<string>",
"role": "checkPermission"
}
],
"$drop/spicedbAccess": [
"<string>"
],
"$append/spicedbAccess": [
{
"clusterLink": "<string>",
"role": "checkPermission"
}
],
"$patch/spicedbAccess": [
{
"$drop": [
"clusterLink"
],
"clusterLink": "<string>",
"role": "checkPermission"
}
],
"$retain/spicedbAccess": [
"<string>"
],
"gvc": "<string>"
}'
{
"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>",
"role": "checkPermission"
}
],
"status": {
"objectName": "<string>",
"aws": {
"lastError": "<string>",
"usable": true
},
"gcp": {
"lastError": "<string>",
"usable": true
},
"azure": {
"lastError": "<string>",
"usable": true
}
},
"gvc": "<string>"
}