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
Show User
Show VPN user.
path Parameters
| tenant_id required | string ID of the tenant |
| username required | string The username of VPN user. |
Responses
OK
Unauthorized
Forbidden
Not Found
request URL or method is invalid
Internal Server Error
Service Unavailable
Response samples
- 200
- 401
- 403
- 404
- 405
- 500
- 503
{- "user": {
- "name": "9d76dd01-4d8d-4c02-b0b6-279742c787ae",
}
}Update User
Update VPN user.
path Parameters
| tenant_id required | string ID of the tenant |
| username required | string The username of VPN user. |
Request Body schema: application/json
| user | object |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
request URL or method is invalid
Bad Media Type
Internal Server Error
Service Unavailable
Request samples
- Payload
{- "user": {
- "password": "<password>"
}
}Response samples
- 200
- 400
- 401
- 403
- 404
- 405
- 415
- 500
- 503
{- "user": {
- "name": "9d76dd01-4d8d-4c02-b0b6-279742c787ae",
}
}Delete User
Delete VPN user.
path Parameters
| tenant_id required | string ID of the tenant |
| username required | string The username of VPN user. |
Responses
OK
Bad Request
Unauthorized
Forbidden
Not Found
request URL or method is invalid
Internal Server Error
Service Unavailable
Response samples
- 400
- 401
- 403
- 404
- 405
- 500
- 503
{- "badRequest": {
- "code": 400,
- "message": "Request Parameter Error:\\n"
}
}List Users
List VPN user. Now, VPN user can create per one tenant, so user list hash only one user.
path Parameters
| tenant_id required | string ID of the tenant |
Responses
OK
Bad Request
Unauthorized
Forbidden
request URL or method is invalid
Internal Server Error
Service Unavailable
Response samples
- 200
- 400
- 401
- 403
- 405
- 500
- 503
{- "users": [
- {
- "name": "9d76dd01-4d8d-4c02-b0b6-279742c787ae",
}
]
}Create User
Create VPN user. One VPN user can create per one tenant. And username equal to tenant_id.
path Parameters
| tenant_id required | string ID of the tenant |
Request Body schema: application/json
| user | object |
Responses
OK
Bad Request
Unauthorized
Forbidden
request URL or method is invalid
parameter is over the maximum number
Bad Media Type
Internal Server Error
Service Unavailable
Request samples
- Payload
{- "user": {
- "password": "<password>"
}
}Response samples
- 200
- 400
- 401
- 403
- 405
- 413
- 415
- 500
- 503
{- "user": {
- "name": "9d76dd01-4d8d-4c02-b0b6-279742c787ae",
- "password": "dummy_passw@rd",
}
}List Versions information
List VPN versions. Now, supported version is only 1.0.
Responses
OK
Unauthorized
Forbidden
request URL or method is invalid
Internal Server Error
Service Unavailable
Response samples
- 200
- 401
- 403
- 405
- 500
- 503
{- "versions": [
- {
- "status": "CURRENT",
- "id": "v1.0",
}
]
}Show Version 1.0 information
Show VPN version.
Responses
OK
Unauthorized
Forbidden
request URL or method is invalid
Internal Server Error
Service Unavailable
Response samples
- 200
- 401
- 403
- 405
- 500
- 503
{- "version": {
- "status": "CURRENT",
- "id": "v1.0",
}
}