Flexible Security Service API References (1.0.0)
Download OpenAPI specification:Download
Portal users can log in to the Management Portal.
Get portal users
Get portal user 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. |
| userId | string ^[a-zA-Z0-9-_.]{1,31}$ A userId of the resource. |
| serviceGroupId | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ The service group ID of the resource. |
Responses
200
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
503
Service Unavailable
get/v1/portal-users
https://api.ntt.com/fsec-ers/v1/portal-users
Response samples
- 200
- 400
- 401
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "portalUsers": [
- {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "userId": "user01",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890b1",
- "role": "ReadWrite",
- "operationStatus": "COMPLETE",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z"
}, - {
- "id": "12345678-1234-1234-1234-1234567890a2",
- "userId": "user01",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890b2",
- "role": "ReadOnly",
- "operationStatus": "COMPLETE",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z"
}
]
}Create Portal user
Create Portal user resource.
Authorizations:
Request Body schema: application/json
| portalUser required | object (PortalUserCreateRequest) |
Responses
202
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
503
Service Unavailable
post/v1/portal-users
https://api.ntt.com/fsec-ers/v1/portal-users
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "portalUser": {
- "userId": "user01",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890a1",
- "role": "ReadWrite",
- "password": "Passw0rd"
}
}Response samples
- 202
- 400
- 401
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "portalUser": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "userId": "user01",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890b1",
- "role": "ReadWrite",
- "operationStatus": "PROCESSING",
- "operationId": "12345678-1234-1234-1234-1234567890c1",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z"
}
}Get portal user
Get portal user resource.
Authorizations:
path Parameters
| portal_user_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/portal-users/{portal_user_id}
https://api.ntt.com/fsec-ers/v1/portal-users/{portal_user_id}
Response samples
- 200
- 400
- 401
- 404
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "portalUser": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "userId": "user01",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890b1",
- "role": "ReadWrite",
- "operationStatus": "COMPLETE",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z"
}
}Update Portal user
Update Portal user resource.
Authorizations:
path Parameters
| portal_user_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
Request Body schema: application/json
| portalUser required | object (PortalUserUpdateRequest) |
Responses
202
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
503
Service Unavailable
patch/v1/portal-users/{portal_user_id}
https://api.ntt.com/fsec-ers/v1/portal-users/{portal_user_id}
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "portalUser": {
- "userId": "user02",
- "role": "ReadOnly",
- "password": "Passw0rd"
}
}Response samples
- 202
- 400
- 401
- 404
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "portalUser": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "userId": "user02",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890b1",
- "role": "ReadOnly",
- "operationStatus": "COMPLETE",
- "operationId": "12345678-1234-1234-1234-1234567890c1",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z"
}
}Delete portal user
Delete portal user resource.
Authorizations:
path Parameters
| portal_user_id required | string ^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$ |
Responses
202
OK
400
Bad Request
401
Unauthorized
404
Not Found
500
Internal Server Error
503
Service Unavailable
delete/v1/portal-users/{portal_user_id}
https://api.ntt.com/fsec-ers/v1/portal-users/{portal_user_id}
Response samples
- 202
- 400
- 401
- 404
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "portalUser": {
- "id": "12345678-1234-1234-1234-1234567890a1",
- "userId": "user02",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890b1",
- "role": "ReadOnly",
- "operationStatus": "COMPLETE",
- "operationId": "12345678-1234-1234-1234-1234567890c1",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "updatedAt": "2022-06-01T06:00:00.000Z",
- "createdAt": "2022-06-01T00:00:00.000Z"
}
}