POST api/SysSecurity/SetupExternalLogin
Link an external login with the local security system
Request Information
URI Parameters
None.
Body Parameters
Details of the external login
LinkExternalLoginInputName | Description | Type | Additional information |
---|---|---|---|
Type |
Type of the user |
UserType |
None. |
SourceSystem |
Source system |
ExternalSources |
None. |
LoginName |
LoginName of User |
string |
Required |
Password |
Password of User |
string |
Required |
Roles |
Roles to be assigned to the User |
Collection of string |
None. |
Request Formats
application/json, text/json
Sample:
{ "Type": 0, "SourceSystem": 0, "LoginName": "sample string 1", "Password": "sample string 2", "Roles": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<LinkExternalLoginInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.Base.WebAPI.Models"> <LoginName>sample string 1</LoginName> <Password>sample string 2</Password> <Roles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </Roles> <SourceSystem>Local</SourceSystem> <Type>Other</Type> </LinkExternalLoginInput>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Success of the process
booleanResponse Formats
application/json, text/json
Sample:
true
application/xml, text/xml
Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>