Summary
Create a new account for Local AAA instance.
Description
Create a new account for Local AAA instance in IAP.
Route
POST /user-management/accounts
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| account |
object |
yes |
An object containing all the account properties. |
Copied to Clipboard
{
"account": {
"username": "admin@pronghorn",
"password": "$2a$08$SLW8yGVhHUaXL5Hjgp30DOvYsY5Jx39AsiSzpUOn",
"groups": [
"pronghorn_admin",
"pronghorn_admin",
"pronghorn_admin",
"pronghorn_admin",
"pronghorn_admin"
]
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"account": {
"title": "account",
"type": "object",
"properties": {
"username": {
"type": "string",
"examples": [
"admin@pronghorn"
]
},
"password": {
"type": "string",
"examples": [
"$2a$08$SLW8yGVhHUaXL5Hjgp30DOvYsY5Jx39AsiSzpUOn"
]
},
"groups": {
"type": "array",
"items": {
"type": "string",
"examples": [
"pronghorn_admin"
]
}
}
},
"required": [
"username",
"password"
]
}
},
"required": [
"account"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
The result of the account creation process. |
Copied to Clipboard
{
"status": "Created",
"message": "A sample success message",
"data": {
"_id": "5dd2cdab94410956f3ecbc79",
"provenance": "Local AAA",
"username": "john_doe",
"firstname": "john",
"memberOf": [
{
"groupId": "5dd2cdab94410956f3ecbc79",
"aaaManaged": true
},
{
"groupId": "5dd2cdab94410956f3ecbc79",
"aaaManaged": true
},
{
"groupId": "5dd2cdab94410956f3ecbc79",
"aaaManaged": true
}
],
"lastLogin": "2020-10-26T15:17:17.582Z",
"inactive": false,
"_meta": {
"created": "2020-10-26T15:17:17.582Z",
"updated": "2020-10-26T15:17:17.582Z"
}
}
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"status": {
"$ref": "common-schema#/definitions/status"
},
"message": {
"$ref": "common-schema#/definitions/message"
},
"data": {
"_id": {
"type": "string",
"examples": [
"5dd2cdab94410956f3ecbc79"
]
},
"provenance": {
"type": "string",
"examples": [
"Local AAA"
]
},
"username": {
"type": "string",
"examples": [
"john_doe"
]
},
"firstname": {
"type": "string",
"examples": [
"john"
]
},
"memberOf": {
"type": "array",
"items": {
"type": "object",
"properties": {
"groupId": {
"type": "string",
"examples": [
"5dd2cdab94410956f3ecbc79"
]
},
"aaaManaged": {
"type": "boolean",
"enum": [
true
]
}
}
}
},
"lastLogin": {
"type": "string",
"examples": [
"2020-10-26T15:17:17.582Z"
]
},
"inactive": {
"type": "boolean",
"enum": [
true,
false
]
},
"_meta": {
"type": "object",
"properties": {
"created": {
"type": "string",
"examples": [
"2020-10-26T15:17:17.582Z"
]
},
"updated": {
"type": "string",
"examples": [
"2020-10-26T15:17:17.582Z"
]
}
}
}
}
}
}
