POST api/SysSecurity/RegisterExternalUser

Register an external user to the security model (User profile resides in a different system while the login/security is local)

Request Information

URI Parameters

None.

Body Parameters

Input for registering an external user

ExternalUserRegistrationInput
NameDescriptionTypeAdditional information
SourceSystem

Source system

 ExternalSources

None.
FirstName

First Name of the User (Optional if [ReferenceId] is available)

 string

Max length: 50
LastName

Last Name of the User (Optional if [ReferenceId] is available)

 string

Max length: 50
ReferenceCode

Reference code of the User (Optional if [ReferenceId] is available)

 string

Max length: 50
DOB

DOB of the user (Optional if [ReferenceId] is available)

 date

None.
ReferenceId

Reference Id of the external profile reference

 string

Max length: 50
Type

Type of the user

 UserType

None.
LoginName

LoginName of User

 string

Required

Max length: 120
Password

Password of User

 string

Required

Max length: 30

Min length: 6
Email

Email of User

 string

Required

Max length: 120
Roles

Roles to be assigned to the User

 Collection of string

None.
SecurityAnswers

List of security question answers

 Collection of SecurityDataInput

None.

Request Formats

application/json, text/json

Sample: 
{
  "SourceSystem": 0,
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "ReferenceCode": "sample string 3",
  "DOB": "2024-04-20T01:59:56.3348348-07:00",
  "ReferenceId": "sample string 4",
  "Type": 0,
  "LoginName": "sample string 5",
  "Password": "sample string 6",
  "Email": "sample string 7",
  "Roles": [
    "sample string 1",
    "sample string 2"
  ],
  "SecurityAnswers": [
    {
      "QuestionID": 1,
      "Answer": "sample string 2"
    },
    {
      "QuestionID": 1,
      "Answer": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample: 
<ExternalUserRegistrationInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GBG.Base.WebAPI.Models">
  <Email>sample string 7</Email>
  <LoginName>sample string 5</LoginName>
  <Password>sample string 6</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>
  <SecurityAnswers>
    <SecurityDataInput>
      <Answer>sample string 2</Answer>
      <QuestionID>1</QuestionID>
    </SecurityDataInput>
    <SecurityDataInput>
      <Answer>sample string 2</Answer>
      <QuestionID>1</QuestionID>
    </SecurityDataInput>
  </SecurityAnswers>
  <Type>Other</Type>
  <DOB>2024-04-20T01:59:56.3348348-07:00</DOB>
  <FirstName>sample string 1</FirstName>
  <LastName>sample string 2</LastName>
  <ReferenceCode>sample string 3</ReferenceCode>
  <ReferenceId>sample string 4</ReferenceId>
  <SourceSystem>Local</SourceSystem>
</ExternalUserRegistrationInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Success of the registration process

boolean

Response Formats

application/json, text/json

Sample: 
true

application/xml, text/xml

Sample: 
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>