PUT Application/PutSecurityGroupUsers
Request Information
URI Parameters
None.
Body Parameters
Collection of 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. |
|
| EntraObjectId | string |
None. |
|
| Contact | Contact |
None. |
|
| Role | Role |
None. |
|
| SecurityGroup | SecurityGroup |
None. |
Request Formats
application/json, text/json
Sample:
[
{
"$id": "1",
"id": "fabdbb0f-ed0c-4c10-8c9a-070d986095cf",
"contactID": "3a6170b2-924d-495b-8996-56bd69e4a12f",
"name": "sample string 3",
"securityGroupID": "b0ded00d-db6f-42a9-b710-7be03bb928b0",
"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-06-20T19:03:25.6239019+00:00",
"rememberMe": true,
"refreshData": true,
"pinCode": "sample string 15",
"apiToken": "sample string 16",
"roleID": "ae5a677f-7ef6-4204-bfb7-eafff57cfd0a",
"companyRoleID": "8f7af41f-5851-4b74-98eb-5b65b0065dfe",
"tokenCacheBits": "QEA=",
"tokenLastWrite": "2026-06-20T19:03:25.6239019+00:00",
"expiresIn": 1,
"monthlyHours": 1,
"hasTwoFactorAuthentication": true,
"isActive": true,
"datePasswordExpires": "2026-06-20T19:03:25.6239019+00:00",
"canSignDocuments": true,
"docuSignUserID": "sample string 20",
"isVerified": true,
"dateVerified": "2026-06-20T19:03:25.6239019+00:00",
"token": "sample string 22",
"mobileOnlyUser": true,
"refreshTokenCache": "QEA=",
"lastSyncDate": "2026-06-20T19:03:25.6239019+00:00",
"isUpgradeAvailable": true,
"dateUpgraded": "2026-06-20T19:03:25.6239019+00:00",
"lastSuccessfulSyncDate": "2026-06-20T19:03:25.6239019+00:00",
"previousMobileVersion": "sample string 25",
"entraObjectId": "sample string 26",
"contact": {
"$id": "2",
"id": "2b440139-39bf-4f1a-ac0f-101950b9e624",
"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-06-20T19:03:25.6239019+00:00",
"genderID": 1,
"contactStatusID": 1,
"photoID": "5560b5a4-7ee8-4c16-ba27-778af2bdbe1e",
"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": "3e8dd6eb-1683-4a90-bba9-e396bad668bf",
"modifiedByContactID": "a454631e-9fb0-43c9-b485-318472af020f",
"createdDate": "2026-06-20T19:03:25.6239019+00:00",
"modifiedDate": "2026-06-20T19:03:25.6239019+00:00"
},
"role": {
"$id": "3",
"id": "3994a062-e6be-4c86-99c2-5e2985a479f7",
"name": "sample string 2",
"description": "sample string 3",
"isSystemAdministrator": true,
"workflowID": "b3728923-170c-4898-b645-b91b8d079884",
"isGroupAdmin": true,
"workflow": {
"$id": "4",
"id": "71966606-0fc5-4b07-a786-b6180497b9b4",
"parentID": "93830928-6afb-4039-a113-d2196a9f6f3d",
"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": "2d93e172-ac7b-4d62-b755-1da4257478bb",
"name": "sample string 2",
"description": "sample string 3",
"logVerbosityID": 4,
"blockSyncMessage": "sample string 5",
"syncPollingMin": 6,
"isBlocked": true,
"isCommercialWorkflow": true,
"isDefault": true,
"photoID": "0a70e829-2d09-4dd6-9088-b8f5bf18e3a7"
}
},
{
"$ref": "1"
}
]
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. |
|
| Response | ServiceItem |
None. |
|
| LatestDataTimestampUtc | date |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.