Foundry API

SearchAllUsersRequest

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetOperationUnTenanted(Generic[TResponse], IReturn[TResponse], IHasGetOptions, IGet):
    embed: Optional[str] = None
    @staticmethod
    def response_type(): return TResponse


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOperationUnTenanted(Generic[TResponse], GetOperationUnTenanted[TResponse], IHasSearchOptions):
    distinct: Optional[str] = None
    limit: Optional[int] = None
    offset: Optional[int] = None
    sort: Optional[str] = None
    filter: Optional[str] = None


TResponse = TypeVar('TResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOperationTenanted(Generic[TResponse], SearchOperationUnTenanted[TResponse], ITenantedRequest):
    organisation_id: Optional[str] = None


class AccountStatus(str, Enum):
    SHADOWED = 'Shadowed'
    REGISTERED = 'Registered'


class AccountType(str, Enum):
    PERSON = 'Person'
    MACHINE = 'Machine'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserAccountMembership(IIdentifiableResource):
    user_id: Optional[str] = None
    user_email_address: Optional[str] = None
    status: Optional[AccountStatus] = None
    type: Optional[AccountType] = None
    roles: Optional[List[str]] = None
    id: Optional[str] = None
    organisation_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UserDetails(UserAccountMembership):
    last_login_date: Optional[datetime.datetime] = None
    two_factor_enabled: Optional[bool] = None
    name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchAllUsersResponse:
    response_status: Optional[ResponseStatus] = None
    user_details: Optional[List[UserDetails]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchAllUsersRequest(SearchOperationTenanted[SearchAllUsersResponse]):
    pass

Python SearchAllUsersRequest DTOs

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"}]}