メンバー修正
メンバー情報を修正します。
参考
アドバンスト / ベーシック / プレミアムプランの場合、email を修正すると以前のメールアドレス宛のメールが届かなくなります。'メンバー配置転換 API' を使うと以前に使用していたメールアドレスをサブメールアドレスとして自動登録することができますので、使い分けを検討してください。
外部トーク連携とメンバーの email
- 外部トーク連携 ID として使用されているメンバーの email が修正された場合、外部トーク連携 ID も自動的に修正されます。
- このとき、新しい email に禁止ワードが含まれている場合は、以前の email をサブメールアドレスとして登録し、以前の email を引き続き外部トーク連携 ID として使用します。
- アドバンスト/ベーシック/プレミアムプランの場合、外部トーク連携に使用されるサブメールアドレスは必ず「aliasEmails」に含まれている必要があります。
注意
- ユーザーの登録/更新/部分更新APIは、ユーザーにつき必ずシングルスレッドで順番通りに呼び出すことを推奨する。
- フィールド値が null なら既存の値を削除します。
API の種類
サーバー API
Request URL
https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users/{externalKey}
HTTP Method
PUT (Content-Type: application/json; charset=UTF-8)
Path Parameters
| パラメーター | タイプ | 上限 | 必須 | 説明 |
|---|---|---|---|---|
| domainId | Integer | Y | 原職ドメイン ID | |
| externalKey | String | 100 字 | Y | 原職アカウントの External Key |
Request Parameters
| パラメーター | タイプ | 上限 | 必須 | 説明 |
|---|---|---|---|---|
| String | 90 字 | Y | アカウント アドバンスト/ベーシック/プレミアムプランで利用している場合には、メールアドレスと同じ。 他のプランで利用している場合には、ID@グループ名。 ● localpart@domain 形式で記述。 ● localpartは2～40字の英小文字、数字、ドット(.)、ハイフン(-)、アンダーバー(_)のみ使用可。 ● localpart の 1 文字目は英数字のみ可。 ● ドット(.)は localpart の最初と最後および連続使用(..)不可。 |
|
| name | Object | Y | 氏名 | |
| name.lastName | String | N | 苗字 苗字、名前は合計80字まで入力可能。 苗字か名前のいずれか必須。 許容される特殊文字: !@&()-_+[]{},./ # ' ` ^ ~ |
|
| name.firstName | String | N | 名前 苗字、名前は合計80字まで入力可能。 苗字か名前のいずれか必須。 許容される特殊文字: !@&()-_+[]{},./ # ' ` ^ ~ |
|
| name.phoneticLastName | String | 100 字 | N | 苗字のふりがな (カタカナのみ入力可) |
| name.phoneticFirstName | String | 100 字 | N | 名前のふりがな (カタカナのみ入力可) |
| i18nNames[] | List | N | 多言語名リスト。 | |
| i18nNames[].language | String | N | 言語コード。付録の言語コード参照。 | |
| i18nNames[].firstName | String | 100 字 | N | 各言語の名前 組織図の多言語名で後ろに表示 許容される特殊文字：! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~ |
| i18nNames[].lastName | String | 100 字 | N | 各言語の苗字 組織図の多言語名で前に表示 許容される特殊文字：! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~ |
| nickName | String | 100 字 | N | ニックネーム 許容される特殊文字: !@&()-_+[]{},./ # ' ` ^ ~ |
| privateEmail | String | 256 字 | N | 個人メールアドレス 最高管理者の場合は必須。 |
| aliasEmails | List<String> | 10 個 | N | サブメールアドレスのリスト アドバンスト/ベーシック/プレミアムプランのみ登録可 ● 最大 90 文字 ● localpart@domain 形式で、入力規則は email と同様 |
| employmentTypeExternalKey | String | 100 字 | N | 利用権限タイプの External Key 利用権限タイプ設定が On の場合のみ指定可。 既定値は「なし」。 |
| searchable | Boolean | N | サジェストへの表示 既定値: true |
|
| organizations[] | List | N | メンバーが所属するドメインリスト(メイン、兼務含む) | |
| organizations[].domainId | Integer | Y | ドメイン ID ● organizations[] を指定する場合は必須 会社間兼職設定: この値が Path Parameter の domainId と異なる場合、会社間兼職に設定される。 |
|
| organizations[].externalKey | String | 100 字 | N | 各ドメインでのメンバーの External Key ● 指定しない場合、Path Parameter の externalKey と同じ値になる。 ● グループ会社機能を利用する場合はテナント内で一意。 ● 特殊文字 \%#/? は入力不可 |
| organizations[].email | String | 90 字 | N | 各ドメインでのアカウント名 アドバンスト/ベーシック/プレミアムプランで原職と兼職に異なるメールアドレスを設定する場合に使用 ● localpart@domain 形式で、入力規則は email と同様 |
| organizations[].levelExternalKey | String | 100 字 | N | 職級の External Key 職級設定を使用している場合のみ指定可。既定値は「なし」。 |
| organizations[].orgUnits[] | List | 20 | N | 組織 List |
| organizations[].orgUnits[].externalKey | String | 100 字 | Y | 組織の External Key |
| organizations[].orgUnits[].represent | Boolean | N | 代表組織設定 ● 指定しない場合、organizations[].orgUnits[] の最初の組織が代表組織となる。 |
|
| organizations[].orgUnits[].positionExternalKey | String | 100 字 | N | 役職の External Key 役職設定が有効になっている場合のみ設定され、既定値は「役職なし」。 |
| organizations[].orgUnits[].manager | Boolean | N | 組織長設定 既に組織長が設定されている場合は上書き(既存の組織長は解除される)。 ● 既定値: false |
|
| organizations[].orgUnits[].display | Boolean | N | 組織図に組織のメンバーとして表示するかどうか。 ● 既定値: true |
|
| organizations[].orgUnits[].receiveEmail | Boolean | N | チーム機能の利用設定 | |
| telephone | String | 100 字 | N | 電話番号 入力値の制限については、入力文字列制限を参照。 |
| cellphone | String | 100 字 | N | 携帯番号 入力値の制限については、入力文字列制限を参照。 |
| fax | String | 100 字 | N | FAX 入力値の制限については、入力文字列制限を参照。 |
| location | String | 100 字 | N | 勤務先 |
| task | String | 100 字 | N | 担当業務 |
| messenger | Object | N | SNS 情報 | |
| messenger.protocol | String | 8 字 | Y | SNS アカウント ● LINE: ライン ● FACEBOOK: フェイスブック ● TWITTER: ツイッター ● CUSTOM: ユーザー指定 |
| messenger.customProtocol | String | 100 字 | N | protocol 値が CUSTOM の場合、ユーザー指定。 |
| messenger.messengerId | String | 100 字 | Y | SNS ID |
| birthdayCalendarType | String | 1字 | N | 誕生日の西暦/旧暦タイプ ● S: 西暦 ● L: 旧暦 |
| birthday | String | 10 字 | N | 生年月日 (yyyy.mm.dd) |
| hireDate | String | 10 字 | N | 入社日 (yyyy.mm.dd) |
| locale | String | N | 言語コード 付録の言語/タイムゾーンコード参照。 |
|
| timeZone | String | N | タイムゾーンコード 付録の言語/タイムゾーンコード参照。 |
|
| customField | Object | N | カスタムフィールド 事前に「カスタムフィールドの定義の追加 API」で設定が必要。 |
|
| customField.{schemaKey}[] | List | 10個 | Y | カスタムフィールドの定義キー(schemaKey) 各 schemaKey のフィールドの値は 10 個まで |
| customField.{schemaKey}[].value | String | 100字 | N | カスタムフィールドのテキスト |
| customField.{schemaKey}[].link | String | 300字 | N | カスタムフィールドのタイプが link の場合、URL - value か link のいずれか必須 - valueとlinkが共に登録されている場合 : リンク付きテキスト - value のみ指定した場合 : テキストのみ - linkのみ指定した場合 : URL 表示 |
Request Example
PUT https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/users/EX123
{
"email": "works.taro@example.com",
"name": {
"lastName": "ワークス",
"firstName": "太郎",
"phoneticLastName": "ワークス",
"phoneticFirstName": "タロウ"
},
"i18nNames": [
{
"language": "en_US",
"firstName": "Taro",
"lastName": "Works"
}
],
"nickName": "rabbit",
"privateEmail": "big@example.com",
"aliasEmails": [
"taro.works.alias1@example.com",
"taro.works.alias2@example.com"
],
"employmentTypeExternalKey": "社員",
"searchable": true,
"organizations": [
{
"domainId": 123,
"externalKey": "EX123",
"email": "taro.works@example.com",
"levelExternalKey": "manager",
"orgUnits": [
{
"externalKey": "Sales1",
"represent": true,
"positionExternalKey": "staff",
"manager": false,
"display": false,
"receiveEmail": false
},
{
"externalKey": "Sales2"
}
]
},
{
"domainId": 456,
"externalKey": "EX123",
"email": "taro.works@example.com",
"orgUnits": [
{
"externalKey": "Marketing1",
"represent": true,
"positionExternalKey": "staff",
"manager": true,
"display": true,
"receiveEmail": true
},
{
"externalKey": "Marketing2",
"represent": false,
"receiveEmail": false
}
]
}
],
"telephone": "031-310-7982",
"cellphone": "010-1234-1234",
"fax": "031-234-1234",
"location": "grenn-office",
"task": "developer",
"messenger": {
"protocol": "CUSTOM",
"customProtocol": "INSTAGRAM",
"messengerId": "taro"
},
"birthday": "1980.01.01",
"hireDate": "2018.01.01",
"locale": "ja_JP",
"timeZone": "Pacific/Midway",
"customField": {
"schema123": [
{
"value": "Homepage1",
"link": "https://www.unicef.org"
},
{
"value": "Homepage2"
},
{
"link": "https://wfuna.org"
}
],
"schema456": [
{
"value": "Tokyo Office"
},
{
"value": "Shibuya Tower"
}
]
}
}
Response
呼び出しに成功すると HTTP 200 コードを返します。
Error Code
呼び出しに失敗するとエラーコードとエラーメッセージを返します。
エラーコードは組織連携REST APIエラーコードを参照してください。