POST/groups/{groupId}/members

Adds a group member. This API operation cannot add a member to an external group or a dynamic group.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

directory
group

HTTP Request

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

Path Parameters

ParameterTypeDescription
groupId string 

Group ID or external key.
External key in "externalKey:{externalKey}" format


required 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
id string 

Member, team, or group ID.
The following types are available for a member ID:
- Email address
- Resource ID
- External key in "externalKey:{externalKey}" format


required 
type string 

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