This page compares SCIM properties and their matching LINE WORKS User/Group API properties.
The following table compares the SCIM User properties with the properties of the Get a user API operation.
urn:ietf:params:scim:schemas:core:2.0:User| SCIM property | User API Property | Type | Description |
|---|---|---|---|
| id | userId | string | Member ID. readOnly: true |
| externalId | - | string | ID managed by the SCIM client |
| 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 (_). - Even uppercase letters are displayed as lowercase in LINE WORKS; make sure to use lowercase letters when logging in. maxLength: 90 Required | |
| name | userName | object | Name information - The full name can be up to 80 characters long. - Either familyName or givenName must be specified. - The allowed special characters are ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~. Required |
| ㄴ familyName | lastName | string | N |
| ㄴ givenName | firstName | string | N |
| displayName | - | string | Member name readOnly: true |
| nickName | nickName | string | Nickname - The allowed special characters are ! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~. maxLength: 100 nullable: true |
| preferredLanguage | locale | string | Language code Allowed values: ko-KR, ja-JP, en-US, zh-CN, zh-TW Default: Language set for the domain |
| timezone | timeZone | string | Time zone Default: Time zone set for the domain |
| active | isSuspended | boolean | Indicates whether the member is active. For more information, see SCIM - Status. - true: In use (isSuspended=false) - false: Temporarily suspended. Login is not allowed (isSuspended=true). Default: true |
| emails | privateEmail (type: other) aliasEmails (type: alias) | array | N |
| ㄴ type | - | string | Email type - alias: Secondary email. You can add up to 10 email addresses. - other: Personal email. You can add only one email address. Allowed values: alias, other Required |
| ㄴ 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 addresses. - 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. - You can add only one email address. Required |
| phoneNumbers | telephone (type: work) cellPhone (type: mobile) | array | Phone number information |
| ㄴ type | - | string | Phone number type - work: Business phone number. You can add only one phone number. - mobile: Mobile phone number. You can add only one phone number. Allowed values: work, mobile Required |
| ㄴ primary | - | boolean | Indicates whether it is primary. Default: false |
| ㄴ value | - | string | Phone number maxLength: 100 pattern: ^(?=.*[0-9])[0-9+-*#PTpt()\u3000]{0,100}Required |
| ims | messenger | array | Messenger information |
| ㄴ type | protocol, customProtocol | string | Messenger type. You can add only one messenger type. Allowed values: work Required |
| ㄴ primary | - | boolean | Indicates whether it is primary. Default: false |
| ㄴ value | messengerId | string | Messenger ID - minLength: 1 - maxLength: 100 Required |
The following table compares the SCIM User properties with the properties of the Get a user API operation.
urn:ietf:params:scim:schemas:extension:works:2.0:User| SCIM property | User API Property | Type | Description |
|---|---|---|---|
| userExternalKey | userExternalKey | string | Member external key. Some special characters, %, , #, /, ? are not allowed. maxLength: 100 nullable: true |
The following table compares the SCIM Group properties with the properties of the Get a group API operation.
urn:ietf:params:scim:schemas:core:2.0:Group| SCIM property | Group API property | Type | Description |
|---|---|---|---|
| id | groupId | string | Group ID readOnly: true |
| externalId | - | string | ID managed by the SCIM client nullable: true |
| displayName | groupName | string | Group name. It is not case-sensitive and must be unique within a domain. maxLength: 100 Required |
| members | members | array | List of group members |
| ㄴ value | members[].id | string | Group member ID (Member or group ID) Required |
| ㄴ display | - | string | Group member name (Member or group name) readOnly: true |
| ㄴ type | members[].type | string | Group member type readOnly: true Allowed values: USER, GROUP |