メンバー照会
メンバーを照会します。
API の種類
サーバー API
Request URL
https://apis.worksmobile.com/r/{API ID}/organization/v2/domains/{domainId}/users/{externalKey}
HTTP Method
GET
Path Parameters
パラメーター | タイプ | 上限 | 必須 | 説明 |
---|---|---|---|---|
domainId | Integer | Y | ドメイン ID | |
externalKey | String | 100 字 | Y | 照会するメンバーの External Key |
Request Example
GET https://apis.worksmobile.com/r/apiid/organization/v2/domains/123/users/EX123
Response
兼職を照会する場合、原職を渡し、兼職は organizations フィールドで照会できます。
プロパティ | タイプ | 説明 |
---|---|---|
tenantId | Integer | テナント ID |
domainId | Integer | ドメイン ID |
externalKey | String | メンバーの External Key |
master | Boolean | 最高管理者 |
manager | Boolean | 副管理者 |
suspended | Boolean | アカウントの一時停止 |
suspensionReason | String | 一時停止の理由 - MASTER: 管理者による操作 - LOGIN_FAIL: ログイン失敗 |
absence | Boolean | 不在設定 |
resigned | Boolean | アカウントの削除 |
standby | Boolean | 待機中状態 |
String | アカウント アドバンスト/ベーシック/プレミアムプランで利用している場合には、 メールアドレスと同じ。 他のプランをグループ名で利用している場合には、組織 ID@ グループ名で記述。 |
|
name | Object | 氏名 |
name.lastName | String | 苗字 |
name.firstName | String | 名前 |
name.phoneticLastName | String | 苗字のふりがな |
name.phoneticFirstName | String | 名前のふりがな |
i18nNames[].language | String | 言語コード。付録の言語コード参照。 |
i18nNames[].firstName | String | 各言語の名前 |
i18nNames[].lastName | String | 各言語の苗字 |
nickName | String | ニックネーム |
privateEmail | String | 個人メールアドレス |
aliasEmails | List<String> | サブメールアドレスのリスト |
telephone | String | 電話番号 |
cellphone | String | 携帯番号 |
fax | String | FAX |
employmentTypeExternalKey | String | 利用権限タイプの External Key |
location | String | 勤務先 |
task | String | 業務 |
messenger | Object | SNS 情報 |
messenger.protocol | String | SNS アカウント ● LINE: ライン ● FACEBOOK: フェイスブック ● TWITTER: ツイッター ● CUSTOM: ユーザー指定 |
messenger.customProtocol | String | protocol 値が CUSTOM の場合、ユーザー指定。 |
messenger.messengerId | String | SNS ID |
birthdayCalendarType | String | 誕生日の西暦/旧暦タイプ ● S: 西暦 ● L: 旧暦 |
birthday | String | 生年月日 (yyyy.mm.dd) |
hireDate | String | 入社日 (yyyy.mm.dd) |
searchable | Boolean | サジェストへの表示 |
organizations[] | List | メンバーが所属するドメインのリスト(原職、兼職含む) |
organizations[].domainId | Integer | ドメインID |
organizations[].levelExternalKey | String | 職級の External Key |
organizations[].represent | Boolean | 代表会社かどうか |
organizations[].externalKey | String | 各ドメインでのメンバーの External Key |
organizations[].email | String | アカウント名 |
organizations[].orgUnits[].domainId | Integer | 組織の属する ドメイン ID |
organizations[].orgUnits[].externalKey | String | 組織の External Key |
organizations[].orgUnits[].represent | Boolean | 代表組織かどうか |
organizations[].orgUnits[].positionExternalKey | String | 役職の External Key |
organizations[].orgUnits[].manager | Boolean | 組織長設定 |
organizations[].orgUnits[].display | Boolean | 組織図にメンバーとして表示するかどうか |
organizations[].orgUnits[].receiveEmail | Boolean | チーム機能の利用設定 |
relations[].relationName | String | 関係者連絡先 |
relations[].externalKey | String | 関係者の External Key。 |
locale | String | 言語コード ●ko_KR ●ja_JP ●zh_CN ●zh_TW ●en_US |
timeZone | String | タイムゾーンコード ●Pacific/Midway ●Pacific/Honolulu ●Pacific/Marquesas ●America/Anchorage ●America/Los_Angeles ●America/Denver ●America/Chicago ●America/New_York ●America/Caracas ●America/Santiago ●America/St_John ●America/Sao_Paulo ●America/Noronha ●Atlantic/Azores ●Europe/London ●Europe/Berlin ●Europe/Athens ●Asia/Baghdad ●Asia/Tehran ●Asia/Baku ●Asia/Karachi ●Asia/Colombo ●Asia/Katmandu ●Asia/Dhaka ●Asia/Rangoon ●Asia/Bangkok ●Asia/Shanghai ●Asia/Seoul ●Asia/Tokyo ●Australia/Darwin ●Australia/Sydney ●Australia/Lord_Howe ●Pacific/Noumea ●Pacific/Norfolk ●Pacific/Auckland |
customField | Object | カスタムフィールド |
customField.{schemaKey}[] | List | カスタムフィールドの定義キー(schemaKey) |
customField.{schemaKey}[].value | String | カスタムフィールドのテキスト |
customField.{schemaKey}[].link | String | カスタムフィールドのタイプがlinkの場合、URL |
Response Example
{
"tenantId": 1,
"domainId": 1,
"externalKey": "EX123",
"master": false,
"manager": false,
"absence": false,
"resigned": false,
"standby": false,
"email": "localpart@domain.com",
"name": {
"lastName": "lastName",
"firstName": "firstName",
"phoneticLastName": "",
"phoneticFirstName": ""
},
"i18nNames": [
{
"language": "en_US",
"firstName": "firstName",
"lastName": "lastName"
},
{
"firstName": "firstName",
"lastName": "lastName"
}
],
"nickName": "nickName",
"privateEmail": "private@domain.com",
"aliasEmails": [
"alias@domain.com"
],
"telePhone": "000000000",
"location": "worksPlace",
"task": "task",
"messenger": {
"protocol": "LINE",
"messengerId": "messenger"
},
"birthday": "2015.04.01",
"hireDate": "2015.04.01",
"searchable": true,
"organizations": [
{
"domainId": 1,
"primary": true,
"externalKey": "EX123",
"email": "localpart@domain.com",
"orgUnits": [
{
"domainId": 1,
"externalKey": "PST123",
"primary": true,
"manager": true,
"display": true,
"receiveEmail": true
}
]
}
],
"relations": [],
"locale": "ja_JP",
"timeZone": "Asia/Tokyo",
"customField": {
"schema123": [
{
"value": "The Face Shop",
"link": "http://www.thefaceshop.com"
},
{
"value": "Beyond"
},
{
"link": "http://www.sum37.com"
}
],
"schema456": [
{
"value": "Tokyo Office"
},
{
"value": "Shibuya Tower"
}
]
}
}
Error Code
呼び出しに失敗するとエラーコードとエラーメッセージを返します。
エラーコードは組織連携REST APIエラーコードを参照してください。