Remote Console Access API reference (1.0.0)

Download OpenAPI specification:Download

This manual explains how to use the Smart Data Platform Remote Console Access API

Users

List, create, get details, update, and delete VPN users.

Show User

Shows the VPN user.

path Parameters

tenant_id required	string ID of the tenant
username required	string The username of the VPN user.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

405

Request URL or method is invalid

500

Internal Server Error

503

Service Unavailable

get/users/{username}

https://{api_endpoint}/v1.0/{tenant_id}/users/{username}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"user": 
{"name": "9d76dd01-4d8d-4c02-b0b6-279742c787ae",
"vpn_endpoints": 
[
{"endpoint": "https://rca-jp1-ecl.api.ntt.com/",
"type": "SSL-VPN"
}
]
}
}

Update User

Updates the VPN user.

path Parameters

tenant_id required	string ID of the tenant
username required	string The username of the VPN user.

Request Body schema: application/json

user

object

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Request URL or method is invalid

415

Bad Media Type

500

Internal Server Error

503

Service Unavailable

put/users/{username}

https://{api_endpoint}/v1.0/{tenant_id}/users/{username}

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"user": 
{"password": "<password>"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"user": 
{"name": "9d76dd01-4d8d-4c02-b0b6-279742c787ae",
"vpn_endpoints": 
[
{"endpoint": "https://rca-jp1-ecl.api.ntt.com/",
"type": "SSL-VPN"
}
]
}
}

Delete User

Deletes the VPN user.

path Parameters

tenant_id required	string ID of the tenant
username required	string The username of the VPN user.

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Request URL or method is invalid

500

Internal Server Error

503

Service Unavailable

delete/users/{username}

https://{api_endpoint}/v1.0/{tenant_id}/users/{username}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"badRequest": 
{"code": 400,
"message": "Request Parameter Error:\\n"
}
}

List Users

Lists VPN users. Currently, only one VPN user can be created per tenant, so the user list contains only one user.

path Parameters

tenant_id

required

string

ID of the tenant

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

Request URL or method is invalid

500

Internal Server Error

503

Service Unavailable

get/users

https://{api_endpoint}/v1.0/{tenant_id}/users

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"users": 
[
{"name": "9d76dd01-4d8d-4c02-b0b6-279742c787ae",
"vpn_endpoints": 
[
{"endpoint": "https://rca-jp1-ecl.api.ntt.com/",
"type": "SSL-VPN"
}
]
}
]
}

Create User

Creates a VPN user. Only one VPN user can be created per tenant. The username is equal to the tenant_id.

path Parameters

tenant_id

required

string

ID of the tenant

Request Body schema: application/json

user

object

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

405

Request URL or method is invalid

413

Parameter is over the maximum number

415

Bad Media Type

500

Internal Server Error

503

Service Unavailable

post/users

https://{api_endpoint}/v1.0/{tenant_id}/users

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"user": 
{"password": "<password>"
}
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"user": 
{"name": "9d76dd01-4d8d-4c02-b0b6-279742c787ae",
"password": "dummy_passw@rd",
"vpn_endpoints": 
[
{"endpoint": "https://sslvpn.example.endpoint.com/",
"type": "SSL-VPN"
}
]
}
}

Versions

Get supported API versions.

List Versions information

Lists VPN versions. Currently, the only supported version is 1.0.

Responses

200

401

Unauthorized

403

Forbidden

405

Request URL or method is invalid

500

Internal Server Error

503

Service Unavailable

get/

https://{api_endpoint}/

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"versions": 
[
{"status": "CURRENT",
"id": "v1.0",
"links": 
[
{"href": "https://rca-jp1-ecl.api.ntt.com/v1.0",
"rel": "self"
}
]
}
]
}

Show Version 1.0 information

Shows the VPN version 1.0 information.

Responses

200

401

Unauthorized

403

Forbidden

405

Request URL or method is invalid

500

Internal Server Error

503

Service Unavailable

get/v1.0

https://{api_endpoint}/v1.0

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"version": 
{"status": "CURRENT",
"id": "v1.0",
"links": 
[
{"href": "https://rca-jp1-ecl.api.ntt.com/v1.0",
"rel": "self"
}
]
}
}