POST/users/{userId}/suspend

ユーザーを一時停止する。

参照

  • 最高管理者は 一時停止 ステータスに変更できない。
  • 使用中 ステータスのユーザーのみ 一時停止 ステータスに変更可能。

Authorization

oauth2

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

Scope

user
directory

HTTP Request

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

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 204

No Content

HTTP 400

Bad Request

HTTP 404

Not Found