属性マッピング

SCIM 属性と LINE WORKS User / Group API のプロパティは、以下のように対応します。

User コア属性 {#core-user-properties}

SCIM User 属性と ユーザーの取得 API のプロパティの対応は以下のとおりです。

  • Schema URI : urn:ietf:params:scim:schemas:core:2.0:User
SCIM 属性User API PropertyTypeDescription
iduserIdstringユーザー ID

readOnly : true
externalId-stringSCIM クライアントで管理する ID
userNameemailstringアカウント。メールアドレスと同じ。
・ localpart@domain 形式
・ localpart は以下に従う
・ 2 ~ 40 字の英字、数字、ドット (.)、ハイフン (-)、アンダーバー (_) のみ使用できる
・ 最初の文字には英字、数字のみ使用できる
・ ドット (.) は最初と最後、および連続 (..) では使用できない
・ 英大文字を使用した場合でも、LINE WORKS では英小文字として表示され、ログインの際は英小文字を使用する

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

required
ㄴ familyNamelastNamestring姓

maxLength : 80
ㄴ givenNamefirstNamestring名

maxLength : 80
displayName-stringユーザー名

readOnly : true
nickNamenickNamestringニックネーム
・ 許容される特殊文字: !@&()-_+[]{},./#'`^~

maxLength : 100
nullable : true
preferredLanguagelocalestring言語コード

Allowed values : ja-JP, ko-KR, en-US, zh-CN, zh-TW
default : ドメインで指定された言語
timezonetimeZonestringタイムゾーン

default : ドメインで指定されたタイムゾーン
activeisSuspendedboolean有効化状態
詳細は SCIM 概要 - User - Status を参照してください
・ true : 使用中 (isSuspended=false)
・ false : 一時停止。ログイン不可 (isSuspended=true)

default : true
emailsprivateEmail (type: other)
aliasEmails (type: alias)
arrayメール情報
ㄴ type-stringメールアドレスのタイプ
・ alias : サブメールアドレス。最大 10 個まで指定可能。
・ other : 個人メールアドレス。最大 1 個指定可能。

Allowed values : alias, other
required
ㄴ primary-booleanプライマリ

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

required
phoneNumberstelephone (type: work)
cellPhone (type: mobile)
array電話番号情報
ㄴ type-string電話番号タイプ
・ work : 電話番号。最大 1 個指定可能。
・ mobile : 携帯電話番号。最大 1 個指定可能。

Allowed values : work, mobile
required
ㄴ primary-booleanプライマリ

default : false
ㄴ value-string電話番号

maxLength : 100
pattern : ^(?=.*[0-9])[0-9+\-*#PTpt()\u3000]{0,100}
required
imsmessengerarrayメッセンジャー情報
ㄴ typeprotocol, customProtocolstringメッセンジャータイプ

Allowed values : work
required
ㄴ primary-booleanプライマリ

default : false
ㄴ valuemessengerIdstringSNS ID

minLength : 1
maxLength : 100
required

User カスタム属性 {#custom-user-properties}

SCIM User 属性と ユーザーの取得 API のプロパティの対応は以下のとおりです。

  • Schema URI : urn:ietf:params:scim:schemas:extension:works:2.0:User
SCIM 属性User API PropertyTypeDescription
userExternalKeyuserExternalKeystringユーザーの externalkey

%, , #, /, ? は含むことができない
maxLength : 100
nullable : true

Group コア属性 {#core-group-properties}

SCIM Group 属性と グループの取得 API のプロパティの対応は以下のとおりです。

  • Schema URI : urn:ietf:params:scim:schemas:core:2.0:Group
SCIM 属性Group API PropertyTypeDescription
idgroupIdstringグループ ID

readOnly : true
externalId-stringSCIM クライアントで管理する ID

nullable : true
displayNamegroupNamestringグループ名
ドメイン内で一意。
大文字・小文字は区別しない。

maxLength : 100
required
membersmembersarrayグループのメンバーリスト
ㄴ valuemembers[].idstringグループ メンバー ID
(ユーザー ID またはグループ ID)

required
ㄴ display-stringグループ メンバー名
(メンバーまたはグループ名)

readOnly : true
ㄴ typemembers[].typestringグループ メンバー タイプ

readOnly : true
Allowed values : USER, GROUP