SCIM API - User Modification

Purpose

Create user in accordance with the SCIM (2.0) protocol.

Accessing the API

XML

Endpoint: /SCIM/V2/Users/{userid}

HTTP Method

CODE

PATCH

API parameters.

Followings are the parameter details to call API.

Parameters	Data Type	Required?	Description
userName	String	Yes	LogonName
password	String	Optional	Password
givenName	String	Optional	FirstName
familyName	String	Optional	LastName
Value (phoneNumbers(1))	String	Optional	Mobile
region	String	Yes	Instance
Value (emails(1))	String	Optional	EmailID
department	String	Optional	Department
organization	String	Optional	Company
displayName	String	Optional	Manager
active	Boolean	Yes	IsActive
resourceType	String	Yes	UsersRoles
userType	String	Yes	Authentication
Value (x509Certificates(1))	Boolean	Yes	IsDevoid
Value (groups(1))	String	Optional	AccessSchedule
title	String	Optional	Tags
honorificSuffix	String	Optional	DirectoryStore
lastModified	String	Optional	ExpiresOn

API request

CODE

{
    "userName": "username",
	"name": 
	{ 
		"familyName": "LastName",
		"givenName": "firstName", 
		"honorificSuffix": "active directory server name"
    },
  "emails": [
    {
      "value": "EmainID"
    },
  ],
  "phoneNumbers": [
    {
      "value": "mobile number"
    }
  ],
  "userType": "SectonaAuthentication",
  "title": "Tags separated by comma",
  "active":true/false,
  "password": "password",
  "groups": [
    {
      "value": "access schedule"
    },
  ],
  "x509Certificates": [
    {
      "value":"Yes"
    }
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "organization": "Sectona Technologies pvt. LTD",
    "division": "User",
    "department": "Testing Department",
    "manager": {
      "displayName": "Givenname Surname"
    }
  },
  "meta": {
    "lastModified": "2025-05-13T04:42:34Z",    
    "location":"Test"
  }
}

API response

CODE

{
   "name":    {
      "familyName": "LastName",
      "givenName": "firstName",
      "honorificSuffix": "active directory server name"
   },
   "userName": "SCIMUSER3",
   "emails": [{"value": "SCIMUSER2@sectona.com"}],
   "phoneNumbers": [{"value": "9898989898"}],
   "userType": "SectonaAuthentication",
   "title": "Go Green, ERT",
   "active": true,
   "groups": [{"value": "abc"}],
   "x509Certificates": [{"value": "Yes"}],
   "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":    {
      "organization": "Sectona Technologies pvt. LTD",
      "division": "User",
      "department": "Testing Department",
      "manager": {"displayName": "givenname surname"}
   },
   "meta":    {
      "lastModified": "2025-05-13T04:42:34Z",
      "location": "Test"
   }
}