POST api/ClientAdminV02

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Username	string	None.
Email	string	None.
ClientNames	Collection of string	None.
Roles	Collection of integer	None.
SendEmail	boolean	None.
ReturnTo	string	None.
SecurityToken	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Username": "sample string 1",
  "Email": "sample string 2",
  "ClientNames": [
    "sample string 1",
    "sample string 2"
  ],
  "Roles": [
    1,
    2
  ],
  "SendEmail": true,
  "ReturnTo": "sample string 4",
  "SecurityToken": "sample string 5"
}

application/xml, text/xml

Sample:

<ClientCreateRequestV02 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 2</Email>
  <ReturnTo>sample string 4</ReturnTo>
  <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Roles>
  <SecurityToken>sample string 5</SecurityToken>
  <SendEmail>true</SendEmail>
  <Username>sample string 1</Username>
</ClientCreateRequestV02>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VscmLoginResponseV02

Name	Type	Additional information
VscmUser	VscmUserResponseV01	None.
IsSuccessful	boolean	None.
Message	string	None.
TimeInMs	decimal number	None.

Response Formats

application/json, text/json

Sample:

{
  "VscmUser": {
    "UserId": 1,
    "UserName": "sample string 2",
    "IsActive": true,
    "IsInternalUser": true,
    "IsAdminUser": true,
    "StartDate": "2024-05-05T03:05:42.2186641+00:00",
    "EndDate": "2024-05-05T03:05:42.2186641+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 1",
  "TimeInMs": 1.1
}

application/xml, text/xml

Sample:

<VscmLoginResponseV02 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 1</Message>
  <TimeInMs>1.1</TimeInMs>
  <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>2024-05-05T03:05:42.2186641+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>2024-05-05T03:05:42.2186641+00:00</StartDate>
    <UserFullName>sample string 9</UserFullName>
    <UserId>1</UserId>
    <UserName>sample string 2</UserName>
  </VscmUser>
</VscmLoginResponseV02>