Update API Service Operation
PUT {{apiPath}}/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}
The PUT /environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}
request updates an API service operation associated with the environment and API service specified in the request URL.
Prerequisites
- See PingOne Authorize and PingOne Authorize API Access Management for important overview information.
For property descriptions, see API server operations data model
Property | Type? | Required? |
---|---|---|
accessControl | Object | Optional |
accessControl.custom | Object | Optional |
accessControl.custom.enabled | Boolean | Optional |
accessControl.group | Object | Optional |
accessControl.group.groups | Array | Required |
accessControl.group.groups.element | Relationship | Required |
accessControl.group.groups.element.id | String | Required |
accessControl.permission | Object | Optional |
accessControl.permission.id | Object | Optional |
accessControl.scope | Object | Optional |
accessControl.scope.matchType | String | Optional |
accessControl.scope.scopes | Array | Required |
accessControl.scope.scopes.element | Object | Required |
accessControl.scope.scopes.element.id | String | Required |
methods | Array | Optional |
name | String | Required |
paths | Array | Required |
paths.type | String | Required |
paths.pattern | String | Required |
Request Body
{"name"=>"Accounts", "paths"=>[{"type"=>"EXACT", "pattern"=>"/accounts"}], "methods"=>["POST", "PUT"], "accessControl"=>{"group"=>{"groups"=>[{"id"=>"{endUserGroupId}"}]}, "scope"=>{"matchType"=>"ANY", "scopes"=>[{"id"=>"{scopeId}"}, {"id"=>"{secondScopeId}"}]}}}
RESPONSES
status: Created
{"_links":{"self":{"href":".../environments/{envId}/apiServers/{serverId}/operations/{id}"},"apiServer":{"href":".../environments/{envId}/apiServers/{serverId}"}},"name":"Accounts","id":"{operationId}","paths":[{"type":"EXACT","pattern":"/accounts"}],"methods":["POST","PUT"],"accessControl":{"group":{"groups":[{"id":"{endUserGroupId}"}]},"scope":{"matchType":"ANY","scopes":[{"id":"{scopeId}"},{"id":"{secondScopeId}"}]}}}