Vpn Account - Flexible Security Service API References (1.2.1)
Download OpenAPI specification:Download
Vpn account create a remote access user only once.
Create vpn account
Create remote access vpn user and apply config
Authorizations:
Request Body schema: application/json
vpnAccount required | object (VpnAccountCreateRequest) |
Responses
202
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
503
Service Unavailable
post/v1/vpn-account
https://api.ntt.com/fsec-ers/v1/vpn-account
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "vpnAccount": {
- "userId": "user01",
- "password": "Passw0rd",
- "serviceType": "FRA",
- "fraGroupId": "12345678-1234-1234-1234-1234567890a1",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890a2"
}
}
Response samples
- 202
- 400
- 401
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "vpnAccount": {
- "userId": "user01",
- "userGroupName": "Customer_Default",
- "serviceType": "FRA",
- "fraGroupId": "12345678-1234-1234-1234-1234567890a1",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890a2",
- "operationId": "12345678-1234-1234-1234-1234567890a3",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "createdAt": "2022-06-01T00:00:00.000Z"
}
}
Create vpn account
Create remote access vpn user and apply config
Authorizations:
Request Body schema: application/json
vpnAccountBulk required | object (VpnAccountBulkCreateRequest) |
Responses
202
OK
400
Bad Request
401
Unauthorized
500
Internal Server Error
503
Service Unavailable
post/v1/vpn-account/bulk
https://api.ntt.com/fsec-ers/v1/vpn-account/bulk
Request samples
- Payload
Content type
application/json
Copy
Expand all Collapse all {- "vpnAccountBulk": {
- "serviceType": "FRA",
- "fraGroupId": "12345678-1234-1234-1234-1234567890a1",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890a2",
- "users": [
- {
- "userId": "user01",
- "password": "Passw0rd",
- "userGroupName": "usergroup01"
}, - {
- "userId": "user02",
- "password": "Passw0rd",
- "userGroupName": "usergroup02"
}
]
}
}
Response samples
- 202
- 400
- 401
- 500
- 503
Content type
application/json
Copy
Expand all Collapse all {- "vpnAccountBulk": {
- "serviceType": "FRA",
- "fraGroupId": "12345678-1234-1234-1234-1234567890a1",
- "serviceGroupId": "12345678-1234-1234-1234-1234567890a2",
- "tenantId": "1234567890abcdef1234567890abcdef",
- "operationId": "12345678-1234-1234-1234-1234567890a3",
- "createdAt": "2022-06-01T00:00:00.000Z",
- "users": [
- {
- "userId": "user01",
- "userGroupName": "usergroup01"
}, - {
- "userId": "user02",
- "userGroupName": "usergroup02"
}
]
}
}