Foundry API

SearchAllUsersRequest

The following routes are available for this service:
GET	/users/all

**SearchOperationTenanted<TResponse>** Parameters:
Name	Parameter	Data Type	Required	Description
OrganisationId	form	string	No

**SearchOperationUnTenanted<TResponse>** Parameters:
Name	Parameter	Data Type	Required
Distinct	form	string	No
Limit	form	int?	No
Offset	form	int?	No
Sort	form	string	No
Filter	form	string	No

**GetOperationUnTenanted<TResponse>** Parameters:
Name	Parameter	Data Type	Required	Description
Embed	form	string	No

**SearchAllUsersResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
UserDetails	form	List<UserDetails>	No

**UserDetails** Parameters:
Name	Parameter	Data Type	Required
LastLoginDate	form	DateTime?	No
TwoFactorEnabled	form	bool	No
Name	form	string	No

**UserAccountMembership** Parameters:
Name	Parameter	Data Type	Required
UserId	form	string	No
UserEmailAddress	form	string	No
Status	form	AccountStatus	No
Type	form	AccountType	No
Roles	form	List<string>	No
Id	form	string	No
OrganisationId	form	string	No

**AccountStatus** Enum:
Shadowed
Registered

**AccountType** Enum:
Person
Machine

**SearchAllUsersResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
UserDetails	form	List<UserDetails>	No

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

HTTP + JSV

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/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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: ,
			twoFactorEnabled: False,
			name: String,
			userId: String,
			userEmailAddress: String,
			status: Shadowed,
			type: Person,
			roles: 
			[
				String
			],
			id: String,
			organisationId: String
		}
	]
}