SCIM (API) | เอกสารประกอบ Accountmaker

SCIM 2.0 user provisioning

GET/scim/v2/Users

List users with optional filtering and pagination per RFC 7644. Supports filters on userName, externalId, and active status.

Responses

200application/scim+json

schemaobject

schemasarrayrequired

itemstringrequired

totalResultsnumberrequired

startIndexnumber

itemsPerPagenumber

Resourcesarrayrequired

itemobjectrequired

schemasarrayrequired

Nested fields truncated. Expand to continue inline, or use the model link.

idstring

externalIdstring

userNameEmailAddressrequired

A valid, normalized email address.

nameobject

Nested fields truncated. Expand to continue inline, or use the model link.

displayNamestring

nickNamestring

profileUrlstring

titlestring

userTypestring

preferredLanguagestring

localestring

timezonestring

activeboolean

emailsarray

Nested fields truncated. Expand to continue inline, or use the model link.

metaobject

Nested fields truncated. Expand to continue inline, or use the model link.

400application/scim+jsonScimError

SCIM 2.0 error response per RFC 7644

schemaScimError

SCIM 2.0 error response per RFC 7644 Section 3.12

schemasarrayrequired

itemstringrequired

statusstringrequired

HTTP status code as a string

scimTypestring

SCIM-specific error type

detailstring

Human-readable error message

defaultapplication/scim+jsonScimError

SCIM 2.0 error response per RFC 7644

schemaScimError

SCIM 2.0 error response per RFC 7644 Section 3.12

schemasarrayrequired

itemstringrequired

statusstringrequired

HTTP status code as a string

scimTypestring

SCIM-specific error type

detailstring

Human-readable error message

curl -X GET \\
  "${BASE_URL}/scim/v2/Users?filter=string&startIndex=123&count=123" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/scim/v2/Users?filter=string&startIndex=123&count=123";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/scim/v2/Users?filter=string&startIndex=123&count=123";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/scim/v2/Users?filter=string&startIndex=123&count=123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/scim/v2/Users?filter=string&startIndex=123&count=123",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/scim/v2/Users?filter=string&startIndex=123&count=123", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/scim/v2/Users?filter=string&startIndex=123&count=123", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/scim/v2/Users?filter=string&startIndex=123&count=123", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/scim/v2/Users?filter=string&startIndex=123&count=123", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/scim/v2/Users?filter=string&startIndex=123&count=123")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/scim/v2/Users?filter=string&startIndex=123&count=123", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/scim/v2/Users?filter=string&startIndex=123&count=123");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/scim/v2/Users

Create a new user via SCIM provisioning per RFC 7644. Creates the user resource, identity, and email credential.

Body application/scim+json

schemasarrayrequired

itemstringrequired

externalIdstring

userNameEmailAddressrequired

A valid, normalized email address.

nameobject

formattedstring

familyNamestring

givenNamestring

middleNamestring

honorificPrefixstring

honorificSuffixstring

displayNamestring

preferredLanguagestring

localestring

timezonestring

activeboolean

emailsarray

itemobjectrequired

valuestringrequired

typestring

primaryboolean

displaystring

Responses

201application/scim+json

Created

schemaobject

schemasarrayrequired

itemstringrequired

idstring

externalIdstring

userNameEmailAddressrequired

A valid, normalized email address.

nameobject

formattedstring

familyNamestring

givenNamestring

middleNamestring

honorificPrefixstring

honorificSuffixstring

displayNamestring

nickNamestring

profileUrlstring

titlestring

userTypestring

preferredLanguagestring

localestring

timezonestring

activeboolean

emailsarray

itemobjectrequired

valuestringrequired

typestring

primaryboolean

displaystring

metaobject

resourceTypestringrequired

createdstring

lastModifiedstring

locationstring

versionstring

400application/scim+jsonScimError

SCIM 2.0 error response per RFC 7644

schemaScimError

SCIM 2.0 error response per RFC 7644 Section 3.12

schemasarrayrequired

itemstringrequired

statusstringrequired

HTTP status code as a string

scimTypestring

SCIM-specific error type

detailstring

Human-readable error message

defaultapplication/scim+jsonScimError

SCIM 2.0 error response per RFC 7644

schemaScimError

SCIM 2.0 error response per RFC 7644 Section 3.12

schemasarrayrequired

itemstringrequired

statusstringrequired

HTTP status code as a string

scimTypestring

SCIM-specific error type

detailstring

Human-readable error message

curl -X POST \\
  "${BASE_URL}/scim/v2/Users" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/scim+json" \\
  -d '{"schemas":["string"],"externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}]}'

const payload = {"schemas":["string"],"externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}]};
const url = "${BASE_URL}/scim/v2/Users";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/scim+json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"schemas":["string"],"externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}]};
const url = "${BASE_URL}/scim/v2/Users";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/scim+json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"schemas":["string"],"externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}]};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/scim/v2/Users",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/scim+json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"schemas":["string"],"externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}]};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/scim/v2/Users",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/scim+json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"schemas":["string"],"externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}]};
const { body } = await request("${BASE_URL}/scim/v2/Users", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/scim+json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"schemas":["string"],"externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}]}
response = requests.request( \
    "POST", \
    "${BASE_URL}/scim/v2/Users", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"schemas":["string"],"externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}]}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/scim/v2/Users", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"schemas":["string"],"externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}]}`))

req, err := http.NewRequest("POST", "${BASE_URL}/scim/v2/Users", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"schemas":["string"],"externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}]}
uri = URI("${BASE_URL}/scim/v2/Users")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"schemas":["string"],"externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}]};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/scim/v2/Users", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/scim/v2/Users");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"schemas\":[\"string\"],\"externalId\":\"string\",\"userName\":\"value\",\"name\":{\"formatted\":\"string\",\"familyName\":\"string\",\"givenName\":\"string\",\"middleName\":\"string\",\"honorificPrefix\":\"string\",\"honorificSuffix\":\"string\"},\"displayName\":\"string\",\"preferredLanguage\":\"string\",\"locale\":\"string\",\"timezone\":\"string\",\"active\":true,\"emails\":[{\"value\":\"string\",\"type\":\"string\",\"primary\":true,\"display\":\"string\"}]}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

DELETE/scim/v2/Users/{id}

Soft-delete a user by disabling their account per RFC 7644. The user record is preserved for audit trails and data retention.

Responses

204

No Content

400application/scim+jsonScimError

SCIM 2.0 error response per RFC 7644

schemaScimError

SCIM 2.0 error response per RFC 7644 Section 3.12

schemasarrayrequired

itemstringrequired

statusstringrequired

HTTP status code as a string

scimTypestring

SCIM-specific error type

detailstring

Human-readable error message

defaultapplication/scim+jsonScimError

SCIM 2.0 error response per RFC 7644

schemaScimError

SCIM 2.0 error response per RFC 7644 Section 3.12

schemasarrayrequired

itemstringrequired

statusstringrequired

HTTP status code as a string

scimTypestring

SCIM-specific error type

detailstring

Human-readable error message

curl -X DELETE \\
  "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "delete",
  url: "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "delete",
  url: "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "DELETE", \
    "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "DELETE", \
        "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("DELETE", "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("DELETE", "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/scim/v2/Users/{id}

Retrieve a user by ID in SCIM 2.0 format per RFC 7644. Returns all supported user attributes.

Responses

200application/scim+json

schemaobject

schemasarrayrequired

itemstringrequired

idstring

externalIdstring

userNameEmailAddressrequired

A valid, normalized email address.

nameobject

formattedstring

familyNamestring

givenNamestring

middleNamestring

honorificPrefixstring

honorificSuffixstring

displayNamestring

nickNamestring

profileUrlstring

titlestring

userTypestring

preferredLanguagestring

localestring

timezonestring

activeboolean

emailsarray

itemobjectrequired

valuestringrequired

typestring

primaryboolean

displaystring

metaobject

resourceTypestringrequired

createdstring

lastModifiedstring

locationstring

versionstring

400application/scim+jsonScimError

SCIM 2.0 error response per RFC 7644

schemaScimError

SCIM 2.0 error response per RFC 7644 Section 3.12

schemasarrayrequired

itemstringrequired

statusstringrequired

HTTP status code as a string

scimTypestring

SCIM-specific error type

detailstring

Human-readable error message

defaultapplication/scim+jsonScimError

SCIM 2.0 error response per RFC 7644

schemaScimError

SCIM 2.0 error response per RFC 7644 Section 3.12

schemasarrayrequired

itemstringrequired

statusstringrequired

HTTP status code as a string

scimTypestring

SCIM-specific error type

detailstring

Human-readable error message

curl -X GET \\
  "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/scim/v2/Users/{id}

Partially update a user using SCIM PATCH operations per RFC 7644. Supports add, replace, and remove operations on user attributes.

Body application/scim+json

schemasarrayrequired

itemstringrequired

Operationsarrayrequired

itemobjectrequired

oprequired

pathstring

value

Responses

200application/scim+json

schemaobject

schemasarrayrequired

itemstringrequired

idstring

externalIdstring

userNameEmailAddressrequired

A valid, normalized email address.

nameobject

formattedstring

familyNamestring

givenNamestring

middleNamestring

honorificPrefixstring

honorificSuffixstring

displayNamestring

nickNamestring

profileUrlstring

titlestring

userTypestring

preferredLanguagestring

localestring

timezonestring

activeboolean

emailsarray

itemobjectrequired

valuestringrequired

typestring

primaryboolean

displaystring

metaobject

resourceTypestringrequired

createdstring

lastModifiedstring

locationstring

versionstring

400application/scim+jsonScimError

SCIM 2.0 error response per RFC 7644

schemaScimError

SCIM 2.0 error response per RFC 7644 Section 3.12

schemasarrayrequired

itemstringrequired

statusstringrequired

HTTP status code as a string

scimTypestring

SCIM-specific error type

detailstring

Human-readable error message

defaultapplication/scim+jsonScimError

SCIM 2.0 error response per RFC 7644

schemaScimError

SCIM 2.0 error response per RFC 7644 Section 3.12

schemasarrayrequired

itemstringrequired

statusstringrequired

HTTP status code as a string

scimTypestring

SCIM-specific error type

detailstring

Human-readable error message

curl -X PATCH \\
  "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/scim+json" \\
  -d '{"schemas":["string"],"Operations":[{"op":"add","path":"string","value":"value"}]}'

const payload = {"schemas":["string"],"Operations":[{"op":"add","path":"string","value":"value"}]};
const url = "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/scim+json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"schemas":["string"],"Operations":[{"op":"add","path":"string","value":"value"}]};
const url = "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/scim+json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"schemas":["string"],"Operations":[{"op":"add","path":"string","value":"value"}]};
const response = await axios({
  method: "patch",
  url: "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/scim+json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"schemas":["string"],"Operations":[{"op":"add","path":"string","value":"value"}]};
const response: AxiosResponse = await axios({
  method: "patch",
  url: "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/scim+json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"schemas":["string"],"Operations":[{"op":"add","path":"string","value":"value"}]};
const { body } = await request("${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/scim+json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"schemas":["string"],"Operations":[{"op":"add","path":"string","value":"value"}]}
response = requests.request( \
    "PATCH", \
    "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"schemas":["string"],"Operations":[{"op":"add","path":"string","value":"value"}]}
with httpx.Client() as client:
    response = client.request( \
        "PATCH", \
        "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"schemas":["string"],"Operations":[{"op":"add","path":"string","value":"value"}]}`))

req, err := http.NewRequest("PATCH", "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"schemas":["string"],"Operations":[{"op":"add","path":"string","value":"value"}]}
uri = URI("${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"schemas":["string"],"Operations":[{"op":"add","path":"string","value":"value"}]};
$client = new Client();
$response = $client->request("PATCH", "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"schemas\":[\"string\"],\"Operations\":[{\"op\":\"add\",\"path\":\"string\",\"value\":\"value\"}]}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PUT/scim/v2/Users/{id}

Replace a user’s attributes entirely per RFC 7644. All mutable attributes are replaced; omitted attributes reset to defaults.

Body application/scim+json

schemasarrayrequired

itemstringrequired

idstring

externalIdstring

userNameEmailAddressrequired

A valid, normalized email address.

nameobject

formattedstring

familyNamestring

givenNamestring

middleNamestring

honorificPrefixstring

honorificSuffixstring

displayNamestring

nickNamestring

profileUrlstring

titlestring

userTypestring

preferredLanguagestring

localestring

timezonestring

activeboolean

emailsarray

itemobjectrequired

valuestringrequired

typestring

primaryboolean

displaystring

metaobject

resourceTypestringrequired

createdstring

lastModifiedstring

locationstring

versionstring

Responses

200application/scim+json

schemaobject

schemasarrayrequired

itemstringrequired

idstring

externalIdstring

userNameEmailAddressrequired

A valid, normalized email address.

nameobject

formattedstring

familyNamestring

givenNamestring

middleNamestring

honorificPrefixstring

honorificSuffixstring

displayNamestring

nickNamestring

profileUrlstring

titlestring

userTypestring

preferredLanguagestring

localestring

timezonestring

activeboolean

emailsarray

itemobjectrequired

valuestringrequired

typestring

primaryboolean

displaystring

metaobject

resourceTypestringrequired

createdstring

lastModifiedstring

locationstring

versionstring

400application/scim+jsonScimError

SCIM 2.0 error response per RFC 7644

schemaScimError

SCIM 2.0 error response per RFC 7644 Section 3.12

schemasarrayrequired

itemstringrequired

statusstringrequired

HTTP status code as a string

scimTypestring

SCIM-specific error type

detailstring

Human-readable error message

defaultapplication/scim+jsonScimError

SCIM 2.0 error response per RFC 7644

schemaScimError

SCIM 2.0 error response per RFC 7644 Section 3.12

schemasarrayrequired

itemstringrequired

statusstringrequired

HTTP status code as a string

scimTypestring

SCIM-specific error type

detailstring

Human-readable error message

curl -X PUT \\
  "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/scim+json" \\
  -d '{"schemas":["string"],"id":"string","externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","nickName":"string","profileUrl":"string","title":"string","userType":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}],"meta":{"resourceType":"string","created":"string","lastModified":"string","location":"string","version":"string"}}'

const payload = {"schemas":["string"],"id":"string","externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","nickName":"string","profileUrl":"string","title":"string","userType":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}],"meta":{"resourceType":"string","created":"string","lastModified":"string","location":"string","version":"string"}};
const url = "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f";
const response = await fetch(url, {
  method: "PUT",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/scim+json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"schemas":["string"],"id":"string","externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","nickName":"string","profileUrl":"string","title":"string","userType":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}],"meta":{"resourceType":"string","created":"string","lastModified":"string","location":"string","version":"string"}};
const url = "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f";
const response = await fetch(url, {
  method: "PUT",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/scim+json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"schemas":["string"],"id":"string","externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","nickName":"string","profileUrl":"string","title":"string","userType":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}],"meta":{"resourceType":"string","created":"string","lastModified":"string","location":"string","version":"string"}};
const response = await axios({
  method: "put",
  url: "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/scim+json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"schemas":["string"],"id":"string","externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","nickName":"string","profileUrl":"string","title":"string","userType":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}],"meta":{"resourceType":"string","created":"string","lastModified":"string","location":"string","version":"string"}};
const response: AxiosResponse = await axios({
  method: "put",
  url: "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/scim+json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"schemas":["string"],"id":"string","externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","nickName":"string","profileUrl":"string","title":"string","userType":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}],"meta":{"resourceType":"string","created":"string","lastModified":"string","location":"string","version":"string"}};
const { body } = await request("${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", {
  method: "PUT",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/scim+json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"schemas":["string"],"id":"string","externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","nickName":"string","profileUrl":"string","title":"string","userType":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}],"meta":{"resourceType":"string","created":"string","lastModified":"string","location":"string","version":"string"}}
response = requests.request( \
    "PUT", \
    "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"schemas":["string"],"id":"string","externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","nickName":"string","profileUrl":"string","title":"string","userType":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}],"meta":{"resourceType":"string","created":"string","lastModified":"string","location":"string","version":"string"}}
with httpx.Client() as client:
    response = client.request( \
        "PUT", \
        "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"schemas":["string"],"id":"string","externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","nickName":"string","profileUrl":"string","title":"string","userType":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}],"meta":{"resourceType":"string","created":"string","lastModified":"string","location":"string","version":"string"}}`))

req, err := http.NewRequest("PUT", "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"schemas":["string"],"id":"string","externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","nickName":"string","profileUrl":"string","title":"string","userType":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}],"meta":{"resourceType":"string","created":"string","lastModified":"string","location":"string","version":"string"}}
uri = URI("${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f")
request = Net::HTTP::Put.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"schemas":["string"],"id":"string","externalId":"string","userName":"value","name":{"formatted":"string","familyName":"string","givenName":"string","middleName":"string","honorificPrefix":"string","honorificSuffix":"string"},"displayName":"string","nickName":"string","profileUrl":"string","title":"string","userType":"string","preferredLanguage":"string","locale":"string","timezone":"string","active":true,"emails":[{"value":"string","type":"string","primary":true,"display":"string"}],"meta":{"resourceType":"string","created":"string","lastModified":"string","location":"string","version":"string"}};
$client = new Client();
$response = $client->request("PUT", "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "${BASE_URL}/scim/v2/Users/uid0a1b2c3d4e5f");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"schemas\":[\"string\"],\"id\":\"string\",\"externalId\":\"string\",\"userName\":\"value\",\"name\":{\"formatted\":\"string\",\"familyName\":\"string\",\"givenName\":\"string\",\"middleName\":\"string\",\"honorificPrefix\":\"string\",\"honorificSuffix\":\"string\"},\"displayName\":\"string\",\"nickName\":\"string\",\"profileUrl\":\"string\",\"title\":\"string\",\"userType\":\"string\",\"preferredLanguage\":\"string\",\"locale\":\"string\",\"timezone\":\"string\",\"active\":true,\"emails\":[{\"value\":\"string\",\"type\":\"string\",\"primary\":true,\"display\":\"string\"}],\"meta\":{\"resourceType\":\"string\",\"created\":\"string\",\"lastModified\":\"string\",\"location\":\"string\",\"version\":\"string\"}}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

EmailAddress

string · email

A valid, normalized email address.

ScimError

schemasarrayrequired

itemstringrequired

statusstringrequired

HTTP status code as a string

scimTypestring

SCIM-specific error type

detailstring

Human-readable error message

SCIM

Contents

List Users

Create User

Delete User

Get User

Update User

Replace User

Models

Features

Types

Contents

List Users

Create User

Delete User

Get User

Update User

Replace User

Models

Related Features and Types

Features

Types