Summary
Create a new group for Local AAA instance.
Description
Create a new group for Local AAA instance in IAP.
Route
POST /user-management/groups
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| group |
object |
yes |
An object containing all the group properties. |
Copied to Clipboard
{
"group": {
"name": "Admin"
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"group": {
"title": "group",
"type": "object",
"properties": {
"name": {
"type": "string",
"examples": [
"Admin"
]
}
},
"required": [
"name"
]
}
},
"required": [
"group"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
The result of the group creation process. |
Copied to Clipboard
{
"status": "Created",
"message": "A sample success message",
"data": {
"_id": "5dd2cdab94410956f3ecbc79",
"provenance": "Local AAA",
"name": "Admin",
"memberOf": [
{
"groupId": "5dd2cdab94410956f3ecbc79",
"aaaManaged": true
},
{
"groupId": "5dd2cdab94410956f3ecbc79",
"aaaManaged": true
},
{
"groupId": "5dd2cdab94410956f3ecbc79",
"aaaManaged": true
},
{
"groupId": "5dd2cdab94410956f3ecbc79",
"aaaManaged": true
},
{
"groupId": "5dd2cdab94410956f3ecbc79",
"aaaManaged": true
}
],
"assignedRoles": [
{
"roleId": "1004"
},
{
"roleId": "1004"
}
],
"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": {
"title": "result",
"type": "object",
"properties": {
"_id": {
"type": "string",
"examples": [
"5dd2cdab94410956f3ecbc79"
]
},
"provenance": {
"type": "string",
"examples": [
"Local AAA"
]
},
"name": {
"type": "string",
"examples": [
"Admin"
]
},
"memberOf": {
"type": "array",
"items": {
"type": "object",
"properties": {
"groupId": {
"type": "string",
"examples": [
"5dd2cdab94410956f3ecbc79"
]
},
"aaaManaged": {
"type": "boolean",
"enum": [
true
]
}
}
}
},
"assignedRoles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"roleId": {
"type": "string",
"examples": [
"1004"
]
}
}
}
},
"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"
]
}
}
}
}
}
}
}
