GetUsers

Description

This services returns identification information about a user and the user's preferences.

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.
getCurrentUser boolean Specify true to return user info for the user specified in the auth argument of the GetUsers call. Specify false to use the other arguments to return users instead. Default value is false.
searchByName string Used to specify the name of the user as a search parameter.
user UserIdentifier Used to return a specific user or list of users. Specify multiple UserIdentifiers to return multiple users.
options UserResponseOptions Specifies whether the service should continue if an error is encountered or stop. Also enables you to limit the data that is returned in the response.

Response

UserHolder is returned. The UserHolder response contains one or more UserIdentifiers and additional information from the users preferences. For more specific information, see UserHolder.

Usage

The GetUsers call is useful when you need data about a user account. The GetUsers call retrieves data for a user account as it exists in the TS_USERS table of the database. To retrieve privileges for a given user account, use the admin Web service call GetUserPrivileges. To determine if a specific user has a given privilege, use the admin Web service call HasUserPrivilege.

Use the following arguments to determine which users are returned in the response:

Use the following elements in the options parameter to control how this call is processed and what data is returned:

For more information on the options elements, see UserResponseOptions.

Faults

XML

The following XML is a snippet of the payload this is sent with GetUsers. In this example, searchByName is used to find all users with the string Joe in the user login ID.

<urn:GetUsers>
   <urn:auth>
      <urn:userId>Admin</urn:userId>
      <urn:password></urn:password>
      <urn:hostname></urn:hostname>
      <urn:loginAsUserId></urn:loginAsUserId>
   </urn:auth>
   <urn:getCurrentUser></urn:getCurrentUser>
   <urn:searchByName>Joe</urn:searchByName>
   <urn:user>
      <urn:displayName></urn:displayName>
      <urn:id></urn:id>
      <urn:uuid></urn:uuid>
      <urn:loginId></urn:loginId>
   </urn:user>
</urn:GetUsers>

In this example, getCurrentUser is empty (or false), searchByName is left empty, and no user is provided in the user argument. This call returns all the users in the system.

<urn:GetUsers>
   <urn:auth>
      <urn:userId>Admin</urn:userId>
      <urn:password></urn:password>
      <urn:hostname></urn:hostname>
      <urn:loginAsUserId></urn:loginAsUserId>
   </urn:auth>
   <urn:getCurrentUser></urn:getCurrentUser>
   <urn:searchByName></urn:searchByName>
   <urn:user>
      <urn:displayName></urn:displayName>
      <urn:id></urn:id>
      <urn:uuid></urn:uuid>
      <urn:loginId></urn:loginId>
   </urn:user>
</urn:GetUsers>