Service Group - Flexible Security Service API References (1.0.0)
Download OpenAPI specification:Download
Service Group brings together several Node Groups.
Get Service Groups
Get Service Group resources.
Authorizations:
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,255}$ A name of the resource. |
Responses
200
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
503
Service Unavailable
get/v1/service-groups
https://api.ntt.com/fsec-ers/v1/service-groups
Response samples
- 200
- 400
- 401
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "serviceGroups": [
- {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "service-group-a",
- "description": "service-group-a",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z"
}, - {
- "id": "12345678-1234-1234-1234-1234567890a2",
- "name": "service-group-b",
- "description": "service-group-b",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z"
}
]
}Create Service Group
Create Service Group resource.
Authorizations:
Request Body schema: application/json
| serviceGroup required | object (ServiceGroupCreateRequest) |
Responses
201
OK
400
Bad Request
401
Unauthorized
403
Forbidden
500
Internal Server Error
503
Service Unavailable
post/v1/service-groups
https://api.ntt.com/fsec-ers/v1/service-groups
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "serviceGroup": {
- "name": "service-group-a",
- "description": "service-group-a"
}
}Response samples
- 201
- 400
- 401
- 403
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "serviceGroup": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "service-group-a",
- "description": "service-group-a",
- "operationId": "12345678-1234-1234-1234-1234567890a1",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z"
}
}Get Service Group
Get Service Group resource.
Authorizations:
path Parameters
| service_group_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
503
Service Unavailable
get/v1/service-groups/{service_group_id}
https://api.ntt.com/fsec-ers/v1/service-groups/{service_group_id}
Response samples
- 200
- 400
- 401
- 404
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "serviceGroup": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "service-group-a",
- "description": "service-group-a",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z"
}
}Create Service Group
Create Service Group resource.
Authorizations:
path Parameters
| service_group_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
Request Body schema: application/json
| serviceGroup required | object (ServiceGroupUpdateRequest) |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
503
Service Unavailable
patch/v1/service-groups/{service_group_id}
https://api.ntt.com/fsec-ers/v1/service-groups/{service_group_id}
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "serviceGroup": {
- "name": "service-group-b",
- "description": "service-group-b"
}
}Response samples
- 200
- 400
- 401
- 404
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "serviceGroup": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "service-group-b",
- "description": "service-group-b",
- "operationId": "12345678-1234-1234-1234-1234567890a1",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z"
}
}Delete Service Group
Delete a Service Group resource.
Authorizations:
path Parameters
| service_group_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
Responses
200
OK
400
Bad Request
401
Unauthorized
404
Not Found
409
Conflict
500
Internal Server Error
503
Service Unavailable
delete/v1/service-groups/{service_group_id}
https://api.ntt.com/fsec-ers/v1/service-groups/{service_group_id}
Response samples
- 200
- 400
- 401
- 404
- 409
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "serviceGroup": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "name": "service-group-b",
- "description": "service-group-b",
- "operationId": "12345678-1234-1234-1234-1234567890a1",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z"
}
}