POST api/users/disable
Request Information
URI Parameters
None.
Body Parameters
UserData| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | globally unique identifier |
None. |
|
| Username | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| DisplayName | string |
None. |
|
| string |
None. |
||
| IsSuperAdmin | boolean |
None. |
|
| Commision | decimal number |
None. |
|
| Disabled | boolean |
None. |
|
| DisabledApp | boolean |
None. |
|
| Password | string |
None. |
|
| PasswordTemporal | boolean |
None. |
|
| LastLogin | date |
None. |
|
| ExtraData | Dictionary of string [key] and PropertyData [value] |
None. |
|
| UserProfileList | Collection of UserProfileData |
None. |
|
| ModifiedOn | date |
None. |
|
| Deleted | boolean |
None. |
|
| EnabledChangePriceInSale | boolean |
None. |
|
| ChangePriceInSale | ChangePriceInSaleEnum |
None. |
Request Formats
application/json, text/json
Sample:
{
"ID": "8439f8e7-da7f-4bea-91b5-93dac93229bf",
"Username": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"DisplayName": "sample string 4",
"Email": "sample string 5",
"IsSuperAdmin": true,
"Commision": 1.0,
"Disabled": true,
"DisabledApp": true,
"Password": "sample string 6",
"PasswordTemporal": true,
"LastLogin": "2026-02-04T02:58:44.7105662+00:00",
"ExtraData": {
"sample string 1": {
"Type": 0,
"Name": "sample string 1",
"Value": "sample string 2",
"Required": true
},
"sample string 2": {
"Type": 0,
"Name": "sample string 1",
"Value": "sample string 2",
"Required": true
},
"ChangePriceInSale": {
"Type": 2,
"Name": "ChangePriceInSale",
"Value": "NO_CHANGE",
"Required": false
}
},
"UserProfileList": [
{
"AppID": "72819ff9-f08e-4eb0-887f-a5d4401221cc",
"ApplicationBranchOfficeID": 1,
"UserID": "a1259b07-60ff-4d58-9473-7ad4c779382f",
"SystemProfileID": 1,
"SystemProfileName": "sample string 1",
"ProfileCodeAsEnum": 0,
"ID": 1
},
{
"AppID": "72819ff9-f08e-4eb0-887f-a5d4401221cc",
"ApplicationBranchOfficeID": 1,
"UserID": "a1259b07-60ff-4d58-9473-7ad4c779382f",
"SystemProfileID": 1,
"SystemProfileName": "sample string 1",
"ProfileCodeAsEnum": 0,
"ID": 1
}
],
"ModifiedOn": "2026-02-04T02:58:44.7105662+00:00",
"Deleted": true,
"EnabledChangePriceInSale": true,
"ChangePriceInSale": 0
}
text/xml
Sample:
<UserData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StackBase.Common.Data">
<ChangePriceInSale>NO_CHANGE</ChangePriceInSale>
<Commision>1</Commision>
<Deleted>true</Deleted>
<Disabled>true</Disabled>
<DisabledApp>true</DisabledApp>
<DisplayName>sample string 4</DisplayName>
<Email>sample string 5</Email>
<ExtraData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringPropertyDatal3xPxu36>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>
<Name>sample string 1</Name>
<Required>true</Required>
<Type>INT</Type>
<Value>sample string 2</Value>
</d2p1:Value>
</d2p1:KeyValueOfstringPropertyDatal3xPxu36>
<d2p1:KeyValueOfstringPropertyDatal3xPxu36>
<d2p1:Key>sample string 2</d2p1:Key>
<d2p1:Value>
<Name>sample string 1</Name>
<Required>true</Required>
<Type>INT</Type>
<Value>sample string 2</Value>
</d2p1:Value>
</d2p1:KeyValueOfstringPropertyDatal3xPxu36>
<d2p1:KeyValueOfstringPropertyDatal3xPxu36>
<d2p1:Key>ChangePriceInSale</d2p1:Key>
<d2p1:Value>
<Name>ChangePriceInSale</Name>
<Required>false</Required>
<Type>STRING</Type>
<Value>NO_CHANGE</Value>
</d2p1:Value>
</d2p1:KeyValueOfstringPropertyDatal3xPxu36>
</ExtraData>
<FirstName>sample string 2</FirstName>
<ID>8439f8e7-da7f-4bea-91b5-93dac93229bf</ID>
<IsSuperAdmin>true</IsSuperAdmin>
<LastLogin>2026-02-04T02:58:44.7105662+00:00</LastLogin>
<LastName>sample string 3</LastName>
<ModifiedOn>2026-02-04T02:58:44.7105662+00:00</ModifiedOn>
<Password>sample string 6</Password>
<PasswordTemporal>true</PasswordTemporal>
<UserProfileList>
<UserProfileData>
<ID>1</ID>
<AppID>72819ff9-f08e-4eb0-887f-a5d4401221cc</AppID>
<ApplicationBranchOfficeID>1</ApplicationBranchOfficeID>
<ProfileCodeAsEnum>ALL</ProfileCodeAsEnum>
<SystemProfileID>1</SystemProfileID>
<SystemProfileName>sample string 1</SystemProfileName>
<UserID>a1259b07-60ff-4d58-9473-7ad4c779382f</UserID>
</UserProfileData>
<UserProfileData>
<ID>1</ID>
<AppID>72819ff9-f08e-4eb0-887f-a5d4401221cc</AppID>
<ApplicationBranchOfficeID>1</ApplicationBranchOfficeID>
<ProfileCodeAsEnum>ALL</ProfileCodeAsEnum>
<SystemProfileID>1</SystemProfileID>
<SystemProfileName>sample string 1</SystemProfileName>
<UserID>a1259b07-60ff-4d58-9473-7ad4c779382f</UserID>
</UserProfileData>
</UserProfileList>
<Username>sample string 1</Username>
</UserData>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
UserData| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | globally unique identifier |
None. |
|
| Username | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| DisplayName | string |
None. |
|
| string |
None. |
||
| IsSuperAdmin | boolean |
None. |
|
| Commision | decimal number |
None. |
|
| Disabled | boolean |
None. |
|
| DisabledApp | boolean |
None. |
|
| Password | string |
None. |
|
| PasswordTemporal | boolean |
None. |
|
| LastLogin | date |
None. |
|
| ExtraData | Dictionary of string [key] and PropertyData [value] |
None. |
|
| UserProfileList | Collection of UserProfileData |
None. |
|
| ModifiedOn | date |
None. |
|
| Deleted | boolean |
None. |
|
| EnabledChangePriceInSale | boolean |
None. |
|
| ChangePriceInSale | ChangePriceInSaleEnum |
None. |
Response Formats
application/json, text/json
Sample:
{
"ID": "317837fb-705f-4c95-a454-3ca02d1374bf",
"Username": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"DisplayName": "sample string 4",
"Email": "sample string 5",
"IsSuperAdmin": true,
"Commision": 1.0,
"Disabled": true,
"DisabledApp": true,
"Password": "sample string 6",
"PasswordTemporal": true,
"LastLogin": "2026-02-04T02:58:44.7105662+00:00",
"ExtraData": {
"sample string 1": {
"Type": 0,
"Name": "sample string 1",
"Value": "sample string 2",
"Required": true
},
"sample string 2": {
"Type": 0,
"Name": "sample string 1",
"Value": "sample string 2",
"Required": true
},
"ChangePriceInSale": {
"Type": 2,
"Name": "ChangePriceInSale",
"Value": "NO_CHANGE",
"Required": false
}
},
"UserProfileList": [
{
"AppID": "ac10b946-2069-4d18-9fd5-b60fcd45b2c2",
"ApplicationBranchOfficeID": 1,
"UserID": "9e029ea2-5ca7-4869-baeb-acf383a40ded",
"SystemProfileID": 1,
"SystemProfileName": "sample string 1",
"ProfileCodeAsEnum": 0,
"ID": 1
},
{
"AppID": "ac10b946-2069-4d18-9fd5-b60fcd45b2c2",
"ApplicationBranchOfficeID": 1,
"UserID": "9e029ea2-5ca7-4869-baeb-acf383a40ded",
"SystemProfileID": 1,
"SystemProfileName": "sample string 1",
"ProfileCodeAsEnum": 0,
"ID": 1
}
],
"ModifiedOn": "2026-02-04T02:58:44.7105662+00:00",
"Deleted": true,
"EnabledChangePriceInSale": true,
"ChangePriceInSale": 0
}
text/xml
Sample:
<UserData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StackBase.Common.Data">
<ChangePriceInSale>NO_CHANGE</ChangePriceInSale>
<Commision>1</Commision>
<Deleted>true</Deleted>
<Disabled>true</Disabled>
<DisabledApp>true</DisabledApp>
<DisplayName>sample string 4</DisplayName>
<Email>sample string 5</Email>
<ExtraData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringPropertyDatal3xPxu36>
<d2p1:Key>sample string 1</d2p1:Key>
<d2p1:Value>
<Name>sample string 1</Name>
<Required>true</Required>
<Type>INT</Type>
<Value>sample string 2</Value>
</d2p1:Value>
</d2p1:KeyValueOfstringPropertyDatal3xPxu36>
<d2p1:KeyValueOfstringPropertyDatal3xPxu36>
<d2p1:Key>sample string 2</d2p1:Key>
<d2p1:Value>
<Name>sample string 1</Name>
<Required>true</Required>
<Type>INT</Type>
<Value>sample string 2</Value>
</d2p1:Value>
</d2p1:KeyValueOfstringPropertyDatal3xPxu36>
<d2p1:KeyValueOfstringPropertyDatal3xPxu36>
<d2p1:Key>ChangePriceInSale</d2p1:Key>
<d2p1:Value>
<Name>ChangePriceInSale</Name>
<Required>false</Required>
<Type>STRING</Type>
<Value>NO_CHANGE</Value>
</d2p1:Value>
</d2p1:KeyValueOfstringPropertyDatal3xPxu36>
</ExtraData>
<FirstName>sample string 2</FirstName>
<ID>317837fb-705f-4c95-a454-3ca02d1374bf</ID>
<IsSuperAdmin>true</IsSuperAdmin>
<LastLogin>2026-02-04T02:58:44.7105662+00:00</LastLogin>
<LastName>sample string 3</LastName>
<ModifiedOn>2026-02-04T02:58:44.7105662+00:00</ModifiedOn>
<Password>sample string 6</Password>
<PasswordTemporal>true</PasswordTemporal>
<UserProfileList>
<UserProfileData>
<ID>1</ID>
<AppID>ac10b946-2069-4d18-9fd5-b60fcd45b2c2</AppID>
<ApplicationBranchOfficeID>1</ApplicationBranchOfficeID>
<ProfileCodeAsEnum>ALL</ProfileCodeAsEnum>
<SystemProfileID>1</SystemProfileID>
<SystemProfileName>sample string 1</SystemProfileName>
<UserID>9e029ea2-5ca7-4869-baeb-acf383a40ded</UserID>
</UserProfileData>
<UserProfileData>
<ID>1</ID>
<AppID>ac10b946-2069-4d18-9fd5-b60fcd45b2c2</AppID>
<ApplicationBranchOfficeID>1</ApplicationBranchOfficeID>
<ProfileCodeAsEnum>ALL</ProfileCodeAsEnum>
<SystemProfileID>1</SystemProfileID>
<SystemProfileName>sample string 1</SystemProfileName>
<UserID>9e029ea2-5ca7-4869-baeb-acf383a40ded</UserID>
</UserProfileData>
</UserProfileList>
<Username>sample string 1</Username>
</UserData>