Add Service Account

This API is used to create a new service account.

URL: avxapi/acctmgmt-add-service-account?gwsource=web&gwkey=f000ca

Method - Post

Response Format: JSON

Requires authentication: Yes

Request timeout period:15 minutes

Param Type Name Description Field Type
Header sessionId** (or) Token** Use either Session Id or Token received after login string
Query email Email Address string
Payload loginName** Unique names used as the service account name for authentication. Duplication is not allowed. string
Payload description Description of the service account string
Header Content-Type Specifies the nature of the data in the payload (The value of the param should be "application/json") string

** - Mandatory value

Possible Response Message and Code

HTTP Code Description Response Message
400 Bad request Mandatory field 'name' is missing.
201 Created Resource added successfully.
409 Conflict Resource with the given name already exists.
407 Proxy Authentication Required The Username and Password field is mandatory.

Sample Request/Response

Use Case

To add a Service account.

Request URL

avxapi/acctmgmt-add-service-account?gwsource=web&gwkey=f000ca

Request Payload
 {
"payload": {
"loginName":"internal90",
"email": "[email protected]",
"description":"description"
}
}
 
Response
 {
"response": null,
"message": null,
"appStatusCode": null,
"tags": null,
"headers": null
}