This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Session Authentication - WSO2 Private PaaS 4.1.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

You can getting the session ID via the REST API as shown below:


This method gets called by the client who is interested in using session mechanism to authenticate themselves in subsequent calls. This method call gets authenticated by the basic authenticator. Once the authenticated call is received, the method creates a session and returns the session ID.

Resource Path/session
Request/Response Formatapplication/json
Command format
curl -X GET -H "Content-Type: application/json" -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/session
  • By default, <USERNAME>:<PASSWORD> is admin:admin.
  • By default, <PRIVATE_PAAS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <PRIVATE_PAAS_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n

Get the session ID.

curl -X GET -H "Content-Type: application/json" -k -v -u admin:admin https://localhost:9443/api/session
Sample output
> GET /api/session HTTP/1.1
> Host: localhost:9443
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
< HTTP/1.1 200 OK
< Set-Cookie: JSESSIONID=E5Y4A8256D67F218821345EF073D4E3G; Path=/api/; Secure; HttpOnly
< Date: Mon, 19 Oct 2015 08:53:18 GMT
< WWW-Authenticate: Basic
< Content-Type: application/json
< Content-Length: 62
< Server: WSO2 Carbon Server
{"Success":{ "sessionId": "E5Y4A8256D67F218821345EF073D4E3G"}}

You will come across the following HTTP status codes while getting the session ID:

HTTP status code

200, 404, 500

See the descriptions of the HTTP status codes here.



  • No labels