Perform a Patch on a service account by name

PATCH /org/{org}/serviceaccount/{name}

Perform a Patch on a service account by name

cURL

curl --request PATCH \
  --url https://api.cpln.io/org/{org}/serviceaccount/{name} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "$drop": [],
  "name": "<string>",
  "description": "<string>",
  "tags": {},
  "$replace/tags": {}
}
'

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>"
    }
  ],
  "keys": [
    {
      "name": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "key": "<string>",
      "description": "<string>"
    }
  ],
  "origin": "default"
}

Authorizations

serviceAccountKeyjwt

Authorization · string · header · required

Service account key can be used as API keys

Path Parameters

org · string · required

name · string · required

Body

application/json

$drop · enum<string>[]

Available options: description, tags

name · string

Maximum string length: 64

description · string

Maximum string length: 250

tags · object

$replace/tags · object

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

keys · object[] · read-only

Show child attributes

origin · enum<string> · default: default · read-only

Available options: default, builtin