Foundry API

<back to all web services

SearchAllUsersRequest

Requires Authentication
The following routes are available for this service:
GET/users/all
SearchOperationTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
OrganisationIdformstringNo
SearchOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
DistinctformstringNo
Limitformint?No
Offsetformint?No
SortformstringNo
FilterformstringNo
GetOperationUnTenanted<TResponse> Parameters:
NameParameterData TypeRequiredDescription
EmbedformstringNo
SearchAllUsersResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
UserDetailsformList<UserDetails>No
UserDetails Parameters:
NameParameterData TypeRequiredDescription
LastLoginDateformDateTime?No
TwoFactorEnabledformboolNo
NameformstringNo
UserAccountMembership Parameters:
NameParameterData TypeRequiredDescription
UserIdformstringNo
UserEmailAddressformstringNo
StatusformAccountStatusNo
TypeformAccountTypeNo
RolesformList<string>No
IdformstringNo
OrganisationIdformstringNo
AccountStatus Enum:
Shadowed
Registered
AccountType Enum:
Person
Machine
SearchAllUsersResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
UserDetailsformList<UserDetails>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /users/all HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"userDetails":[{"lastLoginDate":null,"twoFactorEnabled":false,"name":"String","userId":"String","userEmailAddress":"String","status":"Shadowed","type":"Person","roles":["String"],"id":"String","organisationId":"String"}]}