SetGroupMembers

PUT

https://orgs.ezghcloud.com/v1/organizations/{orgId}/groups/{groupId}/members

View as Markdown

Authorization

apiKeyoptionalHTTP
sessionCookieoptionalAPI key in cookie
oauthoptionalHTTP

Path parameters

orgIdstringrequired
groupIdstringrequired

Header parameters

if-matchoptionalstring

Request bodyJSONrequired

membersarray ofobjectrequired
2 properties
- typeuserorbotrequired
- idstringrequired

Returns

200

Success

JSON

membersarray ofobjectrequired
2 properties
- typeuserorbotrequired
- idstringrequired

400

InvalidRequest

JSON

errorobjectrequired
3 properties
- codeinvalid_requestrequired
- messagestringrequired
- issuesoptionalarray ofobject
  2 properties
  pathstringrequired
  messagestringrequired

401

Unauthenticated

JSON

errorobjectrequired
2 properties
- codeunauthenticatedrequired
- messagestringrequired

403

AccessDenied | ForbiddenOrigin

JSON

One of the following:

AccessDeniedEncoded
View AccessDeniedEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeaccess_deniedrequired
  messagestringrequired
ForbiddenOriginEncoded
View ForbiddenOriginEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeforbidden_originrequired
  messagestringrequired

404

NotFound

JSON

errorobjectrequired
2 properties
- codenot_foundrequired
- messagestringrequired

409

ManagedByScim

JSON

errorobjectrequired
2 properties
- codemanaged_by_scimrequired
- messagestringrequired

412

PreconditionFailed

JSON

errorobjectrequired
2 properties
- codeprecondition_failedrequired
- messagestringrequired

429

TooManyRequests

JSON

errorobjectrequired
2 properties
- codetoo_many_requestsrequired
- messagestringrequired

500

InternalError

JSON

errorobjectrequired
2 properties
- codeinternal_errorrequired
- messagestringrequired

503

Unavailable

JSON

errorobjectrequired
2 properties
- codeunavailablerequired
- messagestringrequired

curl --request PUT \ --url https://orgs.ezghcloud.com/v1/organizations/string/groups/string/members \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "members": [ { "type": "user", "id": "string" } ] } '