メンバー追加
メンバーを追加します。
SSO 設定が On の場合、メンバーは「使用中」状態で追加され、すぐにサービスを利用できます。
SSO 設定が Off の場合、メンバーは「登録待ち」状態で追加されます。パスワード作成方法の既定値は「メンバーが作成」ですが、「管理者が作成」を選択することもできます。
- 「管理者が作成」でメンバーを追加：追加されたメンバーは管理者が設定したパスワードで初回ログインすると、パスワードを変更と再ログインを求められます。再ログインが完了すると「使用中」状態に変更されます。
- 「メンバーが作成」でメンバーを追加：指定された個人メールアドレス(必須)宛てに招待メールが送信されます。追加されたメンバーは招待メール内のリンクからパスワードを設定してから再ログインすると、「使用中」状態に変更されます。
API の種類
サーバー API
Request URL
https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users/{externalKey}
HTTP Method
POST (Content-Type: application/json; charset=UTF-8)
Path Parameters
| パラメーター | タイプ | 上限 | 必須 | 説明 |
|---|---|---|---|---|
| domainId | Integer | Y | 原職ドメイン ID | |
| externalKey | String | 100 字 | Y | 原職アカウントの External Key グループ会社機能を利用する場合はテナント内で一意になること。 特殊文字 \%#/? は入力不可。 |
Request Body
| パラメーター | タイプ | 上限 | 必須 | 説明 |
|---|---|---|---|---|
| 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 | 言語コード ●ko_KR ●ja_JP ●zh_CN ●zh_TW ●en_US |
|
| i18nNames[].firstName | String | 100 字 | N | 各言語の名前 組織図の多言語名で後ろに表示 許容される特殊文字：! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~ |
| i18nNames[].lastName | String | 100 字 | N | 各言語の苗字 組織図の多言語名で前に表示 許容される特殊文字：! @ & ( ) - _ + [ ] { } , . / # ' ` ^ ~ |
| nickName | String | 100 字 | N | ニックネーム 許容される特殊文字: !@&()-_+[]{},./ # ' ` ^ ~ |
| privateEmail | String | 256 字 | N | 個人メールアドレス SSO 設定が Offで passwordConfig.passwordCreationType が MEMBER の場合は必須。 有効なメールアドレスを指定すること。 |
| aliasEmails | List<String> | 10 | N | サブメールアドレスのリスト ベーシック/プレミアムプランのみ登録可 ● 最大 90 文字 ● localpart@domain 形式で、入力規則は email と同様 |
| employmentTypeExternalKey | String | 100 字 | N | 利用権限タイプの ExternalKey 利用権限タイプ設定が On の場合のみ指定可。 既定値は「なし」。 |
| searchable | Boolean | N | サジェストへの表示 ● 既定値: true |
|
| passwordConfig | Object | N | 初期ログインパスワード設定 この値を指定しない場合、「メンバーが作成」でメンバーを追加 |
|
| passwordConfig.passwordCreationType | String | N | パスワード作成方法 ● ADMIN: 管理者が作成 ● MEMBER: メンバーが作成 |
|
| passwordConfig.password | String | N | 初期ログインパスワード passwordCreationType が ADMIN の場合、必須。 |
|
| 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 | チーム機能の利用設定 *1 | |
| telephone | String | 100 字 | N | 電話番号 入力可能な文字 : - * # + P T |
| cellphone | String | 100 字 | N | 携帯番号 入力可能な文字 : - * # + P T |
| fax | String | 100 字 | N | FAX 入力可能な文字 : - * # + P T |
| 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 表示 |
*1 チーム機能の利用設定
組織に所属しているがトークルームでのメッセージ受信やファイル共有、組織メール受信などのチーム機能を制限したい場合にこのパラメータを利用する。
この値が false の場合、以下の機能を利用できない。
- チームトークルームのメンバーとして参加 (トーク、ノート、カレンダー、フォルダの閲覧)
- 組織宛メールの受信
- 組織宛スケジュール招待の受信
- 組織宛に共有された 掲示板、Drive、アンケートの閲覧、コメント等
- グループ作成時、メンバーとして組織を選択してもそのグループのメンバーに追加されない
Request Example
+POST https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/users/EX123
{
"email": "taro.works@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": "03-1310-7982",
"cellphone": "090-1234-1234",
"fax": "03-1234-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 Staff"
},
{
"value": "Shibuya Office"
}
]
}
}
Response
呼び出しに成功すると HTTP 200 コードを返します。
Error Code
呼び出しに失敗するとエラーコードとエラーメッセージを返します。
エラーコードは組織連携REST APIエラーコードを参照してください。