Sun Java System Calendar Server 6 2005Q4 Developer's Guide

Command: login

Purpose

Authenticate a specific user.

Parameters

Table 7–26 login Parameters

Parameter  

Type  

Purpose  

Required  

Default  

applyauthfilter

integer 

1 = Use the authfilter for login.


Note –

Communications Express requires this to be turned off (0).


No 

1

fmt-out

string 

The format for the returned data. 

Two format types: 

text/calendar

text/xml

text/calendar

lang

enum 

The user’s preferred language. 

NULL

password

string 

The user’s password. 

N/A 

proxyauth

string 

Used by calendar administrators to perform proxy authorization. 

N/A 

user

string 

The user’s name. 

NULL

Description

This command logs a specific user into Calendar Server, authenticating the user to the server with a user name and password convention.

The user name is a plain text string that uniquely identifies the user to the server. This user name could, for example, be the same as a user's email address. The password is also plain text.

Authentication

Do internal authentication using either the default LDAP authentication, or your own CSAPI plug-in to link to an existing user authentication method. For more information on CSAPI authentication, see API: csIAccessControl. For more information on the Proxy Authentication SDK, see Chapter 3, Proxy Authentication SDK Overview.

If the user fails to authenticate correctly, the login window reappears with an error noting a failure to log in.

Example

For example, the following URL attempts to login user jdoe:

http://calendarserver/login.wcap
                     ?user=jdoe&password=mypword

Returns

The login command returns the information shown in this example:

HTTP/1.0 302 OK
 Date: Tue, 11 May 2002 22:38:33 GMT
 Pragma: no-cache
 Expires: 0
 Cache-Control: no-cache
 Content-Length: 0
 Last-modified: Tue, 11 May 2002 22:38:33 GMT
 Location:
http://calendarserver/en/main.html?id=er6en05tv6n3bv9
       &lang=en &host=http://calendarserver/