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>"
      ],
      "sort": {
        "$drop": [
          "by"
        ],
        "by": "<string>",
        "order": "asc"
      },
      "$replace/sort": {
        "by": "<string>",
        "order": "asc"
      }
    },
    "$replace/spec": {
      "match": "all",
      "terms": [
        {
          "op": "=",
          "property": "<string>",
          "rel": "<string>",
          "tag": "<string>",
          "value": "<string>"
        }
      ],
      "sort": {
        "by": "<string>",
        "order": "asc"
      }
    }
  },
  "$replace/memberQuery": {
    "kind": "<string>",
    "spec": {
      "match": "all",
      "terms": [
        {
          "op": "=",
          "property": "<string>",
          "rel": "<string>",
          "tag": "<string>",
          "value": "<string>"
        }
      ],
      "sort": {
        "by": "<string>",
        "order": "asc"
      }
    }
  },
  "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>"
        }
      ],
      "sort": {
        "by": "<string>",
        "order": "asc"
      }
    }
  },
  "identityMatcher": {
    "expression": "<string>",
    "language": "jmespath"
  },
  "origin": "default"
}

Authorizations

​
Authorization
string
header
required

Service account key can be used as API keys

Path Parameters

​
org
string
required
​
name
string
required

Body

application/json

The body is of type object.

Response

200
application/json

Success

The response is of type object.