Get a group by name

Response will contain the requested group if the caller is authorized to view it

GET /org/{org}/group/{name}

Get a group by name

cURL

curl --request GET \
  --url https://api.cpln.io/org/{org}/group/{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>"
    }
  ],
  "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

serviceAccountKeyjwt

Authorization · string · header · required

Service account key can be used as API keys

Path Parameters

org · 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

memberLinks · string[]

memberQuery · object

Show child attributes

identityMatcher · object

Show child attributes

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

Available options: synthetic, default, builtin