Modify a SCIM user by ID

1 min

PATCH

https://identity-api.optimizely.com/api/scim/v2/users/{id}

SCIM endpoint for modifying a user by their ID.

Path Parameters

idstringrequired
Description
ID of the user to modify.

Body Parameters

bodypatchRequest2required
Description
Details used to modify an existing user.
- operationspatchOperation2Combined[]
  - valuestring
  - nameinteger<int32>
    Default
    0
    Format
    int32
    Allowed
    012
  - opstring
  - pathiPath
    - attributePathstring
    - schemaIdentifierstring
    - subAttributesiFilter[]
      - attributePathstring
      - comparisonValuestring
      - comparisonValueEncodedstring
      - dataTypeinteger<int32>
        Default
        0
        Format
        int32
        Allowed
        01234567
      - filterOperatorinteger<int32>
        Default
        0
        Format
        int32
        Allowed
        0123456789101112
      - additionalFilteriFilter
        Circular-Reference
    - valuePathiPath
      - Circular-Reference
- schemasstring[]

Responses

200The modified user.

optiUser
- nameoptiName
  - familyNamestring
  - givenNamestring
- activeboolean
- metacore2Metadata
  - resourceTypestring
  - createdstring<date-time>
    Format
    date-time
  - lastModifiedstring<date-time>
    Format
    date-time
  - versionstring
  - locationstring
- customExtensionmap<string, iDictionary_object>
- userNamestring
- externalIdstring
- idstring
- schemasstring[]

400The request was invalid or cannot be otherwise served. An accompanying error message will explain further.

core2Error
- scimTypestring
- detailstring
- statusinteger<int32>
  Format
  int32
- schemasstring[]

401Unauthorized access to endpoint.

404The requested resource was not found.

core2Error
- scimTypestring
- detailstring
- statusinteger<int32>
  Format
  int32
- schemasstring[]

500

A server error occurred, please try again

core2Error
- scimTypestring
- detailstring
- statusinteger<int32>
  Format
  int32
- schemasstring[]

curl

curl --request PATCH \
     --url https://identity-api.optimizely.com/api/scim/v2/users/{id} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'PATCH',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://identity-api.optimizely.com/api/scim/v2/users/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://identity-api.optimizely.com/api/scim/v2/users/{id}")

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

request = Net::HTTP::Patch.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

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

python

import requests
import json

url = "https://identity-api.optimizely.com/api/scim/v2/users/{id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("PATCH", url, headers=headers, data=payload)

print(response.text)

200

// The modified user.
{
  "name": {
    "familyName": "",
    "givenName": ""
  },
  "active": false,
  "meta": {
    "resourceType": "",
    "created": "",
    "lastModified": "",
    "version": "",
    "location": ""
  },
  "customExtension": "",
  "userName": "",
  "externalId": "",
  "id": "",
  "schemas": [
    ""
  ]
}

400

// The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
{
  "scimType": "",
  "detail": "",
  "status": "",
  "schemas": [
    ""
  ]
}

401

// Unauthorized access to endpoint.

404

// The requested resource was not found.
{
  "scimType": "",
  "detail": "",
  "status": "",
  "schemas": [
    ""
  ]
}

500

// A server error occurred, please try again
{
  "scimType": "",
  "detail": "",
  "status": "",
  "schemas": [
    ""
  ]
}