PATCH/Users/{userId}

Updates part of member information.

This API operation updates only the properties that can be set with the SCIM User API.
Those that cannot be set with the SCIM User API, such as team, job level, position, and visibility remain the same.
To update those properties, you need to use the Admin Console or the LINE WORKS APIs.

For more information about the SCIM PATCH coverage, see PATCH Operation .

Caution

  • For the same member, the following API operations must be called in the order they are listed: Add a member, Update a member, Update part of a member, and Deactivate a member.
  • Depending on the Manage Fields settings in the LINE WORKS Admin, whether each property is required or updatable may vary.
  • This API operation works only when all the requests in the Operations list of the Request Body are valid.
  • The requests in the Operations list of the Request Body are reflected in the order they are listed.

HTTP Request

PATCHhttps://www.worksapis.com/scim/v2/Users/{userId}

Path Parameters

ParameterTypeDescription
userId integer 

Member ID


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}

See Get a Long-Lived Token for SCIM.


required 
Content-Type string 

application/json


required 

Request Body

PropertyTypeDescription
schemas array (string) 

Schema URL


required 
Operations array (ScimPatchOperation) 

List of requests to partially update


required 

ScimPatchOperation

PropertyTypeDescription
op string 

required
Allowed values : add, replace, remove 
path string 

Property path or filter to update

 
value object 
 
array (undefined) 
 
string 
 
boolean 
 
null 
 

Request Example

Example 1

1{2  "schemas": [3    "urn:ietf:params:scim:api:messages:2.0:PatchOp"4  ],5  "Operations": [6    {7      "op": "add",8      "path": "nickName",9      "value": "nickName"10    },11    {12      "op": "replace",13      "path": "name.givenName",14      "value": "john"15    },16    {17      "op": "remove",18      "path": "phoneNumbers[type eq \"mobile\"]"19    },20    {21      "op": "replace",22      "path": "active",23      "value": false24    },25    {26      "op": "add",27      "path": "phoneNumbers[type eq \"mobile\"].value",28      "value": "010-1234-5678"29    },30    {31      "op": "replace",32      "path": "emails[type eq \"alias\" and value eq \"alias_email_1@example.com\"]",33      "value": {34        "type": "alias",35        "primary": false,36        "value": "alias_email_2@example.com"37      }38    }39  ]40}

Response

HTTP 200

PropertyTypeDescription
schemas array (string) 

Schema URL


required 
id string 

Member ID


readOnly : true 
externalId string 

ID managed by the SCIM client


maxLength : 100 
userName string 

Account. It is the same as the email address.

  • The format is localpart@domain.
  • The localpart must start with an English letter or a number.
  • The localpart cannot start or end with a dot (.), and cannot contain two or more consecutive dots.
  • The localpart can be between 2 and 40 characters long and can only contain English letters, numbers, dot (.), hyphen (-), and underscore (_).

required
maxLength : 90 
name object (name) 

required 
displayName string 

Display name


readOnly : true 
nickName string 

Nickname

  • The allowed special characters are ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~.

maxLength : 100 
preferredLanguage string 

Language code


Allowed values : ko-KR, ja-JP, en-US, zh-CN, zh-TW 
timezone string 

Time zone


default : Time zone set for the domain 
active boolean 

Indicates whether the member is active.

  • true: Active
  • false: Suspended

This field must be set to true when adding a member.


default : true 
emails array (ScimUserEmail) 

Email information

 
phoneNumbers array (ScimUserPhoneNumber) 

Phone number information

 
ims array (ScimUserInstantMessage) 

Messenger information

 
urn:ietf:params:scim:schemas:extension:works:2.0:User object (urn:ietf:params:scim:schemas:extension:works:2.0:User) 
 
meta object (meta) 
 

name

PropertyTypeDescription
familyName stringnull 

Last name

  • The full name can be up to 80 characters long.
  • Either familyName or givenName must be specified.
  • The allowed special characters are ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~.

maxLength : 80 
givenName stringnull 

First name

  • The full name can be up to 80 characters long.
  • Either familyName or givenName must be specified.
  • The allowed special characters are ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~.

maxLength : 80 

ScimUserEmail

PropertyTypeDescription
type string 

Email type

  • alias: Secondary email
  • other: Personal email

required
Allowed values : alias, other 
primary boolean 

Indicates whether it is primary.


default : false 
value string 

Email

  • alias (secondary email)
    • Up to 90 characters
    • The format is localpart@domain.
    • The localpart must start with an English letter or a number.
    • The localpart cannot start or end with a dot (.), and cannot contain two or more consecutive dots.
    • The localpart can be between 2 and 40 characters long and can only contain English letters, numbers, dot (.), hyphen (-), and underscore (_).
    • You can add up to 10 email aliases.
  • other (personal email)
    • It is required if SSO is not enabled.
    • The format is localpart@domain.
    • The local part can be up to 64 characters long.
    • The domain can be up to 253 characters long.

required 

ScimUserPhoneNumber

PropertyTypeDescription
type string 

Phone number type

  • work: Internal number
  • mobile: Mobile phone number

required
Allowed values : work, mobile 
primary boolean 

Indicates whether it is primary.


default : false 
value string 

Phone number


required
maxLength : 100
pattern : ^(?=.*[0-9])[0-9+\-*#PTpt()\u3000]{0,100} 

ScimUserInstantMessage

PropertyTypeDescription
type string 

Messenger type


required
Allowed values : work 
primary boolean 

Indicates whether it is primary.


default : false 
value string 

Messenger ID


required
minLength : 1
maxLength : 100 

urn:ietf:params:scim:schemas:extension:works:2.0:User

PropertyTypeDescription
userExternalKey stringnull 

Member external key.

Some special characters, %, , #, /, ? are not allowed.


maxLength : 100 

meta

PropertyTypeDescription
resourceType string 

Resource type


Allowed values : USER, GROUP 
created string 

Creation date

 
lastModified string 

Last update date

 
location string 

Resource URI

 

HTTP 400

Bad Request

HTTP 404

Not Found

HTTP 409

Conflict