Patch SCIM Group

Partially update a SCIM Group by ID

PATCH /v1/directory-integration/scim/v2/Groups/{id}

Patch SCIM Group

cURL

curl --request PATCH \
  --url https://eu1.api.matillion.com/dpc/v1/directory-integration/scim/v2/Groups/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Operations": [
    {}
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ]
}
'

import requests

url = "https://eu1.api.matillion.com/dpc/v1/directory-integration/scim/v2/Groups/{id}"

payload = {
    "Operations": [{}],
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Operations: [{}], schemas: ['urn:ietf:params:scim:api:messages:2.0:PatchOp']})
};

fetch('https://eu1.api.matillion.com/dpc/v1/directory-integration/scim/v2/Groups/{id}', 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://eu1.api.matillion.com/dpc/v1/directory-integration/scim/v2/Groups/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'Operations' => [
        [
                
        ]
    ],
    'schemas' => [
        'urn:ietf:params:scim:api:messages:2.0:PatchOp'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://eu1.api.matillion.com/dpc/v1/directory-integration/scim/v2/Groups/{id}"

	payload := strings.NewReader("{\n  \"Operations\": [\n    {}\n  ],\n  \"schemas\": [\n    \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://eu1.api.matillion.com/dpc/v1/directory-integration/scim/v2/Groups/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Operations\": [\n    {}\n  ],\n  \"schemas\": [\n    \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu1.api.matillion.com/dpc/v1/directory-integration/scim/v2/Groups/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Operations\": [\n    {}\n  ],\n  \"schemas\": [\n    \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n  ]\n}"

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

200

{
  "meta": {
    "created": "2023-11-07T05:31:56Z",
    "lastModified": "2023-11-07T05:31:56Z",
    "location": "<string>",
    "resourceType": "<string>",
    "version": "<string>"
  },
  "accountId": "<string>",
  "accountName": "<string>",
  "displayName": "<string>",
  "environment": "<string>",
  "externalId": "<string>",
  "id": "<string>",
  "members": [
    {
      "display": "<string>",
      "ref": "<string>",
      "value": "<string>"
    }
  ],
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projectName": "<string>",
  "role": "<string>",
  "schemas": [
    "<string>"
  ]
}

{
  "meta": {
    "created": "2023-11-07T05:31:56Z",
    "lastModified": "2023-11-07T05:31:56Z",
    "location": "<string>",
    "resourceType": "<string>",
    "version": "<string>"
  },
  "accountId": "<string>",
  "accountName": "<string>",
  "displayName": "<string>",
  "environment": "<string>",
  "externalId": "<string>",
  "id": "<string>",
  "members": [
    {
      "display": "<string>",
      "ref": "<string>",
      "value": "<string>"
    }
  ],
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projectName": "<string>",
  "role": "<string>",
  "schemas": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "violations": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

a valid bearer token

Path Parameters

id · string · required

Body

application/json

RFC 7644 SCIM PATCH request body

Operations · object[]

Array of patch operations to perform

Show child attributes

schemas · string[]

List of schemas used in this patch operation

Example:

[
  "urn:ietf:params:scim:api:messages:2.0:PatchOp"
]

Response

200

application/json

Group patched successfully

meta · object · required

Show child attributes

accountId · string

The unique identifier of the Matillion account this group belongs to

accountName · string

The human-readable name of the Matillion account

displayName · string

environment · string

The unique identifier of the environment this group is associated with

externalId · string

id · string

Required string length: 1 - 2147483647

members · object[]

Show child attributes

projectId · string<uuid>

The unique identifier of the project this group is associated with

projectName · string

The human-readable name of the project

role · string

The role assigned to this group within the Matillion platform

schemas · string[]

Required array length: 1 - 2147483647 elements