POST/groups/{groupId}/members

グループにメンバーを追加する

Authorization

oauth2

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

Scope

directory
group

HTTP Request

POSThttps://www.worksapis.com/v1.0/groups/{groupId}/members

Path Parameters

ParameterTypeDescription
groupId string 

グループを特定する ID (URL エンコードする)

  • グループ ID (groupId)
  • グループの ExternalKey (externalKey:{groupExternalKey})

required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
id string 

グループメンバーのユーザー/組織/グループの ID (URL エンコードする)
ユーザー ID は以下を指定可能

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

required 
type string 

グループメンバータイプ

  • USER : ユーザー
  • ORGUNIT : 組織
  • GROUP : グループ

required
Allowed values : USER, ORGUNIT, GROUP 

Request Example

user example

1{2  "id": "userf7da-f82c-4284-13e7-030f3b4c756x",3  "type": "USER"4}

orgunit example

1{2  "id": "orgunitf-f27f-4af8-27e1-03817a911417",3  "type": "ORGUNIT"4}

group example

1{2  "id": "group769-e656-477d-69c7-04e2f73a4a77",3  "type": "GROUP"4}

Response

HTTP 201

Created

HTTP 400

Bad Request

HTTP 403

Forbidden

HTTP 404

Not Found

HTTP 409

Conflict