Create API Server Operation
POST {{apiPath}}/environments/{{envID}}/apiServers/{{apiServerID}}/operations
The POST /environments/{{envID}}/apiServers/{{apiServerID}}/operations request creates a new 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 service 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"=>"AccountsPayable", "paths"=>[{"type"=>"EXACT", "pattern"=>"/accountsPayable"}], "methods"=>["POST", "PUT"]}
RESPONSES
status: Created
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/apiServers/a82aa1c1-1a8e-4b6e-a43e-2266ebd57626/operations/ad5d139a-c4b3-40d9-a030-29b393391ecc"},"environment":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"apiServer":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/apiServers/a82aa1c1-1a8e-4b6e-a43e-2266ebd57626"}},"id":"ad5d139a-c4b3-40d9-a030-29b393391ecc","name":"AccountsPayable","methods":["POST","PUT"],"paths":[{"type":"EXACT","pattern":"/accountsPayable"}]}