GET/users/{userId}

ユーザーのプロフィールを取得する。

  • この API は、必ず user.profile.read scope で取得した Access Token で呼び出す必要があります。
  • user / user.read / directory / directory.read scope を含む Access Token で呼び出す場合、ユーザーの情報を取得 します。

注意
取得できるプロパティは、管理項目 設定などのサービスによる制約に従います。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

user.profile.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/users/{userId}

Path Parameters

ParameterTypeDescription
userId string 

ユーザーを特定する ID (URL エンコードする)

  • ユーザー ID (userId)
  • ログイン ID (email)
  • ユーザーの ExternalKey (externalKey:{userExternalKey})

required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
userId string 

ユーザー ID

  • ユーザーのリソース ID
  • 登録時に自動発行されるユニーク ID
 
userExternalKey string 

ユーザーの ExternalKey
"%"、"\"、"#"、"/"、"?" の特殊文字は利用できない。


maxLength : 100
nullable : true 
email string 

メールアドレス
アドバンストプランで原職と兼職に異なるメールアドレスを設定するときに使用。


maxLength : 90 
userName object (userName) 

名前情報

 
i18nNames array (UserI18nName) 

多言語名リスト


minItems : 0 
organizations array (UserOrganization) 

ユーザーが所属するドメインリスト (原職、兼職含む)


minItems : 0 
telephone string 

電話番号
許容される特殊文字: -*#+P T()


maxLength : 100
pattern : ^(?=.*[0-9])[0-9+\-*#PTpt()\u3000]{0,100}
nullable : true 
cellPhone string 

携帯電話番号
許容される特殊文字: -*#+P T()


maxLength : 100
pattern : ^(?=.*[0-9])[0-9+\-*#PTpt()\u3000]{0,100}
nullable : true 
location string 

勤務先


maxLength : 100
nullable : true 

userName

PropertyTypeDescription
lastName string 

姓

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

maxLength : 80
nullable : true 
firstName string 

名

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

maxLength : 80
nullable : true 
phoneticLastName string 

姓のフリガナ (カタカナのみ許可)


maxLength : 100
nullable : true 
phoneticFirstName string 

名のフリガナ (カタカナのみ許可)


maxLength : 100
nullable : true 

UserI18nName

PropertyTypeDescription
language string 

多言語コード


Allowed values : ko_KR, ja_JP, zh_CN, zh_TW, en_US 
firstName string 

多言語の名

  • 組織図の多言語の名の後ろに表示
  • 許容される特殊文字: !@&()-_+[]{},./#'`^~

maxLength : 100
nullable : true 
lastName string 

多言語の姓

  • 組織図の多言語の名の前に表示
  • 許容される特殊文字: !@&()-_+[]{},./#'`^~

maxLength : 100
nullable : true 

UserOrganization

PropertyTypeDescription
domainId integer 

ドメイン ID


format : int32 
primary boolean 

代表ドメインフラグ
必ず代表 (primary: true) を 1 つ設定してください。 代表を設定しない場合、自動的に一番最初の値が代表に設定されます。

 
userExternalKey string 

顧客企業で管理するユーザーの ExternalKey

注意

  • organizations[].userExternalKey ではなく、user の userExternalKey の値を参照してください。
    "**%"、"_\**"、"#_"、"**/"、"_?_**" の特殊文字は利用不可。

maxLength : 100
readOnly : true
nullable : true 
email string 

メールアドレス
アドバンストプランで原職と兼職に異なるメールアドレスを設定するときに使用。


maxLength : 90 
levelId string 

職級 ID


nullable : true 
levelExternalKey string 

職級の ExternalKey


maxLength : 100
nullable : true 
levelName string 

職級名


nullable : true 
executive boolean 

役員フラグ

 
organizationName string 

会社名

 
orgUnits array (object) 

組織リスト


minItems : 0
maxItems : 30 

object

PropertyTypeDescription
orgUnitId string 

組織 ID

 
orgUnitExternalKey string 

組織の ExternalKey


maxLength : 100
nullable : true 
orgUnitName string 

組織名

 
orgUnitEmail string 

組織のメールアドレス

 
primary boolean 

代表組織フラグ

 
positionId string 

役職 ID


nullable : true 
positionExternalKey string 

役職の ExternalKey


maxLength : 100
nullable : true 
positionName string 

役職名


nullable : true 
isManager boolean 

組織長フラグ


default : false 
visible boolean 

ユーザー公開フラグ
組織図から組織のユーザーとして表示するかどうか。


default : true 
useTeamFeature boolean 

組織のトークルーム機能の利用フラグ (既定値: true)
組織に所属しているがトークルームでのメッセージ受信やファイル共有、組織メール受信などの、組織のトークルーム機能を制限したい場合にこのパラメータを利用する。
この値が true の場合、以下の機能を利用可能。

  • 組織トークルームのメンバーとして参加 (トーク、ノート、カレンダー、フォルダの閲覧)
  • 組織宛メールの受信
  • 組織カレンダーの参照、および宛の予定招待の受信
  • 組織宛に共有された掲示板、Drive、アンケート回答
  • 組織をグループのユーザーとして設定した場合、グループのユーザーに含まれる 組織のユーザーとして所属しているが、上記のような組織のトークルーム機能を利用しない場合、この値を false に設定する。

default : true 

Response Example

example

1{2  "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",3  "userExternalKey": null,4  "email": "localpart@example.com",5  "telephone": "03-1234-5678",6  "cellPhone": "090-1234-5678",7  "location": "green building",8  "userName": {9    "lastName": "ワークス",10    "firstName": "太郎",11    "phoneticLastName": null,12    "phoneticFirstName": null13  },14  "i18nName": [],15  "organizations": [16    {17      "domainId": 10000001,18      "primary": true,19      "userExternalKey": null,20      "email": "localpart@example.com",21      "levelId": "levelaa7-b824-4937-66af-042f1f43cefa",22      "levelExternalKey": null,23      "levelName": "一般社員",24      "executive": false,25      "organizationName": "org",26      "orgUnits": [27        {28          "orgUnitId": "orgunitf-f27f-4af8-27e1-03817a911417",29          "orgUnitExternalKey": null,30          "orgUnitEmail": "team01@example.com",31          "orgUnitName": "組織",32          "primary": true,33          "positionId": "position-7027-4a02-b838-6f52b5e38db7",34          "positionExternalKey": null,35          "positionName": "社員",36          "isManager": true,37          "visible": true,38          "useTeamFeature": true39        }40      ]41    }42  ]43}

HTTP 404

Not Found