| GET | /{Workspace}/CustomerPortal/User/{ObjectId} | ||
|---|---|---|---|
| PATCH | /{Workspace}/CustomerPortal/User | ||
| GET, PUT, POST, PATCH, DELETE | /{Workspace}/PortalUser | ||
| GET, DELETE | /{Workspace}/PortalUser/{ObjectId} |
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
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PortalUser:
workspace: Optional[str] = None
object_id: Optional[str] = None
created: Optional[str] = None
last_updated: Optional[str] = None
activation_email_sent: Optional[str] = None
name: Optional[str] = None
email: Optional[str] = None
password: Optional[str] = None
password_for_update: Optional[str] = None
phone: Optional[str] = None
teams: Optional[List[str]] = None
tfa_preference: Optional[str] = None
upload_permission: Optional[bool] = None
download_permission: Optional[bool] = None
activated: bool = False
enabled: Optional[bool] = None
locked: Optional[bool] = None
activation_code: Optional[str] = None
failed_login_attempts: Optional[int] = None
override_sso: Optional[bool] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}