PATCH
/
org
/
{org}
/
group
/
{name}
curl --request PATCH \
  --url https://api.cpln.io/org/{org}/group/{name} \
  --header 'Content-Type: application/json' \
  --data '{
  "$drop": [
    "description"
  ],
  "description": "<string>",
  "tags": {},
  "$replace/tags": {},
  "memberLinks": [
    "<string>"
  ],
  "$drop/memberLinks": [
    "<string>"
  ],
  "$append/memberLinks": [
    "<string>"
  ],
  "$retain/memberLinks": [
    "<string>"
  ],
  "memberQuery": {
    "$drop": [
      "kind"
    ],
    "kind": "<string>",
    "spec": {
      "$drop": [
        "match"
      ],
      "match": "all",
      "terms": [
        {
          "op": "=",
          "property": "<string>",
          "rel": "<string>",
          "tag": "<string>",
          "value": "<string>"
        }
      ],
      "$drop/terms": [
        "<string>"
      ],
      "$append/terms": [
        {
          "op": "=",
          "property": "<string>",
          "rel": "<string>",
          "tag": "<string>",
          "value": "<string>"
        }
      ],
      "$patch/terms": [
        {
          "$drop": [
            "op"
          ],
          "op": "=",
          "property": "<string>",
          "rel": "<string>",
          "tag": "<string>",
          "$replace/value": "<string>",
          "value": "<any>"
        }
      ],
      "$retain/terms": [
        "<string>"
      ]
    },
    "$replace/spec": {
      "match": "all",
      "terms": [
        {
          "op": "=",
          "property": "<string>",
          "rel": "<string>",
          "tag": "<string>",
          "value": "<string>"
        }
      ]
    }
  },
  "$replace/memberQuery": {
    "kind": "<string>",
    "spec": {
      "match": "all",
      "terms": [
        {
          "op": "=",
          "property": "<string>",
          "rel": "<string>",
          "tag": "<string>",
          "value": "<string>"
        }
      ]
    }
  },
  "identityMatcher": {
    "$drop": [
      "expression"
    ],
    "expression": "<string>",
    "language": "jmespath"
  },
  "$replace/identityMatcher": {
    "expression": "<string>",
    "language": "jmespath"
  }
}'
{
  "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>"
    }
  ],
  "memberLinks": [
    "<string>"
  ],
  "memberQuery": {
    "kind": "<string>",
    "context": {},
    "spec": {
      "match": "all",
      "terms": [
        {
          "op": "=",
          "property": "<string>",
          "rel": "<string>",
          "tag": "<string>",
          "value": "<string>"
        }
      ]
    }
  },
  "identityMatcher": {
    "expression": "<string>",
    "language": "jmespath"
  },
  "origin": "synthetic"
}

Authorizations

Authorization
string
headerrequired

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,
memberLinks,
memberQuery,
identityMatcher
description
string
tags
object
$replace/tags
object
memberLinks
string[]
$drop/memberLinks
string[]
$append/memberLinks
string[]
$retain/memberLinks
string[]
memberQuery
object
$replace/memberQuery
object
identityMatcher
object
$replace/identityMatcher
object

Response

200 - application/json
id
string
name
string
kind
string
version
integer
description
string
tags
object
created
string
lastModified
string
links
object[]
memberLinks
string[]
memberQuery
object
identityMatcher
object
origin
enum<string>
default: default
Available options:
synthetic,
default,
builtin