Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/ExecuteUsersQuery

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/ExecuteUsersQuery

 

Searches for users in Thereforeâ„¢ and/or the Active Directory.

 

 

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/ExecuteUsersQuery

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ DomainNames

 

nillable


≡ DomainName

xs:string

list nillable


â–  Flags

 

mandatory

restriction enum (xs:string)

- FindUsersInActiveDirectory (1)

- FindUsersInTherefore (4)

- FindAllUsers (5)

- FindUsersNotInTherefore (32)

- FindGroupsInActiveDirectory (64)

- FindGroupsInTherefore (256)

- FindAllGroups (320)

- FindAllUsersAndGroups (325)

- FindGroupsNotInTherefore (1024)

- FindSMTPUsersOnly (4096)

Sets filter determining which users and/or groups are returned.

â–¡ Query

xs:string

nillable

Sets user query string specifying conditions for the desired user's name or email address.

 

 

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/ExecuteUsersQueryResponse

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ Users

 

nillable

Gets the list containing all users matching the search criteria.

≡ WSUser

 

list nillable


â–¡ Description

xs:string

nillable

Gets or sets the description of the user or user group.

â–¡ DisplayName

xs:string

nillable

Gets or sets the display name of the user or user group.

â–¡ DomainName

xs:string

nillable

Gets or sets the domain name of the user or user group.

â–¡ InFolder

xs:string

nillable

Gets or sets the name of the folder the user or user group belongs to.

â–¡ SMTP

xs:string

nillable

Gets or sets the SMTP email address of the user or user group.

â–¡ UserId

xs:int

nillable

Gets or sets the ID of a Thereforeâ„¢ user. Only Thereforeâ„¢ users have a unique user ID assigned. For all other users the default value 0 will be returned.

â–¡ UserName

xs:string

nillable

Gets or sets the user name of the user or user group.

â–¡ UserType

 

nillable

restriction enum (xs:string)

- SingleUser (1)

- UserGroup (2)

- SystemUser (3)

Gets or sets the type of the user or user group.

â–  Disabled

xs:boolean

 

Gets or sets whether the user is disabled or not.

â–¡ GUID

xs:string

nillable

Gets or sets the GUID of the user.

â–  OneTimePwd

xs:boolean

 

Gets or sets whether the user has to change his password on his next log in or not.

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2023 Therefore Corporation, all rights reserved.