Patch Patch User

Patch Patch User

Updates user's information. The user id is a unique internal identifier and can be retrieved using the search API /scim/Users?filter=... Patch operation allows to send in the request only attributes that need to be changed.

Request
URI
PATCH
https://{api_host}//SAAS/jersey/manager/api/scim/Users/{id}
COPY
Path Parameters
string
id
Required

the id of the user to update

id example
d24afa39-05a1-433f-8aa9-ad41c9a3d394
Request Body

the user resource updated information as a JSON string

SdkUserResource of type(s) application/json
Required 
{
    "phoneNumbers": [
        {
            "operation": "string",
            "type": "string",
            "primary": false,
            "value": "string",
            "display": "string"
        }
    ],
    "addresses": [
        {
            "locality": "string",
            "country": "string",
            "region": "string",
            "primary": false,
            "formatted": "string",
            "streetAddress": "string",
            "postalCode": "string",
            "type": "string"
        }
    ],
    "locale": "string",
    "userType": "string",
    "meta": {
        "lastModified": "string",
        "version": "string",
        "location": "string",
        "created": "string"
    },
    "id": "string",
    "resourceDescriptor": {
        "endpoint": "string",
        "description": "string",
        "name": "string",
        "attributeSchemas": [
            "string"
        ],
        "strictMode": false,
        "scimObject": {
            "schemas": [
                "string"
            ]
        },
        "meta": {
            "lastModified": "string",
            "version": "string",
            "location": "string",
            "created": "string"
        },
        "externalId": "string",
        "attributes": [
            {
                "subAttributes": [
                    "AttributeDescriptor Object"
                ],
                "description": "string",
                "canonicalValues": [
                    {
                        "operation": "string",
                        "type": "string",
                        "primary": false,
                        "value": "string",
                        "display": "string"
                    }
                ],
                "dataType": "string",
                "required": false,
                "caseExact": false,
                "name": "string",
                "readOnly": false,
                "multiValuedChildName": "string",
                "multiValued": false,
                "schema": "string"
            }
        ],
        "schema": "string",
        "id": "string",
        "resourceDescriptor": "ResourceDescriptor Object"
    },
    "title": "string",
    "preferredLanguage": "string",
    "scimObject": {
        "schemas": [
            "string"
        ]
    },
    "ims": [
        {
            "operation": "string",
            "type": "string",
            "primary": false,
            "value": "string",
            "display": "string"
        }
    ],
    "externalId": "string",
    "entitlements": [
        {
            "operation": "string",
            "type": "string",
            "primary": false,
            "value": "string",
            "display": "string"
        }
    ],
    "nickName": "string",
    "urn:scim:schemas:extension:workspace:1.0": {
        "distinguishedName": "CN=user1,CN=Users,DC=acme,DC=com",
        "domain": "acme.com",
        "internalUserType": "PROVISIONED",
        "softDeleted": false,
        "userPrincipalName": "[email protected]",
        "userStatus": "1",
        "userStoreUuid": "19175b6d-a656-451a-9d25-b62e12d90a24",
        "firstLoginUrl": "string"
    },
    "photos": [
        {
            "operation": "string",
            "type": "string",
            "primary": false,
            "value": "string",
            "display": "string"
        }
    ],
    "groups": [
        {
            "operation": "string",
            "type": "string",
            "primary": false,
            "value": "string",
            "display": "string"
        }
    ],
    "active": false,
    "password": "string",
    "emails": [
        {
            "operation": "string",
            "type": "string",
            "primary": false,
            "value": "string",
            "display": "string"
        }
    ],
    "userName": "string",
    "displayName": "string",
    "name": {
        "honorificPrefix": "string",
        "middleName": "string",
        "familyName": "string",
        "formatted": "string",
        "givenName": "string",
        "honorificSuffix": "string"
    },
    "roles": [
        {
            "operation": "string",
            "type": "string",
            "primary": false,
            "value": "string",
            "display": "string"
        }
    ],
    "urn:scim:schemas:extension:enterprise:1.0": {
        "manager": {
            "displayName": "string",
            "managerId": "string"
        },
        "employeeNumber": "100007"
    },
    "profileUrl": "string",
    "timeZone": "string"
}
array of EntryString
phoneNumbers
Optional

phoneNumbers

array of Address
addresses
Optional

addresses

string
locale
Optional

locale

string
userType
Optional

userType

Meta
meta
Optional

meta

string
id
Optional

id

ResourceDescriptor
resourceDescriptor
Optional

resourceDescriptor

string
title
Optional

title

string
preferredLanguage
Optional

preferredLanguage

SCIMObject
scimObject
Optional

scimObject

array of EntryString
ims
Optional

ims

string
externalId
Optional

externalId

array of EntryString
entitlements
Optional

entitlements

string
nickName
Optional

nickName

WorkspaceSchemaUserAttributes
urn:scim:schemas:extension:workspace:1.0
Optional

urn:scim:schemas:extension:workspace:1.0

array of EntryString
photos
Optional

photos

array of EntryString
groups
Optional

groups

boolean
active
Optional

active

string
password
Optional

password

array of EntryString
emails
Optional

emails

string
userName
Optional

userName

string
displayName
Optional

displayName

Name
name
Optional

name

array of EntryString
roles
Optional

roles

EnterpriseSchemaUserAttributes
urn:scim:schemas:extension:enterprise:1.0
Optional

urn:scim:schemas:extension:enterprise:1.0

string
profileUrl
Optional

profileUrl

string
timeZone
Optional

timeZone

Authentication
This operation uses the following authentication methods.
Responses
400

The supplied JSON is incorrect

Operation doesn't return any data structure

403

The user is not a local user and can not be updated

Operation doesn't return any data structure

404

The specified user does not exist.

Operation doesn't return any data structure

500

An unexpected error occurred

Operation doesn't return any data structure

On This Page
Scim Operations
DELETE
Delete Delete Group
DELETE
Delete Delete User
GET
Get Get Group
GET
Get Get Groups
GET
Get Get Role
GET
Get Get Roles
GET
Get Get Schemas
GET
Get Get User
GET
Get Get Users
PATCH
Patch Patch Group
PATCH
Patch Patch Role
PATCH
Patch Patch User
POST
Post Find Groups
POST
Post Find Users
POST
Post Post Group
POST
Post Post User