| Required role: | Client |
| POST | /clientuserregister |
|---|
"use strict";
export class UserAuth {
/** @param {{Id?:number,UserName?:string,Email?:string,PrimaryEmail?:string,PhoneNumber?:string,FirstName?:string,LastName?:string,DisplayName?:string,Company?:string,BirthDate?:string,BirthDateRaw?:string,Address?:string,Address2?:string,City?:string,State?:string,Country?:string,Culture?:string,FullName?:string,Gender?:string,Language?:string,MailAddress?:string,Nickname?:string,PostalCode?:string,TimeZone?:string,Salt?:string,PasswordHash?:string,DigestHa1Hash?:string,Roles?:string[],Permissions?:string[],CreatedDate?:string,ModifiedDate?:string,InvalidLoginAttempts?:number,LastLoginAttempt?:string,LockedDate?:string,RecoveryToken?:string,RefId?:number,RefIdStr?:string,Meta?:{ [index:string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
UserName;
/** @type {string} */
Email;
/** @type {string} */
PrimaryEmail;
/** @type {string} */
PhoneNumber;
/** @type {string} */
FirstName;
/** @type {string} */
LastName;
/** @type {string} */
DisplayName;
/** @type {string} */
Company;
/** @type {?string} */
BirthDate;
/** @type {string} */
BirthDateRaw;
/** @type {string} */
Address;
/** @type {string} */
Address2;
/** @type {string} */
City;
/** @type {string} */
State;
/** @type {string} */
Country;
/** @type {string} */
Culture;
/** @type {string} */
FullName;
/** @type {string} */
Gender;
/** @type {string} */
Language;
/** @type {string} */
MailAddress;
/** @type {string} */
Nickname;
/** @type {string} */
PostalCode;
/** @type {string} */
TimeZone;
/** @type {string} */
Salt;
/** @type {string} */
PasswordHash;
/** @type {string} */
DigestHa1Hash;
/** @type {string[]} */
Roles;
/** @type {string[]} */
Permissions;
/** @type {string} */
CreatedDate;
/** @type {string} */
ModifiedDate;
/** @type {number} */
InvalidLoginAttempts;
/** @type {?string} */
LastLoginAttempt;
/** @type {?string} */
LockedDate;
/** @type {string} */
RecoveryToken;
/** @type {?number} */
RefId;
/** @type {string} */
RefIdStr;
/** @type {{ [index:string]: string; }} */
Meta;
}
export class ClientUserRegister {
/** @param {{EMail?:string,FirstName?:string,LastName?:string,Password?:string,ConfirmPassword?:string,Company?:string,InviteUserID?:number,Roles?:string[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
EMail;
/** @type {string} */
FirstName;
/** @type {string} */
LastName;
/** @type {string} */
Password;
/** @type {string} */
ConfirmPassword;
/** @type {string} */
Company;
/** @type {number} */
InviteUserID;
/** @type {string[]} */
Roles;
/** @type {ResponseStatus} */
ResponseStatus;
}
JavaScript ClientUserRegister DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /clientuserregister HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
EMail: String,
FirstName: String,
LastName: String,
Password: String,
ConfirmPassword: String,
Company: String,
InviteUserID: 0,
Roles:
[
String
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
UserName: String,
Email: String,
PrimaryEmail: String,
PhoneNumber: String,
FirstName: String,
LastName: String,
DisplayName: String,
Company: String,
BirthDate: 0001-01-01,
BirthDateRaw: String,
Address: String,
Address2: String,
City: String,
State: String,
Country: String,
Culture: String,
FullName: String,
Gender: String,
Language: String,
MailAddress: String,
Nickname: String,
PostalCode: String,
TimeZone: String,
Salt: String,
PasswordHash: String,
DigestHa1Hash: String,
Roles:
[
String
],
Permissions:
[
String
],
CreatedDate: 0001-01-01,
ModifiedDate: 0001-01-01,
InvalidLoginAttempts: 0,
LastLoginAttempt: 0001-01-01,
LockedDate: 0001-01-01,
RecoveryToken: String,
RefId: 0,
RefIdStr: String,
Meta:
{
String: String
}
}