GET/users/{userId}/link-url

LINE や外部 LINE WORKS のユーザーが LINE WORKS ユーザーと連携するための、外部トーク連携の招待用リンクを取得する。

注意

  • LINE WORKSサービスを契約中の場合に利用できます。
  • 外部ユーザーとのトーク権限があるユーザーの情報が取得できます。

Authorization

oauth2

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

Scope

user
user.read

HTTP Request

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

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 
linkUrl string 

外部トーク連携の招待用リンク URL

 

Response Example

example

1{2  "userId": "userf7da-f82c-4284-13e7-030f3b4c756x",3  "linkUrl": "https://works.do/RaNdomW"4}

HTTP 403

Forbidden

HTTP 404

Not Found