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}
import Foundation
import ServiceStack

public class PortalUser : Codable
{
    public var workspace:String
    public var objectId:String
    public var created:String
    public var lastUpdated:String
    public var activationEmailSent:String
    public var name:String
    public var email:String
    public var password:String
    public var passwordForUpdate:String
    public var phone:String
    public var teams:[String] = []
    public var tfaPreference:String
    public var uploadPermission:Bool?
    public var downloadPermission:Bool?
    public var activated:Bool
    public var enabled:Bool?
    public var locked:Bool?
    public var activationCode:String
    public var failedLoginAttempts:Int?
    public var overrideSso:Bool?

    required public init(){}
}


Swift PortalUser 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.

POST /{Workspace}/PortalUser HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
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
}