IsUserValid

Description

This service determines whether a specified user is valid.

Arguments

Argument	Type	Description
auth (optional)	Auth	The Auth type supplies credentials and optionally, a host name for licensing. The userId and password can be specified with HTTP BASIC or WS-SECURITY instead.
user (optional)	UserIdentifier	The user to be checked.

Response

A boolean is returned, showing whether the user is valid (true) or not (false). The user account is checked in the context of either the calling user or the specified user. For example:

<ae:IsUserValidResponse>
   <ae:return>true</ae:return>
</ae:IsUserValidResponse>

Usage

IsUserValid will return true if the specified user was found in the database and is not deleted or disabled. Otherwise false is returned.

Faults

Invalid database pointer.
The login ID is not valid.
The user lacks sufficient permission.

XML

The following XML is a snippet of the payload this is sent with IsUserValid.

<urn:IsUserValid>
    <urn:auth>
        <urn:userId>admin</urn:userId>
        <urn:password></urn:password>
        <urn:hostname></urn:hostname>
    </urn:auth>
    <urn:user>
        <urn:displayName>carmen</urn:displayName>
        <urn:id></urn:id>
        <urn:uuid></urn:uuid>
        <urn:loginId></urn:loginId>
    </urn:user>
</urn:IsUserValid>