Services and Operations > Security service > loginUser

loginUser

The loginUser operation allows you to create a new Web Services session for a specific user restricted to their particular user privileges. When you begin a new session, the software returns a session token. A session token is required for all privileged operations. See Working with Web Services sessions for more information.

Special or reserved characters need to be URL encoded when using REST. These kind of characters are especially common in user passwords (such as in an LDAP environment). For example, if a user may use special or reserved characters in a password, such as "h%llo", you would send something like the following login request for a user named JoeB:

http://libraryapps.example.org/symws/rest/security/loginUser?clientID=
SymWSTestClient& login= JoeB&password=h%25llo

loginUser also returns a Symphony userID.

loginUser requires a login for a specific user. If the login is incorrect, loginUser will fail.

You end a session using the logoutUser operation (see logoutUser).

Synopsis

Service

Security service

Namespace

http://schemas.sirsidynix.com/symws/security

Prerequisites

Valid clientID (see Faults)

Request

LoginUserRequest

Response

LoginUserResponse

Operation faults

SecurityServiceException: Unable to log in (see also Faults)

LoginUserRequest

The LoginUserRequest has the following request parameters:

Parameter

Type

Description

Required?

login

xs:string

Specifies a user in the library system. The value of login is either the user ID (typically a barcode) or an alternate ID if the library chooses to use alternate IDs. It may also be an LDAP UID if LDAP authentication has been enabled.

Y

password

xs:string

Specifies the LDAP password if LDAP authentication has been enabled.

password values can also be the user PIN if you are not using LDAP.

N

workstationID

xs:string

Specifies the workstationID if you want workstation settings to override user settings (such as station library).

N

LoginUserResponse

The LoginUserResponse returns the following elements:

Element

Type

Occ.

Description

userID

xs:string

1

Displays a Symphony userID for a user even if the request supplied an alternate ID.

The userID element is the primary identifier for a specific user in the ILS system.

The userID is typically a barcode, but, depending on the ILS configuration, could be any string.

Values for userID are case-sensitive. However, in most configurations of the ILS server, these values are forced to uppercase.

userID is a string (see xs:string).

sessionToken

xs:string

1

Displays the Web Services session token created by the LoginUserRequest for a specific user with specific privileges and (optionally) a specific station library.

This sessionToken may be included in the message header for other privileged operations (see Privileged operations).

sessionToken is a string (see xs:string).

See Also

 


© 2009-2012 SirsiDynix