Deletes an agent
delete
/oaa-policy/agent/v1/{agentgid}
Request
Path Parameters
-
agentgid(required): string
Identifier of the agent.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Agent is deleted from the store.
Root Schema : AgentResponse
Type:
Show Source
object
-
agent: object
schema
Details of the agent
-
agentgid: string
Global identifier of the agent which can be used in the subsequent request.
-
message: string
Message related to the status of the request
-
status: string
Status of the request
Nested Schema : schema
Type:
object
Details of the agent
Show Source
-
agentgid: string
Unique identifier of the agent.
-
agentName(required): string
Unique name of the agent
-
clientId: string
Client id of the agent used to identify agents
-
clientSecret: string
Client secret used for the authenticating client
-
clientType(required): string
Client type. Possible value for this field is OAM, Radius or API.
-
createTime: string
(date-time)
"Date time string in the format rfc3339 sec 5.6. https://tools.ietf.org/html/rfc3339#section-5.6"
-
description: string
Description of the agent
-
privateKey: string
String representation of the private key of the agent which can be used to encrypt/decrypt the request parameters.
-
privateKeyFile: string
File name of the private key.
-
privateKeyPassword: string
Base64 encoded password of the private key.
-
updateTime: string
(date-time)
"Date time string in the format rfc3339 sec 5.6. https://tools.ietf.org/html/rfc3339#section-5.6"
401 Response
Unauthorized
405 Response
Invalid input
Root Schema : AgentResponse
Type:
Show Source
object
-
agent: object
schema
Details of the agent
-
agentgid: string
Global identifier of the agent which can be used in the subsequent request.
-
message: string
Message related to the status of the request
-
status: string
Status of the request
Nested Schema : schema
Type:
object
Details of the agent
Show Source
-
agentgid: string
Unique identifier of the agent.
-
agentName(required): string
Unique name of the agent
-
clientId: string
Client id of the agent used to identify agents
-
clientSecret: string
Client secret used for the authenticating client
-
clientType(required): string
Client type. Possible value for this field is OAM, Radius or API.
-
createTime: string
(date-time)
"Date time string in the format rfc3339 sec 5.6. https://tools.ietf.org/html/rfc3339#section-5.6"
-
description: string
Description of the agent
-
privateKey: string
String representation of the private key of the agent which can be used to encrypt/decrypt the request parameters.
-
privateKeyFile: string
File name of the private key.
-
privateKeyPassword: string
Base64 encoded password of the private key.
-
updateTime: string
(date-time)
"Date time string in the format rfc3339 sec 5.6. https://tools.ietf.org/html/rfc3339#section-5.6"
500 Response
Internal server error
503 Response
Service Unavailable
Examples
The following example shows a sample request and response for deleting an agent.
cURL Command to Delete an Agent in JSON Format
curl --location --request DELETE '<PolicyUrl>/oaa-policy/agent/v1/ed022f31-c5f5-4665-8a19-159655f514ae' \ --header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'
Sample Response in JSON Format
{ "status": "200", "message": "Agent deleted", "agentgid": "ed022f31-c5f5-4665-8a19-159655f514ae", "agent": { "agentName": "APIAgent2", "description": "Agent for REST API", "clientId": "0a47d442-9dc0-4841-b734-8e15e1634ee4", "clientSecret": "273a8d9c-29ad-4956-bc8d-69ffcfbf1d73", "clientType": "api", "agentgid": "ed022f31-c5f5-4665-8a19-159655f514ae", "createTime": { "parseFailed": false, "dateTime": "2021-04-01T09:19:23.28Z", "rawParam": "2021-04-01T09:19:23.28Z" }, "updateTime": { "parseFailed": false, "dateTime": "2021-04-01T09:19:23.28Z", "rawParam": "2021-04-01T09:19:23.28Z" } } }
cURL Command to Delete an Agent in XML Format
curl --location --request DELETE '<PolicyUrl>/oaa-policy/agent/v1/ed022f31-c5f5-4665-8a19-159655f514ae' \ --header 'Content-Type: application/xml' \ --header 'Accept: application/xml' \ --header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'
Sample Response in XML Format
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <AgentResponse> <status>200</status> <message>Agent deleted</message> <agentgid>ed022f31-c5f5-4665-8a19-159655f514ae</agentgid> <agent> <agentName>APIAgent2</agentName> <description>Agent for REST API</description> <clientId>0a47d442-9dc0-4841-b734-8e15e1634ee4</clientId> <clientSecret>273a8d9c-29ad-4956-bc8d-69ffcfbf1d73</clientSecret> <clientType>api</clientType> <agentgid>ed022f31-c5f5-4665-8a19-159655f514ae</agentgid> <createTime> <parseFailed>false</parseFailed> <dateTime>2021-04-01T09:19:23.28Z</dateTime> <rawParam>2021-04-01T09:19:23.28Z</rawParam> </createTime> <updateTime> <parseFailed>false</parseFailed> <dateTime>2021-04-01T09:19:23.28Z</dateTime> <rawParam>2021-04-01T09:19:23.28Z</rawParam> </updateTime> </AgentResponse>