Assets Server REST API - login

http://yourserver.com/services/login
    ?cred=<base64 credentials>
    &username=<username>
    &password=<password>
    &clientType=api_...
    &returnProfile=true

What does it do?

Before being able to request information from Assets Server by using a GET request or make changes to the system through a POST request by using any of the REST APIs, a log in to Assets Server is required.

The REST API - login provides the process of logging users into the system. It authenticates the Web browser session and returns a CSRF token which can then be used for future POST requests.

POST requests only

This REST API only accepts POST requests, not GET requests. It returns a CSRF token that can be used for future POST requests.

For more information including examples, see Assets Server REST API - Performing a POST request with a csrf token.

Parameters

Return value

The service returns a JSON response with the following information:

Cookies

The log-in request will set a number of session cookies which all need to be passed along with any subsequent requests made to the Assets Server to handle authentication of those requests. This is both for API calls and for URLs of thumbnails, previews and originals that are made.

In Web browser environments, the Web browser will typically handle this for you.

When API calls are made from other environments such as node.js, a Java http client, .NET, or PHP, make sure to turn on cookie handling in the HTTP(s) library that you are using. In the node.js request library for example, this is handled using the cookie 'jar' options: https://github.com/request/request.

The following table shows the cookies are currently being used by the Assets Server (depending on situation).

Note: Do not rely on these explicitly, as the names of the cookies might change at any time in the future. Simply pass all cookies received during login with subsequent requests.

Examples

Successful login

The following shows the response of a successful authentication attempt.

http://demo.assets-server.com/services/login    
    ?username=guest
    &password=guest

{
  "serverVersion" : "6.1.1.622",
  "loginSuccess" : true,
  "csrfToken" : "ababababababab"
}

Login with profile

The following shows the response of a successful authentication attempt.

http://demo.assets-server.com/services/login    
    ?username=demo
    &password=demo
    &returnProfile=true

{
  "serverVersion" : "6.1.1.622",
  "userProfile" : {
    "authorities" : [ "ROLE_USER", ... ],
    "username" : "demo",
    "fullName" : "Demo User",
    "userZone" : "/Users/demouser",
    "groups" : [ "department1" ],
    "email" : "user@example.com"
  },
  "loginSuccess" : true,
  "csrfToken" : "ababababababab"
}

Login failure

The following shows the response of a failed authentication attempt.

http://demo.assets-server.com/services/login    
    ?username=guest
    &password=wrongpassword

For Assets Server 6.79 or higher:

{
      "loginSuccess" : false,
      "serverVersion" : null,			
      "loginFaultMessage" : "Invalid username or password"
    }

For Assets Server 6.78 or lower:

{
      "loginSuccess" : false,
      "serverVersion" : "6.1.1.622",			
      "loginFaultMessage" : "Invalid username or password"
    }