- 3 minutes to read
- Print
- DarkLight
- PDF
POST | Create an authenticated URL for a web proxy session
- 3 minutes to read
- Print
- DarkLight
- PDF
Create an authenticated URL to initiate a web proxy session in PAM Core.
Requirements
- Authorization with access and read and write permission to Web Proxy Session granted by the administrator in A2A.
Access the document on How to create an authorization for an application for more information. - Credential created in PAM Core.
Access the document POST | Create credential for more information.
Request
POST
api/pam/remote/session
Request parameters
Send the parameters below in the request body.
user
- string - required - Username used to authenticate.Note: must be a senhasegura registered user.
credential
- string - required - Username of the credenial used in this web proxy session.device
- string - required - Hostname or IP address of the target device .protocol
- string - required - Network protocol (SSH, RDP, HTTPS, among others.).remotedevice
- string - Device ID, IP address or hostname for the web proxy session.remoteAddr
- string - IP address of the user.port
- int - Port used during the session.remoteapp
- int - RemoteApp ID.screensize
- string - Screen resolution.Example: 1900x1200
Example request
POST
{{url}}/api/pam/remote/session
{
"user": "dleite",
"credential":"usrsudonopass",
"device": "45.163.147.135",
"protocol": "ssh"
}
Response
{
"code": 200,
"response": {
"status": 200,
"message": "Session created successfully",
"error": false,
"error_code": 0,
"detail": "",
"Message": "Session created successfully",
"erro": false,
"cod_erro": 0
},
"tenant": "senhasegura",
"session": {
"session_url": "https://10.66.33.120/modulos/auth?_sr=cmJzOi8vTmJQOG1GckRWeHFFY1FkNi8wRUF5bHoweWw3cUdyUk5JbE1oaXZ3TytLak5sUGsydUZ2YnRQaUdhU3YwaUl0TVRILzZHWWtPWjdZdXNKeE01NHFsaVlFdkRqMGZtOG5vbXNDc0d5bUNDdUt2YWFSclJjTG1scUIxSnBUTXdq",
"token": "6a3afbb1************b32262"
}
}
Response body fields
session
- object - Data of the created session.session_url
- string - URL to initiate the authenticated web proxy session.token
- string - Authentication token associated with the web proxy session.The token
value is sensitive and must remain confidential.
Errors
400 - Bad Request
Message: "Username not specified"
Possible cause: the required parameter username
of the session wasn't informed.
username
parameter and resend the request.Message: "Credential not specified"
Possible cause: the required parameter credential
for session authentication wasn't informed.
credential
parameter and resend the request.Message: "Credential device not specified"
Possible cause: the required parameter device
of the session wasn't informed.
device
parameter and resend the request.Message: "Invalid protocol"
Possible cause: the required parameter protocol
of the session wasn't informed.
protocol
e envie404 - Not Found
Message: "Resource sub not found"
Possible cause: the URL or the requested resource isn’t correct.
Solution: check the URL and make sure the parameter is correct.
500 - Internal Server Error
Message: "Unexpected error."
Possible cause: the error is in the senhasegura server.
Solution: contact the support team for more information.
Message: "You are not authorized to access this resource."
Possible cause: you don’t have the authorization to access this resource.
Solution: ask the administrator to check your permission to access the Web Proxy Session resources in A2A.
Client authentication failed
Message: "Client authentication failed."
Possible cause: failure in your application authentication with the senhasegura server.
Solution: check the authentication parameters such as Access Token URL
, Client ID
e Client secret
and request a new access token.
Invalid signature
Message: "Invalid signature"
Possible cause: failure in recognizing the URL of the client application.
Solution: check the URL of the client application and resent the request.
No route matched with those values
Message: "No route matched with those values."
Possible cause: the authorization header is missing in the API request.
Solution: request a new access token.
Request timed out
Message: "Request timed out."
Possible cause: the request time has expired.
Solution: check the connectivity between the source of the request and the senhasegura server.