| 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); }
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<PortalUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.CustomerPortal">
<Activated>false</Activated>
<ActivationCode>String</ActivationCode>
<ActivationEmailSent>String</ActivationEmailSent>
<Created>String</Created>
<DownloadPermission>false</DownloadPermission>
<Email>String</Email>
<Enabled>false</Enabled>
<FailedLoginAttempts>0</FailedLoginAttempts>
<LastUpdated>String</LastUpdated>
<Locked>false</Locked>
<Name>String</Name>
<ObjectId>String</ObjectId>
<OverrideSso>false</OverrideSso>
<Password>String</Password>
<PasswordForUpdate>String</PasswordForUpdate>
<Phone>String</Phone>
<Teams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Teams>
<TfaPreference>String</TfaPreference>
<UploadPermission>false</UploadPermission>
<Workspace>String</Workspace>
</PortalUser>