Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

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

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

 

Get list of users from given group.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ GroupId

xs:int

nillable

Sets group id. Set one of the following: GroupId or (GroupName and DomainName). If the GroupId is set the GroupName and the DomainName parameters are ignored.

â–¡ GroupName

xs:string

nillable

Sets exact name of the group. Set one of the following: (GroupName and DomainName) or GroupId.

â–¡ DomainName

xs:string

nillable

Sets domain name. Set one of the following: (DomainName and GroupName) or GroupId. To get users from a Therefore group set DomainName to ''.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ Users

 

nillable

Gets the list containing all users found within given group.

≡ 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.

 

 

© 2024 Therefore Corporation, all rights reserved.