Services and Operations > Security service > authenticateUser

authenticateUser

The authenticateUser operation allows you to verify that a given user is a valid library user. If LDAP credentials were specified, then authenticateUser also verifies those.

You use this operation to confirm that a user is registered with the library and can use library services. (If you need to establish a Web Services session, use the loginUser operation instead; see loginUser.)

By using this operation, you can validate that a user is a registered user without having to create a Web Services session.

Synopsis

Service

Security service

Namespace

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

Prerequisites

Valid clientID (see clientID)

Request

AuthenticateUserRequest

Response

AuthenticateUserResponse

Operation faults

None (see Faults)

AuthenticateUserRequest

The AuthenticateUserRequest 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.

N

AuthenticateUserResponse

The content of AuthenticateUserResponse is Boolean (see xs:boolean). The output will be true if the user is valid or false if not.

See Also

 


© 2009-2012 SirsiDynix