GET/users/{userId}

ユーザーのメールアドレス情報を取得する。

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

Authorization

oauth2

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

Scope

user.email.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

readOnly : true 
email string 

ログイン ID = メールアドレス
アドバンストプランの場合、ID@ドメイン名
他のプランの場合、ID@グループ名


maxLength : 90
readOnly : true 

Response Example

example

1{2  "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",3  "email": "localpart@example.com"4}

HTTP 404

Not Found