UpdatePolicy

PATCH

https://orgs.ezghcloud.com/v1/organizations/{orgId}/policies/{policyId}

View as Markdown

Authorization

apiKeyoptionalHTTP
sessionCookieoptionalAPI key in cookie
oauthoptionalHTTP

Path parameters

orgIdstringrequired
policyIdstringrequired

Header parameters

if-matchoptionalstring

Request bodyJSONrequired

nameoptionalstring
descriptionoptionalstring
documentoptionalobject
1 properties
- statementsarray ofobjectrequired
  4 properties
  effectallowordenyrequired
  actionsarray ofstringrequired
  resourcesarray ofstringrequired
  maxLength: 1024
  sidoptionalstring
  maxLength: 64

Returns

200

Success

JSON

idstringrequired
typemanagedorcustomrequired
namestringrequired
slugstringornullrequired
2 variants
One of the following:
string
null
resourceNamestringornullrequired
2 variants
One of the following:
string
null
descriptionstringrequired
documentobjectrequired
1 properties
- statementsarray ofobjectrequired
  4 properties
  effectallowordenyrequired
  actionsarray ofstringrequired
  resourcesarray ofstringrequired
  sidoptionalstring
statusactiveordeprecatedrequired
attachmentsnumberorstringrequired
2 variants
One of the following:
number
string
createdAtstringornullrequired
2 variants
One of the following:
string
null
updatedAtstringornullrequired
2 variants
One of the following:
string
null

400

InvalidRequest

JSON

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

401

Unauthenticated

JSON

errorobjectrequired
2 properties
- codeunauthenticatedrequired
- messagestringrequired

403

Forbidden | AccessDenied | ForbiddenOrigin

JSON

One of the following:

ForbiddenEncoded
View ForbiddenEncoded schema →
1 properties
- errorobjectrequired
  2 properties
  codeforbiddenrequired
  messagestringrequired
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

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/policies/string \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "string", "description": "string", "document": { "statements": [ { "sid": "string", "effect": "allow", "actions": [ "string" ], "resources": [ "string" ] } ] } } '

{ "id": "string", "type": "managed", "name": "string", "slug": "string", "resourceName": "string", "description": "string", "document": { "statements": [ { "sid": "string", "effect": "allow", "actions": [ "string" ], "resources": [ "string" ] } ] }, "status": "active", "attachments": 0, "createdAt": "string", "updatedAt": "string" }