Field Squared API Services

<back to all web services

PortalUser

The following routes are available for this service:
GET/{Workspace}/CustomerPortal/User/{ObjectId}
PATCH/{Workspace}/CustomerPortal/User
GET, PUT, POST, PATCH, DELETE/{Workspace}/PortalUser
GET, DELETE/{Workspace}/PortalUser/{ObjectId}

export class PortalUser
{
    public Workspace: string;
    public ObjectId: string;
    public Created: string;
    public LastUpdated: string;
    public ActivationEmailSent: string;
    public Name: string;
    public Email: string;
    public Password: string;
    public PasswordForUpdate: string;
    public Phone: string;
    public Teams: string[];
    public TfaPreference: string;
    public UploadPermission?: boolean;
    public DownloadPermission?: boolean;
    public Activated: boolean;
    public Enabled?: boolean;
    public Locked?: boolean;
    public ActivationCode: string;
    public FailedLoginAttempts?: number;
    public OverrideSso?: boolean;

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

TypeScript PortalUser DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /{Workspace}/PortalUser HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Workspace":"String","ObjectId":"String","Created":"String","LastUpdated":"String","ActivationEmailSent":"String","Name":"String","Email":"String","Password":"String","PasswordForUpdate":"String","Phone":"String","Teams":["String"],"TfaPreference":"String","UploadPermission":false,"DownloadPermission":false,"Activated":false,"Enabled":false,"Locked":false,"ActivationCode":"String","FailedLoginAttempts":0,"OverrideSso":false}