POST api/ClientAdminV01?securityToken={securityToken}
Creates user based on request passed in. Must pass security token of admin user.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| securityToken | string |
Required |
Body Parameters
ClientCreateRequestV01| Name | Description | Type | Additional information |
|---|---|---|---|
| Username | string |
None. |
|
| Password | string |
None. |
|
| string |
None. |
||
| ClientNames | Collection of string |
None. |
|
| Roles | Collection of integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"Username": "sample string 1",
"Password": "sample string 2",
"Email": "sample string 3",
"ClientNames": [
"sample string 1",
"sample string 2"
],
"Roles": [
1,
2
]
}
application/xml, text/xml
Sample:
<ClientCreateRequestV01 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VisibleSecurity.Core.Request">
<ClientNames xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ClientNames>
<Email>sample string 3</Email>
<Password>sample string 2</Password>
<Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</Roles>
<Username>sample string 1</Username>
</ClientCreateRequestV01>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Details of new user if successfully created
VscmLoginResponseV01| Name | Description | Type | Additional information |
|---|---|---|---|
| SecurityToken | string |
None. |
|
| VscmUser | VscmUserResponseV01 |
None. |
|
| IsSuccessful | boolean |
None. |
|
| Message | string |
None. |
|
| TimeInMs | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{
"SecurityToken": "sample string 1",
"VscmUser": {
"UserId": 1,
"UserName": "sample string 2",
"IsActive": true,
"IsInternalUser": true,
"IsAdminUser": true,
"StartDate": "2026-01-11T05:41:31.3690775+00:00",
"EndDate": "2026-01-11T05:41:31.3690775+00:00",
"EmailAddress": "sample string 8",
"UserFullName": "sample string 9",
"SecurityFeatures": [
"sample string 1",
"sample string 2"
],
"Clients": [
{
"ClientName": "sample string 1",
"DisplayClientName": "sample string 2",
"Active": true,
"Aliases": [
{
"ClientAliasName": "sample string 1",
"IsSuccessful": true,
"Message": "sample string 2",
"TimeInMs": 1.1
},
{
"ClientAliasName": "sample string 1",
"IsSuccessful": true,
"Message": "sample string 2",
"TimeInMs": 1.1
}
],
"IsSuccessful": true,
"Message": "sample string 4",
"TimeInMs": 1.1
},
{
"ClientName": "sample string 1",
"DisplayClientName": "sample string 2",
"Active": true,
"Aliases": [
{
"ClientAliasName": "sample string 1",
"IsSuccessful": true,
"Message": "sample string 2",
"TimeInMs": 1.1
},
{
"ClientAliasName": "sample string 1",
"IsSuccessful": true,
"Message": "sample string 2",
"TimeInMs": 1.1
}
],
"IsSuccessful": true,
"Message": "sample string 4",
"TimeInMs": 1.1
}
],
"BusinessUnits": [
"sample string 1",
"sample string 2"
]
},
"IsSuccessful": true,
"Message": "sample string 2",
"TimeInMs": 1.1
}
application/xml, text/xml
Sample:
<VscmLoginResponseV01 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VisibleSecurity.Core.Response">
<IsSuccessful>true</IsSuccessful>
<Message>sample string 2</Message>
<TimeInMs>1.1</TimeInMs>
<SecurityToken>sample string 1</SecurityToken>
<VscmUser>
<BusinessUnits xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</BusinessUnits>
<Clients>
<VscmClientResponseV01>
<IsSuccessful>true</IsSuccessful>
<Message>sample string 4</Message>
<TimeInMs>1.1</TimeInMs>
<Active>true</Active>
<Aliases>
<VscmClientAliasResponseV01>
<IsSuccessful>true</IsSuccessful>
<Message>sample string 2</Message>
<TimeInMs>1.1</TimeInMs>
<ClientAliasName>sample string 1</ClientAliasName>
</VscmClientAliasResponseV01>
<VscmClientAliasResponseV01>
<IsSuccessful>true</IsSuccessful>
<Message>sample string 2</Message>
<TimeInMs>1.1</TimeInMs>
<ClientAliasName>sample string 1</ClientAliasName>
</VscmClientAliasResponseV01>
</Aliases>
<ClientName>sample string 1</ClientName>
<DisplayClientName>sample string 2</DisplayClientName>
</VscmClientResponseV01>
<VscmClientResponseV01>
<IsSuccessful>true</IsSuccessful>
<Message>sample string 4</Message>
<TimeInMs>1.1</TimeInMs>
<Active>true</Active>
<Aliases>
<VscmClientAliasResponseV01>
<IsSuccessful>true</IsSuccessful>
<Message>sample string 2</Message>
<TimeInMs>1.1</TimeInMs>
<ClientAliasName>sample string 1</ClientAliasName>
</VscmClientAliasResponseV01>
<VscmClientAliasResponseV01>
<IsSuccessful>true</IsSuccessful>
<Message>sample string 2</Message>
<TimeInMs>1.1</TimeInMs>
<ClientAliasName>sample string 1</ClientAliasName>
</VscmClientAliasResponseV01>
</Aliases>
<ClientName>sample string 1</ClientName>
<DisplayClientName>sample string 2</DisplayClientName>
</VscmClientResponseV01>
</Clients>
<EmailAddress>sample string 8</EmailAddress>
<EndDate>2026-01-11T05:41:31.3690775+00:00</EndDate>
<IsActive>true</IsActive>
<IsAdminUser>true</IsAdminUser>
<IsInternalUser>true</IsInternalUser>
<SecurityFeatures xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>sample string 1</d3p1:string>
<d3p1:string>sample string 2</d3p1:string>
</SecurityFeatures>
<StartDate>2026-01-11T05:41:31.3690775+00:00</StartDate>
<UserFullName>sample string 9</UserFullName>
<UserId>1</UserId>
<UserName>sample string 2</UserName>
</VscmUser>
</VscmLoginResponseV01>