Jump to

• Request
• Response
• Examples

Creates an agent

post

/oaa-policy/agent/v1

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root 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"

{
    "type":"object",
    "description":"Details of the agent",
    "required":[
        "agentName",
        "clientType"
    ],
    "properties":{
        "agentName":{
            "type":"string",
            "description":"Unique name of the agent"
        },
        "description":{
            "type":"string",
            "description":"Description of the agent"
        },
        "clientId":{
            "type":"string",
            "description":"Client id of the agent used to identify agents"
        },
        "clientSecret":{
            "type":"string",
            "description":"Client secret used for the authenticating client"
        },
        "clientType":{
            "type":"string",
            "description":"Client type. Possible value for this field is OAM, Radius or API."
        },
        "agentgid":{
            "type":"string",
            "description":"Unique identifier of the agent."
        },
        "privateKey":{
            "type":"string",
            "description":"String representation of the private key of the agent which can be used to encrypt/decrypt the request parameters."
        },
        "privateKeyPassword":{
            "type":"string",
            "description":"Base64 encoded password of the private key."
        },
        "privateKeyFile":{
            "type":"string",
            "description":"File name of the private key."
        },
        "createTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"Time when agent was created."
        },
        "updateTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"Time when agent was updated."
        }
    }
}

Request Body - application/json ()

Root 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"

{
    "type":"object",
    "description":"Details of the agent",
    "required":[
        "agentName",
        "clientType"
    ],
    "properties":{
        "agentName":{
            "type":"string",
            "description":"Unique name of the agent"
        },
        "description":{
            "type":"string",
            "description":"Description of the agent"
        },
        "clientId":{
            "type":"string",
            "description":"Client id of the agent used to identify agents"
        },
        "clientSecret":{
            "type":"string",
            "description":"Client secret used for the authenticating client"
        },
        "clientType":{
            "type":"string",
            "description":"Client type. Possible value for this field is OAM, Radius or API."
        },
        "agentgid":{
            "type":"string",
            "description":"Unique identifier of the agent."
        },
        "privateKey":{
            "type":"string",
            "description":"String representation of the private key of the agent which can be used to encrypt/decrypt the request parameters."
        },
        "privateKeyPassword":{
            "type":"string",
            "description":"Base64 encoded password of the private key."
        },
        "privateKeyFile":{
            "type":"string",
            "description":"File name of the private key."
        },
        "createTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"Time when agent was created."
        },
        "updateTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"Time when agent was updated."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

201 Response

Agent is created

Body ()

Root Schema : AgentResponse

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request"
        },
        "message":{
            "type":"string",
            "description":"Message related to the status of the request"
        },
        "agentgid":{
            "type":"string",
            "description":"Global identifier of the agent which can be used in the subsequent request."
        },
        "agent":{
            "description":"Original request object which was used for creating the agent",
            "$ref":"#/components/schemas/Agent"
        }
    }
}

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"

{
    "type":"object",
    "description":"Details of the agent",
    "required":[
        "agentName",
        "clientType"
    ],
    "properties":{
        "agentName":{
            "type":"string",
            "description":"Unique name of the agent"
        },
        "description":{
            "type":"string",
            "description":"Description of the agent"
        },
        "clientId":{
            "type":"string",
            "description":"Client id of the agent used to identify agents"
        },
        "clientSecret":{
            "type":"string",
            "description":"Client secret used for the authenticating client"
        },
        "clientType":{
            "type":"string",
            "description":"Client type. Possible value for this field is OAM, Radius or API."
        },
        "agentgid":{
            "type":"string",
            "description":"Unique identifier of the agent."
        },
        "privateKey":{
            "type":"string",
            "description":"String representation of the private key of the agent which can be used to encrypt/decrypt the request parameters."
        },
        "privateKeyPassword":{
            "type":"string",
            "description":"Base64 encoded password of the private key."
        },
        "privateKeyFile":{
            "type":"string",
            "description":"File name of the private key."
        },
        "createTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"Time when agent was created."
        },
        "updateTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"Time when agent was updated."
        }
    }
}

401 Response

Unauthorized

405 Response

Invalid input

Body ()

Root Schema : AgentResponse

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the request"
        },
        "message":{
            "type":"string",
            "description":"Message related to the status of the request"
        },
        "agentgid":{
            "type":"string",
            "description":"Global identifier of the agent which can be used in the subsequent request."
        },
        "agent":{
            "description":"Original request object which was used for creating the agent",
            "$ref":"#/components/schemas/Agent"
        }
    }
}

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"

{
    "type":"object",
    "description":"Details of the agent",
    "required":[
        "agentName",
        "clientType"
    ],
    "properties":{
        "agentName":{
            "type":"string",
            "description":"Unique name of the agent"
        },
        "description":{
            "type":"string",
            "description":"Description of the agent"
        },
        "clientId":{
            "type":"string",
            "description":"Client id of the agent used to identify agents"
        },
        "clientSecret":{
            "type":"string",
            "description":"Client secret used for the authenticating client"
        },
        "clientType":{
            "type":"string",
            "description":"Client type. Possible value for this field is OAM, Radius or API."
        },
        "agentgid":{
            "type":"string",
            "description":"Unique identifier of the agent."
        },
        "privateKey":{
            "type":"string",
            "description":"String representation of the private key of the agent which can be used to encrypt/decrypt the request parameters."
        },
        "privateKeyPassword":{
            "type":"string",
            "description":"Base64 encoded password of the private key."
        },
        "privateKeyFile":{
            "type":"string",
            "description":"File name of the private key."
        },
        "createTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"Time when agent was created."
        },
        "updateTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"Time when agent was updated."
        }
    }
}

500 Response

Internal server error

503 Response

Service Unavailable

Back to Top

Examples

The following example shows a sample request and response for creating an agent.

cURL Command to Create Agent in JSON Format

curl --location --request POST '<PolicyUrl>/oaa-policy/agent/v1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
    "agentName": "APIAgent",
    "description": "Agent for REST API",
    "clientType": "API"
}'

Sample Response in JSON Format

{
    "status": "201",
    "message": "Successfully created agent.",
    "agentgid": "dede64d3-1d6a-42e9-89e1-714e88f8967c",
    "agent": {
        "agentName": "APIAgent",
        "description": "Agent for REST API",
        "clientId": "c1e08e6a-b555-47e1-84a5-36edd06fbf57",
        "clientSecret": "b2484989-5f42-4ad8-b0ab-7bbaa06ee786",
        "clientType": "api",
        "agentgid": "dede64d3-1d6a-42e9-89e1-714e88f8967c",
        "createTime": {
            "parseFailed": false,
            "dateTime": "2021-04-01T09:06:13.668Z",
            "rawParam": "2021-04-01T09:06:13.668Z"
        },
        "updateTime": {
            "parseFailed": false,
            "dateTime": "2021-04-01T09:06:13.668Z",
            "rawParam": "2021-04-01T09:06:13.668Z"
        }
    }
}

cURL Command to Create Agent in XML Format

curl --location --request POST '<PolicyUrl>/oaa-policy/agent/v1' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '<?xml version="1.0" encoding="UTF-8" ?>
<Agent>
     <agentName>APIAgent</agentName>
     <description>Agent for REST API</description>
     <clientType>API</clientType>
</Agent>'

Sample Response in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <AgentResponse>
     <status>201</status>
     <message>Successfully created agent.</message>
     <agentgid>dede64d3-1d6a-42e9-89e1-714e88f8967c</agentgid>
     <agent>
         <agentName>APIAgent</agentName>
         <description>Agent for REST API</description>
         <clientId>c1e08e6a-b555-47e1-84a5-36edd06fbf57</clientId>
         <clientSecret>b2484989-5f42-4ad8-b0ab-7bbaa06ee786</clientSecret>
         <clientType>api</clientType>
         <agentgid>dede64d3-1d6a-42e9-89e1-714e88f8967c</agentgid>
         <createTime>
             <parseFailed>false</parseFailed>
             <dateTime>2021-04-01T09:06:13.668Z</dateTime>
             <rawParam>2021-04-01T09:06:13.668Z</rawParam>
         </createTime>
         <updateTime>
             <parseFailed>false</parseFailed>
             <dateTime>2021-04-01T09:06:13.668Z</dateTime>
             <rawParam>2021-04-01T09:06:13.668Z</rawParam>
         </updateTime>
     </agent>
 </AgentResponse>

Back to Top