Authentication Web Service

From AlfrescoWiki

Jump to: navigation, search

Back to Alfresco Content Management Web Services.

This service provides simple authentication capability.

Before access to other Web Services is allowed, a session has to be established. The authentication ticket obtained upon succesful login is placed into subsequent SOAP header calls.

Note: Investigation into WS-Security is taking place.

Contents

[edit] Data Types

[edit] AuthenticationResult

Encapsulates the result of an authentication request.

  • string ticket - a string containing the user ticket for this session
  • string username - the name of the user for whom this ticket applies

[edit] Methods

[edit] startSession

This method establishes a session with the repository and returns the user ticket. A session must be started before calls to other web services can be made.

AuthenticationResult startSession(string username, string password)

Parameters:

  • username - the user name
  • password - the password

Return:

  • the authentication results, including the allocated ticket

[edit] endSession

This method ends the current session with the repository.

authenticate.endSession(string ticket)

Parameters:

  • ticket - the ticket of the session to end.