PATCH/Users/{userId}

ユーザーを部分更新する。
SCIM PATCH Operation の詳細については、SCIM 概要 > Patch Operation を参照してください。

注意

  • ユーザーの登録/更新/部分更新/無効化 API は、同じユーザーに対しては同時に呼び出してはならず、シングルスレッドで順番に呼び出すことを推奨します。
  • RequestBody の Operations リストに含まれるすべての操作が有効な場合にのみ、部分更新が行われる。
  • RequestBody 内の Operations リストの順に処理が行われる。
  • 更新・取得できる属性・プロパティは、管理項目 設定などのサービスによる制約に従います。
  • SCIM User API で設定できる属性・プロパティのみが更新されます。SCIM User API で設定できないプロパティ (所属組織、役職、職級、公開設定など) は、設定値を維持します。
  • SCIM User API で設定できないプロパティ (所属組織、役職、職級、公開設定など) は、管理者画面、または LINE WORKS API を使用して変更できます。

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId integer 

ユーザー ID


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}
長期トークンを参照してください。


required 
Content-Type string 

application/json


required 

Request Body

PropertyTypeDescription
schemas array (string) 

Schema URL


required 
Operations array (ScimPatchOperation) 

部分修正リクエスト リスト


required 

ScimPatchOperation

PropertyTypeDescription
op string 

required
Allowed values : add, replace, remove 
path string 

修正する属性の Path または Filter

 
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 

ユーザー ID


readOnly : true 
externalId string 

SCIM クライアントで管理する ID


maxLength : 100 
userName string 

アカウント。メールアドレスと同じ。
localpart@domain 形式
localpart は以下に従う

  • 2 ～ 40 字の英字、数字、ドット (".")、ハイフン ("-")、アンダーバー ("_") のみ使用できる
  • 最初の文字には英字、数字のみ使用できる
  • ドット (".") は最初と最後、および連続 ("..") では使用できない

required
maxLength : 90 
name object (name) 

required 
displayName string 

表示名


readOnly : true 
nickName string 

ニックネーム

  • 許容される特殊文字: !@&()-_+[]{},./#'`^~

maxLength : 100 
preferredLanguage string 

言語コード


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

タイムゾーン


default : ドメインで指定されたタイムゾーン 
active boolean 

有効化状態

  • true : 使用中
  • false : 一時停止
    ユーザー作成時には true を指定する

default : true 
emails array (ScimUserEmail) 

メール情報

 
phoneNumbers array (ScimUserPhoneNumber) 

電話番号

 
ims array (ScimUserInstantMessage) 

メッセンジャー情報

 
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 

姓

  • 姓、名を合わせて最大 80 字まで使用できる
  • 姓と名のいずれか 1 つは必須
  • 許容される特殊文字: !@&()-_+[]{},./#'`^~

maxLength : 80 
givenName stringnull 

名

  • 姓、名を合わせて最大 80 字まで使用できる
  • 姓と名のいずれか 1 つは必須
  • 許容される特殊文字: !@&()-_+[]{},./#'`^~

maxLength : 80 

ScimUserEmail

PropertyTypeDescription
type string 

メールアドレスのタイプ

  • alias : サブメールアドレス
  • other : 個人メールアドレス

required
Allowed values : alias, other 
primary boolean 

プライマリ


default : false 
value string 

メールアドレス

  • alias (サブメールアドレス)
    • 最大 90 字
    • localpart@domain 形式
    • localpart は以下に従う
      • 2 ～ 40 字の英字、数字、ドット (".")、ハイフン ("-")、アンダーバー ("_") のみ使用できる
      • 最初の文字には英字、数字のみ使用できる
      • ドット (".") は最初と最後、および連続 ("..") では使用できない
    • 最大 10 個まで指定できる
  • other (個人メールアドレス)
    • SSO を使用しない場合には必須
    • localpart@domain 形式
    • localpart は 64 字以下
    • domain は 253 字以下

required 

ScimUserPhoneNumber

PropertyTypeDescription
type string 

電話番号タイプ

  • work : 電話番号
  • mobile : 携帯電話番号

required
Allowed values : work, mobile 
primary boolean 

プライマリ


default : false 
value string 

電話番号


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

ScimUserInstantMessage

PropertyTypeDescription
type string 

メッセンジャータイプ


required
Allowed values : work 
primary boolean 

プライマリ


default : false 
value string 

SNS ID


required
minLength : 1
maxLength : 100 

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

PropertyTypeDescription
userExternalKey stringnull 

ユーザー Externalkey
"%"、"\"、"#"、"/"、"?" の特殊文字は利用不可。


maxLength : 100 

meta

PropertyTypeDescription
resourceType string 

リソースタイプ


Allowed values : USER, GROUP 
created string 

作成日時

 
lastModified string 

最終更新日時

 
location string 

リソース URI

 

HTTP 400

Bad Request

HTTP 404

Not Found

HTTP 409

Conflict