Patch SCIM Group

curl --request PATCH \
  --url https://api.attention.tech/v2/scim/Groups/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [
        {
          "value": "5b3680ed-0bed-4c98-af91-e75c3f384b15",
          "display": "john.doe@example.com"
        }
      ]
    }
  ]
}
'

import requests

url = "https://api.attention.tech/v2/scim/Groups/{id}"

payload = {
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "add",
            "path": "members",
            "value": [
                {
                    "value": "5b3680ed-0bed-4c98-af91-e75c3f384b15",
                    "display": "john.doe@example.com"
                }
            ]
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    schemas: ['urn:ietf:params:scim:api:messages:2.0:PatchOp'],
    Operations: [
      {
        op: 'add',
        path: 'members',
        value: [
          {value: '5b3680ed-0bed-4c98-af91-e75c3f384b15', display: 'john.doe@example.com'}
        ]
      }
    ]
  })
};

fetch('https://api.attention.tech/v2/scim/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://api.attention.tech/v2/scim/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([
    'schemas' => [
        'urn:ietf:params:scim:api:messages:2.0:PatchOp'
    ],
    'Operations' => [
        [
                'op' => 'add',
                'path' => 'members',
                'value' => [
                                [
                                                                'value' => '5b3680ed-0bed-4c98-af91-e75c3f384b15',
                                                                'display' => 'john.doe@example.com'
                                ]
                ]
        ]
    ]
  ]),
  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.attention.tech/v2/scim/Groups/{id}"

	payload := strings.NewReader("{\n  \"schemas\": [\n    \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n  ],\n  \"Operations\": [\n    {\n      \"op\": \"add\",\n      \"path\": \"members\",\n      \"value\": [\n        {\n          \"value\": \"5b3680ed-0bed-4c98-af91-e75c3f384b15\",\n          \"display\": \"john.doe@example.com\"\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.attention.tech/v2/scim/Groups/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"schemas\": [\n    \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n  ],\n  \"Operations\": [\n    {\n      \"op\": \"add\",\n      \"path\": \"members\",\n      \"value\": [\n        {\n          \"value\": \"5b3680ed-0bed-4c98-af91-e75c3f384b15\",\n          \"display\": \"john.doe@example.com\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.attention.tech/v2/scim/Groups/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"schemas\": [\n    \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n  ],\n  \"Operations\": [\n    {\n      \"op\": \"add\",\n      \"path\": \"members\",\n      \"value\": [\n        {\n          \"value\": \"5b3680ed-0bed-4c98-af91-e75c3f384b15\",\n          \"display\": \"john.doe@example.com\"\n        }\n      ]\n    }\n  ]\n}"

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

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "group-uuid-123",
  "displayName": "Sales Team",
  "members": [
    {
      "value": "user-uuid-1",
      "display": "jane@example.com"
    }
  ]
}

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "detail": "The details of the error",
  "status": 409
}

{
  "code": 401,
  "message": "unauthenticated for Invalid API key"
}

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "detail": "The details of the error",
  "status": 409
}

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "detail": "The details of the error",
  "status": 409
}

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "detail": "The details of the error",
  "status": 409
}

PATCH

scim

Groups

{id}

Patch SCIM Group

curl --request PATCH \
  --url https://api.attention.tech/v2/scim/Groups/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:PatchOp"
  ],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [
        {
          "value": "5b3680ed-0bed-4c98-af91-e75c3f384b15",
          "display": "john.doe@example.com"
        }
      ]
    }
  ]
}
'

import requests

url = "https://api.attention.tech/v2/scim/Groups/{id}"

payload = {
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
    "Operations": [
        {
            "op": "add",
            "path": "members",
            "value": [
                {
                    "value": "5b3680ed-0bed-4c98-af91-e75c3f384b15",
                    "display": "john.doe@example.com"
                }
            ]
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    schemas: ['urn:ietf:params:scim:api:messages:2.0:PatchOp'],
    Operations: [
      {
        op: 'add',
        path: 'members',
        value: [
          {value: '5b3680ed-0bed-4c98-af91-e75c3f384b15', display: 'john.doe@example.com'}
        ]
      }
    ]
  })
};

fetch('https://api.attention.tech/v2/scim/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://api.attention.tech/v2/scim/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([
    'schemas' => [
        'urn:ietf:params:scim:api:messages:2.0:PatchOp'
    ],
    'Operations' => [
        [
                'op' => 'add',
                'path' => 'members',
                'value' => [
                                [
                                                                'value' => '5b3680ed-0bed-4c98-af91-e75c3f384b15',
                                                                'display' => 'john.doe@example.com'
                                ]
                ]
        ]
    ]
  ]),
  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.attention.tech/v2/scim/Groups/{id}"

	payload := strings.NewReader("{\n  \"schemas\": [\n    \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n  ],\n  \"Operations\": [\n    {\n      \"op\": \"add\",\n      \"path\": \"members\",\n      \"value\": [\n        {\n          \"value\": \"5b3680ed-0bed-4c98-af91-e75c3f384b15\",\n          \"display\": \"john.doe@example.com\"\n        }\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.attention.tech/v2/scim/Groups/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"schemas\": [\n    \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n  ],\n  \"Operations\": [\n    {\n      \"op\": \"add\",\n      \"path\": \"members\",\n      \"value\": [\n        {\n          \"value\": \"5b3680ed-0bed-4c98-af91-e75c3f384b15\",\n          \"display\": \"john.doe@example.com\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.attention.tech/v2/scim/Groups/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"schemas\": [\n    \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\n  ],\n  \"Operations\": [\n    {\n      \"op\": \"add\",\n      \"path\": \"members\",\n      \"value\": [\n        {\n          \"value\": \"5b3680ed-0bed-4c98-af91-e75c3f384b15\",\n          \"display\": \"john.doe@example.com\"\n        }\n      ]\n    }\n  ]\n}"

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

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "group-uuid-123",
  "displayName": "Sales Team",
  "members": [
    {
      "value": "user-uuid-1",
      "display": "jane@example.com"
    }
  ]
}

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "detail": "The details of the error",
  "status": 409
}

{
  "code": 401,
  "message": "unauthenticated for Invalid API key"
}

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "detail": "The details of the error",
  "status": 409
}

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "detail": "The details of the error",
  "status": 409
}

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "detail": "The details of the error",
  "status": 409
}

Authorizations

Authorization

string

header

required

Path Parameters

string

required

SCIM ID of the group

Body

schemas

string[]

required

Example:

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

Operations

object[]

required

Show child attributes

Response

Group patched successfully

string

required

Example:

"1001"

schemas

string[]

Example:

[
  "urn:ietf:params:scim:schemas:core:2.0:Group",
  "urn:okta:custom:group:1.0"
]

displayName

string

Example:

"firstGroup"

members

object[]

Show child attributes

Example:

[{ "value": "101", "display": "okta" }]

urn:okta:custom:group:1.0

object

Show child attributes

Authentication

General Insights

Conversation

Team

API Key

User

Email

Tool

Scorecard

Organization

Calendar

Chat

Scim

Library

Super Agent

CRM

Integration

Knowledge Base

Label

Field Configuration

RecorderMetrics

Proactive

Patch SCIM Group

Authorizations

Path Parameters

Body

Response