Update a group | Itential

Updates a group.

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

groupIdstringRequiredformat: "^[0-9a-f]{24}$"

The individual group to update.

request body

updatesobjectOptional

The output of the group update.

statusenum

The status of the API request.

Allowed values:

messagestring

Message containing either confirmation of the operation or the reason for the failure of the operation.

dataobject

This is the schema for an IAP group stored in Mongo

500

Internal Server Error

$	curl -X PATCH http://localhost:3000/authorization/groups/groupId \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{}'

1	{
2	"status": "OK",
3	"message": "A sample success message",
4	"data": {
5	"provenance": "Local AAA",
6	"name": "group_1",
7	"description": "description of group_1",
8	"memberOf": [
9	{
10	"aaaManaged": true,
11	"groupId": "5cb7b531d06cceb89fd21b1c"
12	}
13	],
14	"assignedRoles": [
15	{
16	"roleId": "5cb7b531d06cceb89fd21b1c"
17	}
18	],
19	"inactive": true,
20	"_meta": {
21	"created": "2018-08-02T15:56:12.912Z",
22	"updated": "2018-08-02T15:56:12.912Z"
23	}
24	}
25	}

$	curl -X PATCH http://localhost:3000/authorization/groups/groupId \
>	-H "Content-Type: application/json" \
>	-u "<username>:<password>" \
>	-d '{}'

1	{
2	"status": "OK",
3	"message": "A sample success message",
4	"data": {
5	"provenance": "Local AAA",
6	"name": "group_1",
7	"description": "description of group_1",
8	"memberOf": [
9	{
10	"aaaManaged": true,
11	"groupId": "5cb7b531d06cceb89fd21b1c"
12	}
13	],
14	"assignedRoles": [
15	{
16	"roleId": "5cb7b531d06cceb89fd21b1c"
17	}
18	],
19	"inactive": true,
20	"_meta": {
21	"created": "2018-08-02T15:56:12.912Z",
22	"updated": "2018-08-02T15:56:12.912Z"
23	}
24	}
25	}