Login
Authenticates the user.
Resource Information
This service uses the tomcat application on port 8080 by default. To see a list of default ports click here
The context for this API is /studio, please prefix the API URLs with this context.
HTTP Verb
|
POST
|
URL
|
/api/1/services/api/1/security/login.json |
Response Formats
|
JSON |
Parameters
Name
|
Type
|
Required
|
Description
|
|---|---|---|---|
username
|
String
|
✓
|
The username
|
password
|
String
|
✓
|
The password
|
Example
Request
POST .../api/1/services/api/1/security/login.json
{
"username" : "jane.doe",
"password" : "SuperSecretPassword321#"
}
Response
Status 200 OK
{
"username": "jane.doe",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com"
}
Responses
Status
|
Location
|
Response Body
|
|---|---|---|
200
|
See example above
|
|
400
|
{ "message" : "Bad Request" } |
|
401
|
{ "message" : "Unauthorized" } |
|
500
|
{ "message" : "Internal server error.ACTUAL_EXCEPTION" } |