This endpoint returns a list of validated user of the tenant.  The returned list will be determined by the permissions/access of the API client.


GET    /api/admin/tenant/list/get/uservalidatedinfo/{tenantid}



Request


Url Params

tennatId
int
the id of the tenant


Authorization

The following authorization header is required.  The authorisation header should be set to a 'Bearer Token' type


Token
see How to get a bearer token


Query Params

The end point supports oData filtering.  You are able to filter the results of the request by passing in the following query parameter in the request.  


$filter
any valid oData filter e.g. top.  This query param is optional

this example returns only tenants whose name contains 'beta'


Response

The response will return an array of 0 to n JSON objects.  Each JSON object in the array contains the following properties:


userAccountIdintthe user account Id of the user
torusAccountIdstring[internal reference] the torus account Id of the user
emailAddressstringthe email address of the user
lineManagerNamestringthe display name of the line manager
tenantIdint[not in use] the id of the tenant
idint[internal] employee Id of the user
displayNamestring the display name of user
isLoginAllowedboolindicates login allowed for user if set to true
isAccountClosedbool
indicates account closed for user if set to true 
isLockedOutboolindicates account locked for user if set to true
linkAddressboolthe URL of the user on the administration system
extraRegisttationDetailsCompleteboolindicates if the user has completed extra registration.  Only valid if the tenant has extra registration enabled
extraRegisttationDetailsCompleteDate
datedate of extra registration  if the user has completed extra registration.  Only valid if the tenant has extra registration enabled
torusNonValidatedboolis user validated
ouOfOfficeboolindicates if the user account has been set to 'Out Of Office'


Permissions

The API Client requires at least readonly permissions to Tenants to successfully retrieve results (See Admin User Roles for more details).  Only tenants that the API client has access to will be returned.


Examples


C# Example


var client = new HttpClient(); 
var request = new HttpRequestMessage(HttpMethod.Get, "https://{platform API url}/api/admin/tenant/list/get/uservalidatedinfo/{tenantId}?$filter=$top=1");
request.Headers.Add("Authorization", "Bearer {access token}");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());


cURL Example


curl --location 'https://{platform API url}/api/admin/tenant/list/get/uservlidatedinfo/{tenantId}?%24top=1' \ --header 'Authorization: Bearer {access token}'