Loading...

Staff sims_authenticate

Request Description

Checks supplied username and password pair against SIMS authentication. If the username and password matches a valid account, information including user_id, person_id, username, user_key and user_token are returned.

User Key and Token should never be displayed to the end user, nor should it be stored in plain text.


Request Information

Response Format:JSON
Requires Authentication:No
Cached:No
Cache Duration:N/A

Parameters

usernameValid SIMS username used to do the check on
passwordValid SIMS password for supplied username

Example Request

$a = $api->sendRequest(
  array( 
      'controller'    => 'Staff',  
      'action'        => 'sims_authenticate',  
      'username'      => 'USERNAME',  
      'password'      => 'PASSWORD' 
    )
  );

Example Result

Array
(
    [result] => Success
    [data] => Array
        (
            [user_id] => 123
            [person_id] => 4567
            [login_name] => TestUsername
            [USER_KEY] => 838093cda3690a107d7afe779a0592cf
            [USER_TOKEN] => 973883f942
        )

)