Create a group

curl --request POST \
  --url https://api.cpln.io/org/{org}/group \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "tags": {},
  "memberLinks": [
    "<string>"
  ],
  "memberQuery": {
    "kind": "<string>",
    "spec": {
      "match": "all",
      "terms": [
        {
          "op": "=",
          "property": "<string>",
          "rel": "<string>",
          "tag": "<string>",
          "value": "<string>"
        }
      ],
      "sort": {
        "by": "<string>",
        "order": "asc"
      }
    }
  },
  "identityMatcher": {
    "expression": "<string>",
    "language": "jmespath"
  }
}
'

import requests

url = "https://api.cpln.io/org/{org}/group"

payload = {
    "name": "<string>",
    "description": "<string>",
    "tags": {},
    "memberLinks": ["<string>"],
    "memberQuery": {
        "kind": "<string>",
        "spec": {
            "match": "all",
            "terms": [
                {
                    "op": "=",
                    "property": "<string>",
                    "rel": "<string>",
                    "tag": "<string>",
                    "value": "<string>"
                }
            ],
            "sort": {
                "by": "<string>",
                "order": "asc"
            }
        }
    },
    "identityMatcher": {
        "expression": "<string>",
        "language": "jmespath"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    tags: {},
    memberLinks: ['<string>'],
    memberQuery: {
      kind: '<string>',
      spec: {
        match: 'all',
        terms: [
          {
            op: '=',
            property: '<string>',
            rel: '<string>',
            tag: '<string>',
            value: '<string>'
          }
        ],
        sort: {by: '<string>', order: 'asc'}
      }
    },
    identityMatcher: {expression: '<string>', language: 'jmespath'}
  })
};

fetch('https://api.cpln.io/org/{org}/group', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cpln.io/org/{org}/group",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'tags' => [
        
    ],
    'memberLinks' => [
        '<string>'
    ],
    'memberQuery' => [
        'kind' => '<string>',
        'spec' => [
                'match' => 'all',
                'terms' => [
                                [
                                                                'op' => '=',
                                                                'property' => '<string>',
                                                                'rel' => '<string>',
                                                                'tag' => '<string>',
                                                                'value' => '<string>'
                                ]
                ],
                'sort' => [
                                'by' => '<string>',
                                'order' => 'asc'
                ]
        ]
    ],
    'identityMatcher' => [
        'expression' => '<string>',
        'language' => 'jmespath'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cpln.io/org/{org}/group"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tags\": {},\n  \"memberLinks\": [\n    \"<string>\"\n  ],\n  \"memberQuery\": {\n    \"kind\": \"<string>\",\n    \"spec\": {\n      \"match\": \"all\",\n      \"terms\": [\n        {\n          \"op\": \"=\",\n          \"property\": \"<string>\",\n          \"rel\": \"<string>\",\n          \"tag\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"sort\": {\n        \"by\": \"<string>\",\n        \"order\": \"asc\"\n      }\n    }\n  },\n  \"identityMatcher\": {\n    \"expression\": \"<string>\",\n    \"language\": \"jmespath\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cpln.io/org/{org}/group")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tags\": {},\n  \"memberLinks\": [\n    \"<string>\"\n  ],\n  \"memberQuery\": {\n    \"kind\": \"<string>\",\n    \"spec\": {\n      \"match\": \"all\",\n      \"terms\": [\n        {\n          \"op\": \"=\",\n          \"property\": \"<string>\",\n          \"rel\": \"<string>\",\n          \"tag\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"sort\": {\n        \"by\": \"<string>\",\n        \"order\": \"asc\"\n      }\n    }\n  },\n  \"identityMatcher\": {\n    \"expression\": \"<string>\",\n    \"language\": \"jmespath\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cpln.io/org/{org}/group")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tags\": {},\n  \"memberLinks\": [\n    \"<string>\"\n  ],\n  \"memberQuery\": {\n    \"kind\": \"<string>\",\n    \"spec\": {\n      \"match\": \"all\",\n      \"terms\": [\n        {\n          \"op\": \"=\",\n          \"property\": \"<string>\",\n          \"rel\": \"<string>\",\n          \"tag\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"sort\": {\n        \"by\": \"<string>\",\n        \"order\": \"asc\"\n      }\n    }\n  },\n  \"identityMatcher\": {\n    \"expression\": \"<string>\",\n    \"language\": \"jmespath\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": 123,
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "id": "<string>"
}

{
  "status": 123,
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "id": "<string>"
}

POST

org

{org}

group

Create a group

curl --request POST \
  --url https://api.cpln.io/org/{org}/group \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "tags": {},
  "memberLinks": [
    "<string>"
  ],
  "memberQuery": {
    "kind": "<string>",
    "spec": {
      "match": "all",
      "terms": [
        {
          "op": "=",
          "property": "<string>",
          "rel": "<string>",
          "tag": "<string>",
          "value": "<string>"
        }
      ],
      "sort": {
        "by": "<string>",
        "order": "asc"
      }
    }
  },
  "identityMatcher": {
    "expression": "<string>",
    "language": "jmespath"
  }
}
'

import requests

url = "https://api.cpln.io/org/{org}/group"

payload = {
    "name": "<string>",
    "description": "<string>",
    "tags": {},
    "memberLinks": ["<string>"],
    "memberQuery": {
        "kind": "<string>",
        "spec": {
            "match": "all",
            "terms": [
                {
                    "op": "=",
                    "property": "<string>",
                    "rel": "<string>",
                    "tag": "<string>",
                    "value": "<string>"
                }
            ],
            "sort": {
                "by": "<string>",
                "order": "asc"
            }
        }
    },
    "identityMatcher": {
        "expression": "<string>",
        "language": "jmespath"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    tags: {},
    memberLinks: ['<string>'],
    memberQuery: {
      kind: '<string>',
      spec: {
        match: 'all',
        terms: [
          {
            op: '=',
            property: '<string>',
            rel: '<string>',
            tag: '<string>',
            value: '<string>'
          }
        ],
        sort: {by: '<string>', order: 'asc'}
      }
    },
    identityMatcher: {expression: '<string>', language: 'jmespath'}
  })
};

fetch('https://api.cpln.io/org/{org}/group', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cpln.io/org/{org}/group",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'tags' => [
        
    ],
    'memberLinks' => [
        '<string>'
    ],
    'memberQuery' => [
        'kind' => '<string>',
        'spec' => [
                'match' => 'all',
                'terms' => [
                                [
                                                                'op' => '=',
                                                                'property' => '<string>',
                                                                'rel' => '<string>',
                                                                'tag' => '<string>',
                                                                'value' => '<string>'
                                ]
                ],
                'sort' => [
                                'by' => '<string>',
                                'order' => 'asc'
                ]
        ]
    ],
    'identityMatcher' => [
        'expression' => '<string>',
        'language' => 'jmespath'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cpln.io/org/{org}/group"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tags\": {},\n  \"memberLinks\": [\n    \"<string>\"\n  ],\n  \"memberQuery\": {\n    \"kind\": \"<string>\",\n    \"spec\": {\n      \"match\": \"all\",\n      \"terms\": [\n        {\n          \"op\": \"=\",\n          \"property\": \"<string>\",\n          \"rel\": \"<string>\",\n          \"tag\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"sort\": {\n        \"by\": \"<string>\",\n        \"order\": \"asc\"\n      }\n    }\n  },\n  \"identityMatcher\": {\n    \"expression\": \"<string>\",\n    \"language\": \"jmespath\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.cpln.io/org/{org}/group")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tags\": {},\n  \"memberLinks\": [\n    \"<string>\"\n  ],\n  \"memberQuery\": {\n    \"kind\": \"<string>\",\n    \"spec\": {\n      \"match\": \"all\",\n      \"terms\": [\n        {\n          \"op\": \"=\",\n          \"property\": \"<string>\",\n          \"rel\": \"<string>\",\n          \"tag\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"sort\": {\n        \"by\": \"<string>\",\n        \"order\": \"asc\"\n      }\n    }\n  },\n  \"identityMatcher\": {\n    \"expression\": \"<string>\",\n    \"language\": \"jmespath\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cpln.io/org/{org}/group")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"tags\": {},\n  \"memberLinks\": [\n    \"<string>\"\n  ],\n  \"memberQuery\": {\n    \"kind\": \"<string>\",\n    \"spec\": {\n      \"match\": \"all\",\n      \"terms\": [\n        {\n          \"op\": \"=\",\n          \"property\": \"<string>\",\n          \"rel\": \"<string>\",\n          \"tag\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"sort\": {\n        \"by\": \"<string>\",\n        \"order\": \"asc\"\n      }\n    }\n  },\n  \"identityMatcher\": {\n    \"expression\": \"<string>\",\n    \"language\": \"jmespath\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": 123,
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "id": "<string>"
}

{
  "status": 123,
  "message": "<string>",
  "code": "<string>",
  "details": {},
  "id": "<string>"
}

Authorizations

Authorization

string

header

required

Service account key can be used as API keys

Path Parameters

org

string

required

Body

application/json

name

string

Maximum string length: 64

description

string

Maximum string length: 250

Response

Group was created successfully

Get all groups Get all groups based on a query

⌘I

API Reference

Core API

Audit API

Create a group

Authorizations

Path Parameters

Body

Response