Sessions API
The session API is used to create sessions using defined realms, such as LDAP.
A session can be saved into a cookies file that can be re-used for subsequent requests. Sessions time out after 10 minutes of no activity, or after 8 hours.
Create a Session
The path for this request is:
/api/session?realmName=<realmName>
where the query parameter realmName takes as its value the name of a realm to authenticate against.
Input
| Parameter | Description |
|---|---|
username |
The username to use in authentication. |
password |
The password to use in authentication. |
Output
The output will include a cookie ID in the HTTP response header. This can be saved to a file and re-used with subsequent REST API requests.
Examples
|
Note
|
Use port 8765 in local development environments only. In production, use port 8764. |
Create a session against an LDAP server and store it in a file named 'cookies':
REQUEST
curl -c cookies -i -H "content-type:application/json" -X POST -d '{"username":"myUser", "password":"myPassword"}' http://localhost:8764/api/session?realmName=myLDAPRESPONSE
HTTP/1.1 201 Created
Set-Cookie: id=840a33d4-b650-49f2-87a4-85412e99b37c;HttpOnly;Path=/api
Content-Length: 0
Server: Jetty(9.1.4.v20140401)|
Note
|
In this case, we got a response because we set curl to include the HTTP in the output. Otherwise, we would not know for sure the session was created.
|
Use the cookie in another cURL request to see all collections:
curl -b cookies http://localhost:8764/api/apollo/collections