FrameAppWS

<back to all web services

CustomUserSession

Requires Authentication
"use strict";
export class AuthUserSession {
    /** @param {{ReferrerUrl?:string,Id?:string,UserAuthId?:string,UserAuthName?:string,UserName?:string,TwitterUserId?:string,TwitterScreenName?:string,FacebookUserId?:string,FacebookUserName?:string,FirstName?:string,LastName?:string,DisplayName?:string,Company?:string,Email?:string,PrimaryEmail?:string,PhoneNumber?: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,RequestTokenSecret?:string,CreatedAt?:string,LastModified?:string,Roles?:string[],Permissions?:string[],IsAuthenticated?:boolean,FromToken?:boolean,ProfileUrl?:string,Sequence?:string,Tag?:number,AuthProvider?:string,ProviderOAuthAccess?:IAuthTokens[],Meta?:{ [index: string]: string; },Audiences?:string[],Scopes?:string[],Dns?:string,Rsa?:string,Sid?:string,Hash?:string,HomePhone?:string,MobilePhone?:string,Webpage?:string,EmailConfirmed?:boolean,PhoneNumberConfirmed?:boolean,TwoFactorEnabled?:boolean,SecurityStamp?:string,Type?:string,RecoveryToken?:string,RefId?:number,RefIdStr?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ReferrerUrl;
    /** @type {string} */
    Id;
    /** @type {string} */
    UserAuthId;
    /** @type {string} */
    UserAuthName;
    /** @type {string} */
    UserName;
    /** @type {string} */
    TwitterUserId;
    /** @type {string} */
    TwitterScreenName;
    /** @type {string} */
    FacebookUserId;
    /** @type {string} */
    FacebookUserName;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    DisplayName;
    /** @type {string} */
    Company;
    /** @type {string} */
    Email;
    /** @type {string} */
    PrimaryEmail;
    /** @type {string} */
    PhoneNumber;
    /** @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} */
    RequestTokenSecret;
    /** @type {string} */
    CreatedAt;
    /** @type {string} */
    LastModified;
    /** @type {string[]} */
    Roles;
    /** @type {string[]} */
    Permissions;
    /** @type {boolean} */
    IsAuthenticated;
    /** @type {boolean} */
    FromToken;
    /** @type {string} */
    ProfileUrl;
    /** @type {string} */
    Sequence;
    /** @type {number} */
    Tag;
    /** @type {string} */
    AuthProvider;
    /** @type {IAuthTokens[]} */
    ProviderOAuthAccess;
    /** @type {{ [index: string]: string; }} */
    Meta;
    /** @type {string[]} */
    Audiences;
    /** @type {string[]} */
    Scopes;
    /** @type {string} */
    Dns;
    /** @type {string} */
    Rsa;
    /** @type {string} */
    Sid;
    /** @type {string} */
    Hash;
    /** @type {string} */
    HomePhone;
    /** @type {string} */
    MobilePhone;
    /** @type {string} */
    Webpage;
    /** @type {?boolean} */
    EmailConfirmed;
    /** @type {?boolean} */
    PhoneNumberConfirmed;
    /** @type {?boolean} */
    TwoFactorEnabled;
    /** @type {string} */
    SecurityStamp;
    /** @type {string} */
    Type;
    /** @type {string} */
    RecoveryToken;
    /** @type {?number} */
    RefId;
    /** @type {string} */
    RefIdStr;
}
/** @typedef {'POSTGRESQL'|'ORACLE'|'SQLSERVER'} */
export var MotorBD;
(function (MotorBD) {
    MotorBD["POSTGRESQL"] = "POSTGRESQL"
    MotorBD["ORACLE"] = "ORACLE"
    MotorBD["SQLSERVER"] = "SQLSERVER"
})(MotorBD || (MotorBD = {}));
export class CustomUserSession extends AuthUserSession {
    /** @param {{IDUsuario?:string,IDSistema?:number,IDEmpresaProd?:string,IDEmpresa?:number,IDModulo?:string,MotorProd?:MotorBD,MotorAppAdm?:MotorBD,ProdConnectionString?:string,AppAdmConnectionString?:string,CacheKeyAdm?:string,Password?:string,SessionDB?:boolean,MensajeError?:string,DocumentoUsuario?:string,app_adm?:string,imei?:string,BaseURL?:string,UsaServAux?:string,TipoValidaAuth?:string,TokenExt?:string,Subsistema?:string,TwoFactor?:string,ReferrerUrl?:string,Id?:string,UserAuthId?:string,UserAuthName?:string,UserName?:string,TwitterUserId?:string,TwitterScreenName?:string,FacebookUserId?:string,FacebookUserName?:string,FirstName?:string,LastName?:string,DisplayName?:string,Company?:string,Email?:string,PrimaryEmail?:string,PhoneNumber?: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,RequestTokenSecret?:string,CreatedAt?:string,LastModified?:string,Roles?:string[],Permissions?:string[],IsAuthenticated?:boolean,FromToken?:boolean,ProfileUrl?:string,Sequence?:string,Tag?:number,AuthProvider?:string,ProviderOAuthAccess?:IAuthTokens[],Meta?:{ [index: string]: string; },Audiences?:string[],Scopes?:string[],Dns?:string,Rsa?:string,Sid?:string,Hash?:string,HomePhone?:string,MobilePhone?:string,Webpage?:string,EmailConfirmed?:boolean,PhoneNumberConfirmed?:boolean,TwoFactorEnabled?:boolean,SecurityStamp?:string,Type?:string,RecoveryToken?:string,RefId?:number,RefIdStr?:string,ReferrerUrl?:string,Id?:string,UserAuthId?:string,UserAuthName?:string,UserName?:string,TwitterUserId?:string,TwitterScreenName?:string,FacebookUserId?:string,FacebookUserName?:string,FirstName?:string,LastName?:string,DisplayName?:string,Company?:string,Email?:string,PrimaryEmail?:string,PhoneNumber?: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,RequestTokenSecret?:string,CreatedAt?:string,LastModified?:string,Roles?:string[],Permissions?:string[],IsAuthenticated?:boolean,FromToken?:boolean,ProfileUrl?:string,Sequence?:string,Tag?:number,AuthProvider?:string,ProviderOAuthAccess?:IAuthTokens[],Meta?:{ [index: string]: string; },Audiences?:string[],Scopes?:string[],Dns?:string,Rsa?:string,Sid?:string,Hash?:string,HomePhone?:string,MobilePhone?:string,Webpage?:string,EmailConfirmed?:boolean,PhoneNumberConfirmed?:boolean,TwoFactorEnabled?:boolean,SecurityStamp?:string,Type?:string,RecoveryToken?:string,RefId?:number,RefIdStr?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    IDUsuario;
    /** @type {number} */
    IDSistema;
    /** @type {string} */
    IDEmpresaProd;
    /** @type {number} */
    IDEmpresa;
    /** @type {string} */
    IDModulo;
    /** @type {MotorBD} */
    MotorProd;
    /** @type {MotorBD} */
    MotorAppAdm;
    /** @type {string} */
    ProdConnectionString;
    /** @type {string} */
    AppAdmConnectionString;
    /** @type {string} */
    CacheKeyAdm;
    /** @type {string} */
    Password;
    /** @type {boolean} */
    SessionDB;
    /** @type {string} */
    MensajeError;
    /** @type {string} */
    DocumentoUsuario;
    /** @type {string} */
    app_adm;
    /** @type {string} */
    imei;
    /** @type {string} */
    BaseURL;
    /** @type {string} */
    UsaServAux;
    /** @type {string} */
    TipoValidaAuth;
    /** @type {string} */
    TokenExt;
    /** @type {string} */
    Subsistema;
    /** @type {string} */
    TwoFactor;
    /** @type {string} */
    ReferrerUrl;
    /** @type {string} */
    Id;
    /** @type {string} */
    UserAuthId;
    /** @type {string} */
    UserAuthName;
    /** @type {string} */
    UserName;
    /** @type {string} */
    TwitterUserId;
    /** @type {string} */
    TwitterScreenName;
    /** @type {string} */
    FacebookUserId;
    /** @type {string} */
    FacebookUserName;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    DisplayName;
    /** @type {string} */
    Company;
    /** @type {string} */
    Email;
    /** @type {string} */
    PrimaryEmail;
    /** @type {string} */
    PhoneNumber;
    /** @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} */
    RequestTokenSecret;
    /** @type {string} */
    CreatedAt;
    /** @type {string} */
    LastModified;
    /** @type {string[]} */
    Roles;
    /** @type {string[]} */
    Permissions;
    /** @type {boolean} */
    IsAuthenticated;
    /** @type {boolean} */
    FromToken;
    /** @type {string} */
    ProfileUrl;
    /** @type {string} */
    Sequence;
    /** @type {number} */
    Tag;
    /** @type {string} */
    AuthProvider;
    /** @type {IAuthTokens[]} */
    ProviderOAuthAccess;
    /** @type {{ [index: string]: string; }} */
    Meta;
    /** @type {string[]} */
    Audiences;
    /** @type {string[]} */
    Scopes;
    /** @type {string} */
    Dns;
    /** @type {string} */
    Rsa;
    /** @type {string} */
    Sid;
    /** @type {string} */
    Hash;
    /** @type {string} */
    HomePhone;
    /** @type {string} */
    MobilePhone;
    /** @type {string} */
    Webpage;
    /** @type {?boolean} */
    EmailConfirmed;
    /** @type {?boolean} */
    PhoneNumberConfirmed;
    /** @type {?boolean} */
    TwoFactorEnabled;
    /** @type {string} */
    SecurityStamp;
    /** @type {string} */
    Type;
    /** @type {string} */
    RecoveryToken;
    /** @type {?number} */
    RefId;
    /** @type {string} */
    RefIdStr;
}

JavaScript CustomUserSession DTOs

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

HTTP + JSV

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

POST /jsv/reply/CustomUserSession HTTP/1.1 
Host: soluser-recaudo.sgsas.co 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	"IDUsuario": "String",
	"IDSistema": 0,
	"IDEmpresaProd": "String",
	"IDEmpresa": 0,
	"IDModulo": "String",
	"MotorProd": "POSTGRESQL",
	"MotorAppAdm": "POSTGRESQL",
	"ProdConnectionString": "String",
	"AppAdmConnectionString": "String",
	"CacheKeyAdm": "String",
	"Password": "String",
	"SessionDB": false,
	"MensajeError": "String",
	"DocumentoUsuario": "String",
	"app_adm": "String",
	"imei": "String",
	"BaseURL": "String",
	"UsaServAux": "String",
	"TipoValidaAuth": "String",
	"TokenExt": "String",
	"Subsistema": "String",
	"TwoFactor": "String",
	"ReferrerUrl": "String",
	"Id": "String",
	"UserAuthId": "String",
	"UserAuthName": "String",
	"UserName": "String",
	"TwitterUserId": "String",
	"TwitterScreenName": "String",
	"FacebookUserId": "String",
	"FacebookUserName": "String",
	"FirstName": "String",
	"LastName": "String",
	"DisplayName": "String",
	"Company": "String",
	"Email": "String",
	"PrimaryEmail": "String",
	"PhoneNumber": "String",
	"BirthDate": "0001-01-01T00:00:00.0000000",
	"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",
	"RequestTokenSecret": "String",
	"Roles": 
	[
		"String"
	],
	"Permissions": 
	[
		"String"
	],
	"IsAuthenticated": false,
	"FromToken": false,
	"ProfileUrl": "String",
	"Sequence": "String",
	"Tag": 0,
	"AuthProvider": "String",
	"ProviderOAuthAccess": 
	[
		{
			
		}
	],
	"Meta": 
	{
		"String": "String"
	},
	"Audiences": 
	[
		"String"
	],
	"Scopes": 
	[
		"String"
	],
	"Dns": "String",
	"Rsa": "String",
	"Sid": "String",
	"Hash": "String",
	"HomePhone": "String",
	"MobilePhone": "String",
	"Webpage": "String",
	"EmailConfirmed": false,
	"PhoneNumberConfirmed": false,
	"TwoFactorEnabled": false,
	"SecurityStamp": "String",
	"Type": "String",
	"RecoveryToken": "String",
	"RefId": 0,
	"RefIdStr": "String"
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	"IDUsuario": "String",
	"IDSistema": 0,
	"IDEmpresaProd": "String",
	"IDEmpresa": 0,
	"IDModulo": "String",
	"MotorProd": "POSTGRESQL",
	"MotorAppAdm": "POSTGRESQL",
	"ProdConnectionString": "String",
	"AppAdmConnectionString": "String",
	"CacheKeyAdm": "String",
	"Password": "String",
	"SessionDB": false,
	"MensajeError": "String",
	"DocumentoUsuario": "String",
	"app_adm": "String",
	"imei": "String",
	"BaseURL": "String",
	"UsaServAux": "String",
	"TipoValidaAuth": "String",
	"TokenExt": "String",
	"Subsistema": "String",
	"TwoFactor": "String",
	"ReferrerUrl": "String",
	"Id": "String",
	"UserAuthId": "String",
	"UserAuthName": "String",
	"UserName": "String",
	"TwitterUserId": "String",
	"TwitterScreenName": "String",
	"FacebookUserId": "String",
	"FacebookUserName": "String",
	"FirstName": "String",
	"LastName": "String",
	"DisplayName": "String",
	"Company": "String",
	"Email": "String",
	"PrimaryEmail": "String",
	"PhoneNumber": "String",
	"BirthDate": "0001-01-01T00:00:00.0000000",
	"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",
	"RequestTokenSecret": "String",
	"Roles": 
	[
		"String"
	],
	"Permissions": 
	[
		"String"
	],
	"IsAuthenticated": false,
	"FromToken": false,
	"ProfileUrl": "String",
	"Sequence": "String",
	"Tag": 0,
	"AuthProvider": "String",
	"ProviderOAuthAccess": 
	[
		{
			
		}
	],
	"Meta": 
	{
		"String": "String"
	},
	"Audiences": 
	[
		"String"
	],
	"Scopes": 
	[
		"String"
	],
	"Dns": "String",
	"Rsa": "String",
	"Sid": "String",
	"Hash": "String",
	"HomePhone": "String",
	"MobilePhone": "String",
	"Webpage": "String",
	"EmailConfirmed": false,
	"PhoneNumberConfirmed": false,
	"TwoFactorEnabled": false,
	"SecurityStamp": "String",
	"Type": "String",
	"RecoveryToken": "String",
	"RefId": 0,
	"RefIdStr": "String"
}