| GET | /{Workspace}/CustomerPortal/User/{ObjectId} | ||
|---|---|---|---|
| PATCH | /{Workspace}/CustomerPortal/User | ||
| GET, PUT, POST, PATCH, DELETE | /{Workspace}/PortalUser | ||
| GET, DELETE | /{Workspace}/PortalUser/{ObjectId} |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Workspace | path | string | No | |
| ObjectId | path | string | No | |
| Created | body | string | No | |
| LastUpdated | body | string | No | |
| ActivationEmailSent | body | string | No | |
| Name | body | string | No | |
| body | string | No | ||
| Password | body | string | No | |
| PasswordForUpdate | body | string | No | |
| Phone | body | string | No | |
| Teams | body | List<string> | No | |
| TfaPreference | body | string | No | |
| UploadPermission | body | bool? | No | |
| DownloadPermission | body | bool? | No | |
| Activated | body | bool | No | |
| Enabled | body | bool? | No | |
| Locked | body | bool? | No | |
| ActivationCode | body | string | No | |
| FailedLoginAttempts | body | int? | No | |
| OverrideSso | body | bool? | No |
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
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}