Foundry API

<back to all web services

SearchAllUsersRequest

export class GetOperationUnTenanted<TResponse> implements IHasGetOptions, IGet
{
    public embed?: string;

    public constructor(init?: Partial<GetOperationUnTenanted<TResponse>>) { (Object as any).assign(this, init); }
}

export class SearchOperationUnTenanted<TResponse> extends GetOperationUnTenanted<TResponse> implements IHasSearchOptions
{
    public distinct?: string;
    public limit?: number;
    public offset?: number;
    public sort?: string;
    public filter?: string;

    public constructor(init?: Partial<SearchOperationUnTenanted<TResponse>>) { super(init); (Object as any).assign(this, init); }
}

export class SearchOperationTenanted<TResponse> extends SearchOperationUnTenanted<TResponse> implements ITenantedRequest
{
    public organisationId?: string;

    public constructor(init?: Partial<SearchOperationTenanted<TResponse>>) { super(init); (Object as any).assign(this, init); }
}

export enum AccountStatus
{
    Shadowed = 'Shadowed',
    Registered = 'Registered',
}

export enum AccountType
{
    Person = 'Person',
    Machine = 'Machine',
}

export class UserAccountMembership implements IIdentifiableResource
{
    public userId?: string;
    public userEmailAddress?: string;
    public status: AccountStatus;
    public type: AccountType;
    public roles?: string[];
    public id?: string;
    public organisationId?: string;

    public constructor(init?: Partial<UserAccountMembership>) { (Object as any).assign(this, init); }
}

export class UserDetails extends UserAccountMembership
{
    public lastLoginDate?: string;
    public twoFactorEnabled: boolean;
    public name?: string;

    public constructor(init?: Partial<UserDetails>) { super(init); (Object as any).assign(this, init); }
}

export class SearchAllUsersResponse
{
    public responseStatus?: ResponseStatus;
    public userDetails?: UserDetails[];

    public constructor(init?: Partial<SearchAllUsersResponse>) { (Object as any).assign(this, init); }
}

export class SearchAllUsersRequest extends SearchOperationTenanted<SearchAllUsersResponse>
{

    public constructor(init?: Partial<SearchAllUsersRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript SearchAllUsersRequest DTOs

GET /users/all HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SearchAllUsersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.UserAccounts">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <UserDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:UserDetails>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:OrganisationId>String</d2p1:OrganisationId>
      <d2p1:Roles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Roles>
      <d2p1:Status>Shadowed</d2p1:Status>
      <d2p1:Type>Person</d2p1:Type>
      <d2p1:UserEmailAddress>String</d2p1:UserEmailAddress>
      <d2p1:UserId>String</d2p1:UserId>
      <d2p1:LastLoginDate>0001-01-01T00:00:00</d2p1:LastLoginDate>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:TwoFactorEnabled>false</d2p1:TwoFactorEnabled>
    </d2p1:UserDetails>
  </UserDetails>
</SearchAllUsersResponse>