User Group - Flexible Security Service API References (1.4.0)

Download OpenAPI specification:Download

manage user groups (Paloalto user groups)

Authentication

X-Auth-Token

Security Scheme Type	API Key
Header parameter name:	{keystone_token}

user-group

Get User Groups

Get user group resources.

Authorizations:

X-Auth-Token

query Parameters

id	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The ID of the resource.
name	string ^[a-zA-Z0-9-_]{1,31}$ A name of the resource.
fraGroupId	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ ID of the FRA group to which the resource belongs.
serviceGroupId	string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ ID of the service group to which the resource belongs.
tenantId	string ^[a-fA-F0-9]{32}$ ID of the tenant to which the resource belongs.
includeUsers	boolean Default: false Whether to include users field in the response.
limit	integer [ 1 .. 100 ] Default: 100 Maximum number of user groups to return.
offset	integer >= 0 Default: 0 Offset for pagination.
orderBy	string Default: "name" Value: "name" Field to sort by.
order	string Default: "asc" Enum: "asc" "desc" Sort direction.

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

503

Service Unavailable

get/v1/user-groups

https://api.ntt.com/fsec-ers/v1/user-groups

Response samples

Content type

application/json

Example

Copy

Expand all Collapse all


{"userGroups": 
[
{"id": "87654321-4321-4321-4321-abcdef123456",
"name": "user-group-a",
"description": "user-group-a",
"users": 
["aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
],
"predefined": false,
"fraGroupId": "12345678-1234-1234-1234-123456789abc",
"serviceGroupId": "12345678-1234-1234-1234-123456789def",
"tenantId": "0123456789abcdef0123456789abcdef",
"operationStatus": "COMPLETE",
"createdAt": "2026-01-22T12:34:56.000Z",
"updatedAt": "2026-01-22T12:34:56.000Z"
},
{"id": "87654321-4321-4321-4321-abcdef123457",
"name": "user-group-b",
"description": "user-group-b",
"users": 
["bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
],
"predefined": false,
"fraGroupId": "12345678-1234-1234-1234-123456789abc",
"serviceGroupId": "12345678-1234-1234-1234-123456789def",
"tenantId": "0123456789abcdef0123456789abcdef",
"operationStatus": "COMPLETE",
"createdAt": "2026-01-22T12:34:56.000Z",
"updatedAt": "2026-01-22T12:34:56.000Z"
}
],
"pagination": 
{"total": 100,
"requestedLimit": 20,
"returnedCount": 2,
"offset": 0
},
"truncation": 
{"truncated": true,
"reason": "Response size limit exceeded. Not all user groups are included in the response."
}
}

Create User Groups

Create multiple user group resources at once. Each FRA group can have up to 100 user groups including the predefined Customer_Default group, so up to 99 user groups can be created by request.

Authorizations:

X-Auth-Token

Request Body schema: application/json

userGroups

required

object (UserGroupCreateRequest)

Responses

202

Accepted

400

Bad Request

401

Unauthorized

409

Conflict

500

Internal Server Error

503

Service Unavailable

post/v1/user-groups

https://api.ntt.com/fsec-ers/v1/user-groups

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"userGroups": 
{"fraGroupId": "12345678-1234-1234-1234-123456789abc",
"groups": 
[
{"name": "user-group-a",
"description": "user-group-a",
"users": 
["aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
"cccccccc-cccc-cccc-cccc-cccccccccccc"
]
},
{"name": "user-group-b",
"description": "user-group-b",
"users": 
["dddddddd-dddd-dddd-dddd-dddddddddddd",
"eeeeeeee-eeee-eeee-eeee-eeeeeeeeeeee"
]
}
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"userGroups": 
{"fraGroupId": "12345678-1234-1234-1234-123456789abc",
"serviceGroupId": "12345678-1234-1234-1234-123456789def",
"tenantId": "0123456789abcdef0123456789abcdef",
"groupCount": 2,
"operationId": "99999999-9999-9999-9999-999999999999",
"operationStatus": "PROCESSING"
}
}

Update User Groups

Update multiple user group resources at once. For predefined user groups such as Customer_Default, only users can be updated; name and description cannot be changed.

Authorizations:

X-Auth-Token

Request Body schema: application/json

userGroups

required

object (UserGroupUpdateRequest)

Responses

202

Accepted

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

503

Service Unavailable

patch/v1/user-groups

https://api.ntt.com/fsec-ers/v1/user-groups

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"userGroups": 
{"fraGroupId": "12345678-1234-1234-1234-123456789abc",
"groups": 
[
{"id": "87654321-4321-4321-4321-abcdef123456",
"description": "user-group-a",
"users": 
["aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
"ffffffff-ffff-ffff-ffff-ffffffffffff"
]
}
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"userGroups": 
{"fraGroupId": "12345678-1234-1234-1234-123456789abc",
"serviceGroupId": "12345678-1234-1234-1234-123456789def",
"tenantId": "0123456789abcdef0123456789abcdef",
"groupCount": 1,
"operationId": "99999999-9999-9999-9999-999999999998",
"operationStatus": "PROCESSING"
}
}

Delete User Groups

Delete multiple user group resources at once.

Authorizations:

X-Auth-Token

Request Body schema: application/json

userGroups

required

object (UserGroupDeleteRequest)

Responses

202

Accepted

400

Bad Request

401

Unauthorized

404

Not Found

409

Conflict

500

Internal Server Error

503

Service Unavailable

post/v1/user-groups/delete

https://api.ntt.com/fsec-ers/v1/user-groups/delete

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"userGroups": 
{"fraGroupId": "12345678-1234-1234-1234-123456789abc",
"groupIds": 
["87654321-4321-4321-4321-abcdef123456",
"87654321-4321-4321-4321-abcdef123457"
]
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"userGroups": 
{"fraGroupId": "12345678-1234-1234-1234-123456789abc",
"serviceGroupId": "12345678-1234-1234-1234-123456789def",
"tenantId": "0123456789abcdef0123456789abcdef",
"groupCount": 2,
"operationId": "99999999-9999-9999-9999-999999999997",
"operationStatus": "PROCESSING"
}
}

Get User Group

Get user group resource.

Authorizations:

X-Auth-Token

path Parameters

group_id

required

string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

503

Service Unavailable

get/v1/user-groups/{group_id}

https://api.ntt.com/fsec-ers/v1/user-groups/{group_id}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"userGroup": 
{"id": "87654321-4321-4321-4321-abcdef123456",
"name": "user-group-a",
"description": "user-group-a",
"users": 
["aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
"cccccccc-cccc-cccc-cccc-cccccccccccc"
],
"predefined": false,
"fraGroupId": "12345678-1234-1234-1234-123456789abc",
"serviceGroupId": "12345678-1234-1234-1234-123456789def",
"tenantId": "0123456789abcdef0123456789abcdef",
"operationStatus": "COMPLETE",
"createdAt": "2026-01-22T12:34:56.000Z",
"updatedAt": "2026-01-22T12:34:56.000Z"
}
}