GetLocalUsers

# GetLocalUsers API

Returns a list of local users in the specified domain/library. Local users are those who are direct members of the domain (as opposed to users who access the domain through a user group).

Endpoint¶

/srv.asmx/GetLocalUsers

Methods¶

GET /srv.asmx/GetLocalUsers?authenticationTicket=...&DomainName=...
POST /srv.asmx/GetLocalUsers (form data)
SOAP Action: http://tempuri.org/GetLocalUsers

Parameters¶

Parameter	Type	Required	Description
`authenticationTicket`	string	Yes	Authentication ticket obtained from `AuthenticateUser`.
`DomainName`	string	Yes	The name of the domain/library whose local users will be returned.

Response¶

Success Response¶

Returns a <users> collection with one <User> element per local user.

<response success="true" error="">
  <users>
    <User exists="true"
          UserID="123"
          FirstName="John"
          LastName="Doe"
          Email="john.doe@example.com"
          Enabled="TRUE"
          UserName="jdoe"
          Domain="Finance"
          LastLogonDate="2024-01-15"
          LastPasswordChangeDate="2024-01-01"
          AuthenticationAuthority="native"
          ReadOnlyUser="FALSE">
      <Preferences Language="English"
                   DefaultPortal=""
                   ShowArchives="FALSE"
                   ShowHiddens="FALSE"
                   NotificationType="INSTANT"
                   NotificationTypeId="1"
                   EmailType="HTML"
                   AttachDocumentToEmail="FALSE" />
    </User>
  </users>
</response>

Error Response¶

<response success="false" error="[ErrorCode] Error message" />

Required Permissions¶

Domain manager or system administrator. The calling user must be a manager of the specified domain or a system administrator.

Example¶

GET Request¶

GET /srv.asmx/GetLocalUsers
  ?authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
  &DomainName=Finance
HTTP/1.1

POST Request¶

POST /srv.asmx/GetLocalUsers HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f2504e0-4f89-11d3-9a0c-0305e82c3301
&DomainName=Finance

SOAP Request¶

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:tns="http://tempuri.org/">
  <soap:Body>
    <tns:GetLocalUsers>
      <tns:AuthenticationTicket>3f2504e0-4f89-11d3-9a0c-0305e82c3301</tns:AuthenticationTicket>
      <tns:DomainName>Finance</tns:DomainName>
    </tns:GetLocalUsers>
  </soap:Body>
</soap:Envelope>

Notes¶

Returns only direct (local) user members of the domain. Users who have access through a user group are not included.
To get all users including those with indirect membership through user groups, use GetDomainUsers.
Each <User> element includes a child <Preferences> element with notification and display settings.

GetDomainUsers - Get all users in a domain including indirect members
GetDomainMembers - Get users and user groups that are members of a domain
AddUserAsDomainMember - Add a user to a domain as a direct member
RemoveUserFromDomainMembership - Remove a user from a domain

Error Codes¶

Error	Description
`[900] Authentication failed`	Invalid or missing authentication ticket.
`[901] Session expired or Invalid ticket`	The ticket has expired or does not exist.
`[115] Domain not found`	The specified domain/library does not exist.
Access denied	The calling user is not a manager of this domain or a system administrator.
`SystemError:...`	An unexpected server-side error occurred.

For detailed documentation visit: https://support.inforouter.com/api-docs/GetLocalUsers