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": "9558a8a5-0b42-4c01-b4a9-923097cd2c9a",
"contactID": "e38b908c-daf2-4266-bb39-cccc00d164ca",
"name": "sample string 3",
"securityGroupID": "7099a71f-da20-4ca6-81e4-14b95b938c2a",
"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-12T22:59:32.6254123+00:00",
"rememberMe": true,
"refreshData": true,
"pinCode": "sample string 15",
"apiToken": "sample string 16",
"roleID": "50fbe73d-81ca-4f5a-8f74-6aa3d02ff750",
"companyRoleID": "b4f17118-5094-428b-88dc-27022c7fabd5",
"tokenCacheBits": "QEA=",
"tokenLastWrite": "2026-06-12T22:59:32.6254123+00:00",
"expiresIn": 1,
"monthlyHours": 1,
"hasTwoFactorAuthentication": true,
"isActive": true,
"datePasswordExpires": "2026-06-12T22:59:32.6254123+00:00",
"canSignDocuments": true,
"docuSignUserID": "sample string 20",
"isVerified": true,
"dateVerified": "2026-06-12T22:59:32.6254123+00:00",
"token": "sample string 22",
"mobileOnlyUser": true,
"refreshTokenCache": "QEA=",
"lastSyncDate": "2026-06-12T22:59:32.6254123+00:00",
"isUpgradeAvailable": true,
"dateUpgraded": "2026-06-12T22:59:32.6254123+00:00",
"lastSuccessfulSyncDate": "2026-06-12T22:59:32.6254123+00:00",
"previousMobileVersion": "sample string 25",
"entraObjectId": "sample string 26",
"contact": {
"$id": "2",
"id": "a82f7c5a-052c-4a21-a4b0-ca34e8961469",
"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-12T22:59:32.6254123+00:00",
"genderID": 1,
"contactStatusID": 1,
"photoID": "51e9129a-1837-47f6-9bca-a1dd7c8c9518",
"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": "4c24600f-cb33-4350-bd30-3a091a3786fa",
"modifiedByContactID": "13227812-792d-4e82-ba77-c12439ed7677",
"createdDate": "2026-06-12T22:59:32.6254123+00:00",
"modifiedDate": "2026-06-12T22:59:32.6254123+00:00"
},
"role": {
"$id": "3",
"id": "393dfac1-ec9a-44cc-8dbc-4529e85e84f3",
"name": "sample string 2",
"description": "sample string 3",
"isSystemAdministrator": true,
"workflowID": "0be6a910-a7d0-4864-a305-90cd5b1ab1c2",
"isGroupAdmin": true,
"workflow": {
"$id": "4",
"id": "6ef27f89-2b59-4679-ba7f-0d17f864f9f6",
"parentID": "951b375b-94f3-4399-a747-2abc63cec293",
"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": "0ccc51ad-cddd-4c1e-a5d2-c6837afabca4",
"name": "sample string 2",
"description": "sample string 3",
"logVerbosityID": 4,
"blockSyncMessage": "sample string 5",
"syncPollingMin": 6,
"isBlocked": true,
"isCommercialWorkflow": true,
"isDefault": true,
"photoID": "535c2a89-1b38-4393-87d0-4485cf1d29b1"
}
},
{
"$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.