POST api/UserManagement

Request Information

URI Parameters

None.

Body Parameters

UserManagementRequest

NameDescriptionTypeAdditional Information
UserName

string

None.

Password

string

None.

Email

string

None.

FirstName

string

None.

LastName

string

None.

Phone

string

None.

PhoneExt

string

None.

DepartmentID

integer

None.

FederatedID

string

None.

IsSsoLogin

boolean

None.

SecurityQuestion

string

None.

SecurityAnswer

string

None.

Sites

Collection of string

None.

StoreGlobalAccess

boolean

None.

StoreAccessWarehouseCodes

Collection of string

None.

Authorize

boolean

None.

Permissions

Collection of string

None.

AzureB2CId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "UserName": "sample string 1",
  "Password": "sample string 2",
  "Email": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "Phone": "sample string 6",
  "PhoneExt": "sample string 7",
  "DepartmentID": 8,
  "FederatedID": "sample string 9",
  "IsSsoLogin": true,
  "SecurityQuestion": "sample string 11",
  "SecurityAnswer": "sample string 12",
  "Sites": [
    "sample string 1",
    "sample string 2"
  ],
  "StoreGlobalAccess": true,
  "StoreAccessWarehouseCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "Authorize": true,
  "Permissions": [
    "sample string 1",
    "sample string 2"
  ],
  "AzureB2CId": "sample string 15"
}

application/xml, text/xml

Sample:
<UserManagementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
  <Authorize>true</Authorize>
  <AzureB2CId>sample string 15</AzureB2CId>
  <DepartmentID>8</DepartmentID>
  <Email>sample string 3</Email>
  <FederatedID>sample string 9</FederatedID>
  <FirstName>sample string 4</FirstName>
  <IsSsoLogin>true</IsSsoLogin>
  <LastName>sample string 5</LastName>
  <Password>sample string 2</Password>
  <Permissions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Permissions>
  <Phone>sample string 6</Phone>
  <PhoneExt>sample string 7</PhoneExt>
  <SecurityAnswer>sample string 12</SecurityAnswer>
  <SecurityQuestion>sample string 11</SecurityQuestion>
  <Sites xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Sites>
  <StoreAccessWarehouseCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </StoreAccessWarehouseCodes>
  <StoreGlobalAccess>true</StoreGlobalAccess>
  <UserName>sample string 1</UserName>
</UserManagementRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

UserManagementResponse

NameDescriptionTypeAdditional Information
ResponseCode

APIResponseCodes

None.

Message

string

None.

CorrelationId

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ResponseCode": 0,
  "Message": "sample string 1",
  "CorrelationId": "sample string 2"
}

application/xml, text/xml

Sample:
<UserManagementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models">
  <CorrelationId xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">sample string 2</CorrelationId>
  <Message xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">sample string 1</Message>
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API">Success</ResponseCode>
</UserManagementResponse>