PUT Application/PutSecurityGroupUsers
Request Information
URI Parameters
None.
Body Parameters
Collection of SecurityGroupUserName | 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": "1", "ID": "2b624444-85a7-4b32-b19a-0be4de9f93ed", "ContactID": "adbc319c-da5a-4844-bc62-c566f57516ca", "Name": "sample string 3", "SecurityGroupID": "65243cae-9116-417b-b002-bc13fa3357b5", "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": "2025-09-05T18:36:51.2089499+00:00", "RememberMe": true, "RefreshData": true, "PinCode": "sample string 15", "APIToken": "sample string 16", "RoleID": "0307a524-5177-4d16-a806-54b3e53d4e24", "CompanyRoleID": "35faf87a-266e-4571-aa55-ec31e5230cb2", "TokenCacheBits": "QEA=", "TokenLastWrite": "2025-09-05T18:36:51.2089499+00:00", "ExpiresIn": 1, "MonthlyHours": 1, "HasTwoFactorAuthentication": true, "IsActive": true, "DatePasswordExpires": "2025-09-05T18:36:51.2089499+00:00", "CanSignDocuments": true, "DocuSignUserID": "sample string 20", "IsVerified": true, "DateVerified": "2025-09-05T18:36:51.2089499+00:00", "Token": "sample string 22", "MobileOnlyUser": true, "RefreshTokenCache": "QEA=", "LastSyncDate": "2025-09-05T18:36:51.2089499+00:00", "IsUpgradeAvailable": true, "DateUpgraded": "2025-09-05T18:36:51.2089499+00:00", "LastSuccessfulSyncDate": "2025-09-05T18:36:51.2089499+00:00", "PreviousMobileVersion": "sample string 25", "Contact": { "$id": "2", "ID": "16062616-3497-4d3f-86a2-67748bf04797", "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": "2025-09-05T18:36:51.2089499+00:00", "GenderID": 1, "ContactStatusID": 1, "PhotoID": "98eb9156-8f25-469f-8370-5af73fda0b61", "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": "318464fa-feab-4bfe-96e2-71361563f759", "ModifiedByContactID": "1b0d98a6-d5b4-427b-a20a-883129499128", "CreatedDate": "2025-09-05T18:36:51.2089499+00:00", "ModifiedDate": "2025-09-05T18:36:51.2089499+00:00" }, "Role": { "$id": "3", "ID": "968bc068-9d60-4ee7-a695-92c7563080c3", "Name": "sample string 2", "Description": "sample string 3", "IsSystemAdministrator": true, "WorkflowID": "178aab98-7e13-48c3-a1ae-acf4a771059b", "IsGroupAdmin": true, "Workflow": { "$id": "4", "ID": "3ae28854-0a94-4fa5-b596-6d93f2b2437a", "ParentID": "f53795cf-7fa1-48f8-b450-a0a06906383c", "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": "4b73ab78-3616-419c-b046-4373973ac6a5", "Name": "sample string 2", "Description": "sample string 3", "LogVerbosityID": 4, "BlockSyncMessage": "sample string 5", "SyncPollingMin": 6, "IsBlocked": true, "IsCommercialWorkflow": true, "IsDefault": true, "PhotoID": "3ebd1548-f75a-4835-8b42-21dd52725527" } }, { "$ref": "1" } ]
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ServiceResponseName | 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.