Login
Summary
The Login API is used to create or destroy API Manager HTTP sessions
Description
With the Login API, web applications can login to and logout from the API Manager
Resources
| Resource | Since Version | Description |
|---|---|---|
| DELETE /api/portal/v1.3/login | Logout from API Manager | |
| POST /api/portal/v1.3/login | Login to API Manager |
DELETE /api/portal/v1.3/login
Summary
Logout from API Manager
Description
Destroys the caller session with the API Manager.
Parameters
none
Status Codes
| HTTP Status Code | Reason |
|---|---|
| 204 | No Content |
POST /api/portal/v1.3/login
Summary
Login to API Manager
Description
Logs a user, identified by username and password, into the API Manager by creating unique a session cookie. The success parameter defaults to a named URL identified by "/home" and will return a redirect to the portal after login. The failure parameter is optional. If failure is not specified, and the login attempt fails, this method returns a JSON error response. If failure is specified, and the login attempt fails, then this method will redirect to a named URL, identified by "/login-failed".
Parameters
| Parameter | Description | Data Type | Location | Required | Multiple |
|---|---|---|---|---|---|
username |
The login name of the authenticating user | String | form | Required | |
password |
The password of the authenticating user | String | form | Required | |
success |
The redirect success location (defaults to: /home) | String | form | ||
failure |
Optional redirect failure location (e.g. /login-failed | String | form |
Status Codes
| HTTP Status Code | Reason |
|---|---|
| 303 | Login successful. Redirects to home page |
| 401 | The caller cannot be authenticated |
| 403 | The caller is not allowed to access this resource |
| 500 | Internal Server Error |