PUT Application/PutSecurityGroupUser
Request Information
URI Parameters
None.
Body Parameters
SecurityGroupUser| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | globally unique identifier |
None. |
|
| ContactID | globally unique identifier |
Required |
|
| Name | string |
None. |
|
| SecurityGroupID | globally unique identifier |
Required |
|
| UserName | string |
Required |
|
| CanLogIn | boolean |
Required |
|
| Password | Collection of byte |
None. |
|
| ChangePassword | boolean |
Required |
|
| BlockSynch | boolean |
Required |
|
| Domain | string |
None. |
|
| Locked | boolean |
Required |
|
| ClearData | boolean |
Required |
|
| MobileVersion | string |
None. |
|
| DateInstalled | date |
None. |
|
| RememberMe | boolean |
Required |
|
| RefreshData | boolean |
Required |
|
| PinCode | string |
None. |
|
| APIToken | string |
None. |
|
| RoleID | globally unique identifier |
None. |
|
| CompanyRoleID | globally unique identifier |
None. |
|
| TokenCacheBits | Collection of byte |
None. |
|
| TokenLastWrite | date |
None. |
|
| ExpiresIn | integer |
None. |
|
| MonthlyHours | integer |
None. |
|
| HasTwoFactorAuthentication | boolean |
Required |
|
| IsActive | boolean |
Required |
|
| DatePasswordExpires | date |
None. |
|
| CanSignDocuments | boolean |
Required |
|
| DocuSignUserID | string |
None. |
|
| IsVerified | boolean |
Required |
|
| DateVerified | date |
None. |
|
| Token | string |
None. |
|
| MobileOnlyUser | boolean |
Required |
|
| RefreshTokenCache | Collection of byte |
None. |
|
| LastSyncDate | date |
None. |
|
| IsUpgradeAvailable | boolean |
Required |
|
| DateUpgraded | date |
None. |
|
| LastSuccessfulSyncDate | date |
None. |
|
| PreviousMobileVersion | string |
None. |
|
| Contact | Contact |
None. |
|
| Role | Role |
None. |
|
| SecurityGroup | SecurityGroup |
None. |
Request Formats
application/json, text/json
Sample:
{
"ID": "c14b2f01-d05a-4b62-b8ce-cf0cd5703beb",
"ContactID": "935eccb8-2c6b-4adb-acbc-99cda40dc2d6",
"Name": "sample string 3",
"SecurityGroupID": "323d3a1d-4b35-4bda-965b-d649d4942878",
"UserName": "sample string 5",
"CanLogIn": true,
"Password": "QEA=",
"ChangePassword": true,
"BlockSynch": true,
"Domain": "sample string 9",
"Locked": true,
"ClearData": true,
"MobileVersion": "sample string 12",
"DateInstalled": "2026-05-06T11:49:53.0716664+00:00",
"RememberMe": true,
"RefreshData": true,
"PinCode": "sample string 15",
"APIToken": "sample string 16",
"RoleID": "a42bba57-a901-49ef-a5f5-78f50fd9658e",
"CompanyRoleID": "cdeae848-3e61-4439-9082-49d7601ad477",
"TokenCacheBits": "QEA=",
"TokenLastWrite": "2026-05-06T11:49:53.0716664+00:00",
"ExpiresIn": 1,
"MonthlyHours": 1,
"HasTwoFactorAuthentication": true,
"IsActive": true,
"DatePasswordExpires": "2026-05-06T11:49:53.0716664+00:00",
"CanSignDocuments": true,
"DocuSignUserID": "sample string 20",
"IsVerified": true,
"DateVerified": "2026-05-06T11:49:53.0716664+00:00",
"Token": "sample string 22",
"MobileOnlyUser": true,
"RefreshTokenCache": "QEA=",
"LastSyncDate": "2026-05-06T11:49:53.0716664+00:00",
"IsUpgradeAvailable": true,
"DateUpgraded": "2026-05-06T11:49:53.0716664+00:00",
"LastSuccessfulSyncDate": "2026-05-06T11:49:53.0716664+00:00",
"PreviousMobileVersion": "sample string 25",
"Contact": {
"$id": "2",
"ID": "66186aff-73f5-46af-a510-98633163bcec",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Name": "sample string 4",
"CellNumber": "sample string 5",
"WorkNumber": "sample string 6",
"HomeNumber": "sample string 7",
"Email": "sample string 8",
"PhysicalAddress": "sample string 9",
"PostalAddress": "sample string 10",
"Birthday": "2026-05-06T11:49:53.0716664+00:00",
"GenderID": 1,
"ContactStatusID": 1,
"PhotoID": "d43bde26-71f8-4312-9533-a7b0727244b5",
"ExternalCode": "sample string 11",
"Latitude": 1.1,
"Longitude": 1.1,
"IDNumber": "sample string 12",
"PassportNumber": "sample string 13",
"DisplayName": "sample string 14",
"UseDisplayName": true,
"OptOutNotification": true,
"CreatedByContactID": "30078278-e234-4db7-a4e5-86e611152c9e",
"ModifiedByContactID": "388425b5-97ff-4b8f-a64e-7da6be50d3e2",
"CreatedDate": "2026-05-06T11:49:53.0716664+00:00",
"ModifiedDate": "2026-05-06T11:49:53.0716664+00:00"
},
"Role": {
"$id": "3",
"ID": "d97e02b7-46c2-4fea-956f-e952dd47f98b",
"Name": "sample string 2",
"Description": "sample string 3",
"IsSystemAdministrator": true,
"WorkflowID": "35a2165e-f13f-4444-baff-80632cd4860e",
"IsGroupAdmin": true,
"Workflow": {
"$id": "4",
"ID": "15b6120e-c179-44e2-bd1f-e1514553b379",
"ParentID": "1e976cc5-a36b-44fb-b9b1-15de99b26183",
"TypeID": 2,
"Name": "sample string 3",
"Description": "sample string 4",
"Sequence": 5,
"Active": true,
"Caption": "sample string 7",
"IconName": "sample string 8",
"IsMobile": true,
"Alias": "sample string 10",
"NotificationBadgeValueViewModel": "sample string 11",
"NotificationBadgeBackgroundColour": "sample string 12",
"NotificationBadgeTextColour": "sample string 13",
"IsPercentageNotificationBadge": true,
"IsVisible": true
}
},
"SecurityGroup": {
"$id": "5",
"ID": "5be2bd5a-8df4-48f3-9e64-d2ca1eeb864f",
"Name": "sample string 2",
"Description": "sample string 3",
"LogVerbosityID": 4,
"BlockSyncMessage": "sample string 5",
"SyncPollingMin": 6,
"IsBlocked": true,
"IsCommercialWorkflow": true,
"IsDefault": true,
"PhotoID": "50d7248a-0c83-43b6-a5d6-e597fee8f303"
}
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ServiceResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccess | boolean |
None. |
|
| ErrorMessage | string |
None. |
|
| Code | string |
None. |
|
| StackTrace | string |
None. |
|
| Response | ServiceItem |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.