UpdateGroup

PATCH

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

View as Markdown

Authorization

apiKeyoptionalHTTP
sessionCookieoptionalAPI key in cookie
oauthoptionalHTTP

Path parameters

orgIdstringrequired
groupIdstringrequired

Header parameters

if-matchoptionalstring

Request bodyJSONrequired

nameoptionalstring
descriptionoptionalstring

Returns

200

Success

JSON

idstringrequired
namestringrequired
slugstringrequired
resourceNamestringrequired
descriptionstringrequired
membersarray ofobjectrequired
2 properties
- typeuserorbotrequired
- idstringrequired
policyIdsarray ofstringrequired
managedBystringornullrequired
2 variants
One of the following:
string
null
lockedbooleanrequired
createdAtstringrequired
updatedAtstringrequired

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 PATCH \ --url https://orgs.ezghcloud.com/v1/organizations/string/groups/string \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "string", "description": "string" } '

{ "id": "string", "name": "string", "slug": "string", "resourceName": "string", "description": "string", "members": [ { "type": "user", "id": "string" } ], "policyIds": [ "string" ], "managedBy": "scim", "locked": true, "createdAt": "string", "updatedAt": "string" }