Foundry API

SearchAllUsersRequest

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

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class SearchAllUsersRequest : SearchOperationTenanted<SearchAllUsersResponse>()
{
}

open class SearchOperationTenanted<TResponse> : SearchOperationUnTenanted<TResponse>(), ITenantedRequest
{
    var organisationId:String? = null
}

open class SearchOperationUnTenanted<TResponse> : GetOperationUnTenanted<TResponse>(), IHasSearchOptions
{
    var distinct:String? = null
    var limit:Int? = null
    var offset:Int? = null
    var sort:String? = null
    var filter:String? = null
}

open class GetOperationUnTenanted<TResponse> : IHasGetOptions, IGet
{
    var embed:String? = null
}

open class SearchAllUsersResponse
{
    var responseStatus:ResponseStatus? = null
    var userDetails:ArrayList<UserDetails> = ArrayList<UserDetails>()
}

open class UserDetails : UserAccountMembership()
{
    var lastLoginDate:Date? = null
    var twoFactorEnabled:Boolean? = null
    var name:String? = null
}

open class UserAccountMembership : IIdentifiableResource
{
    var userId:String? = null
    var userEmailAddress:String? = null
    var status:AccountStatus? = null
    @SerializedName("type") var Type:AccountType? = null
    var roles:ArrayList<String> = ArrayList<String>()
    var id:String? = null
    var organisationId:String? = null
}

enum class AccountStatus
{
    Shadowed,
    Registered,
}

enum class AccountType
{
    Person,
    Machine,
}

Kotlin SearchAllUsersRequest DTOs

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: staging-api.foundrylab.com 
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
		}
	]
}