digitaluapi

<back to all web services

Register

auth

Sign Up

The following routes are available for this service:
PUT,POST/register
"use strict";
export class RegisterResponse {
    /** @param {{UserId?:string,SessionId?:string,UserName?:string,ReferrerUrl?:string,BearerToken?:string,RefreshToken?:string,RefreshTokenExpiry?:string,Roles?:string[],Permissions?:string[],RedirectUrl?:string,ResponseStatus?:ResponseStatus,Meta?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    UserId;
    /** @type {string} */
    SessionId;
    /** @type {string} */
    UserName;
    /** @type {string} */
    ReferrerUrl;
    /** @type {string} */
    BearerToken;
    /** @type {string} */
    RefreshToken;
    /** @type {?string} */
    RefreshTokenExpiry;
    /** @type {string[]} */
    Roles;
    /** @type {string[]} */
    Permissions;
    /** @type {string} */
    RedirectUrl;
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {{ [index:string]: string; }} */
    Meta;
}
export class Register {
    /** @param {{UserName?:string,FirstName?:string,LastName?:string,DisplayName?:string,Email?:string,Password?:string,ConfirmPassword?:string,AutoLogin?:boolean,ErrorView?:string,Meta?:{ [index:string]: string; }}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    UserName;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    DisplayName;
    /** @type {string} */
    Email;
    /** @type {string} */
    Password;
    /** @type {string} */
    ConfirmPassword;
    /** @type {?boolean} */
    AutoLogin;
    /** @type {string} */
    ErrorView;
    /** @type {{ [index:string]: string; }} */
    Meta;
}

JavaScript Register DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /register HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"UserName":"String","FirstName":"String","LastName":"String","DisplayName":"String","Email":"String","Password":"String","ConfirmPassword":"String","AutoLogin":false,"ErrorView":"String","Meta":{"String":"String"}}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"UserId":"String","SessionId":"String","UserName":"String","ReferrerUrl":"String","BearerToken":"String","RefreshToken":"String","RefreshTokenExpiry":"0001-01-01T00:00:00.0000000","Roles":["String"],"Permissions":["String"],"RedirectUrl":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Meta":{"String":"String"}}