POST api/System/ImportUserFromLDAP

Import user from LDAP Server based on user name

Request Information

URI Parameters

None.

Body Parameters

LdapImportBinder
NameDescriptionTypeAdditional information
LdapServer

LdapServer name defined in DevSuite Admin

 string

None.
Email

string

None.
LoginName

string

None.
OverrideOption

false: no Override ; true: Override

 boolean

None.
IfActive

boolean

None.
InitializedValue4LicenceType

0: floating Licence; 1: fix Licence

 integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "LdapServer": "sample string 1",
  "Email": "sample string 2",
  "LoginName": "sample string 3",
  "OverrideOption": true,
  "IfActive": true,
  "InitializedValue4LicenceType": 6
}

application/xml, text/xml

Sample: 
<LdapImportBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
  <Email>sample string 2</Email>
  <IfActive>true</IfActive>
  <InitializedValue4LicenceType>6</InitializedValue4LicenceType>
  <LdapServer>sample string 1</LdapServer>
  <LoginName>sample string 3</LoginName>
  <OverrideOption>true</OverrideOption>
</LdapImportBinder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Import user from LDAP Server based on user name

ApiReturn
NameDescriptionTypeAdditional information
Success

boolean

None.
Error

ErrorInfo

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  }
}

application/xml, text/xml

Sample: 
<ApiReturn xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</ApiReturn>