AlbaApi

<back to all web services

ValidateNemIdRequestModel

The following routes are available for this service:
GET/nemidvalidatelogin

export class ValidateNemIdRequestModel
{

    public constructor(init?: Partial<ValidateNemIdRequestModel>) { (Object as any).assign(this, init); }
}

export class Body
{

    public constructor(init?: Partial<Body>) { (Object as any).assign(this, init); }
}

export class FlowMessage extends Body
{
    public timestamp?: string;
    public transactionIdentifier?: string;

    public constructor(init?: Partial<FlowMessage>) { super(init); (Object as any).assign(this, init); }
}

export enum ClientFlow
{
    NemID = 'NemID',
    NemIDSignature = 'NemIDSignature',
    NemIDKeyFile = 'NemIDKeyFile',
    NemIDKeyFileSignature = 'NemIDKeyFileSignature',
    NL3Signature = 'NL3Signature',
    Invalid = 'Invalid',
    LoadTest = 'LoadTest',
}

export enum FlowStatus
{
    Ok = 'Ok',
    UserCancel = 'UserCancel',
    ClientFlowError = 'ClientFlowError',
    FlowError = 'FlowError',
    ValidationError = 'ValidationError',
}

export class FlowResult extends FlowMessage
{
    public clientFlow?: ClientFlow;
    public status?: FlowStatus;
    public isSuccess?: boolean;
    public message?: string;
    public userMessage?: string;
    public flowErrorCode?: string;

    public constructor(init?: Partial<FlowResult>) { super(init); (Object as any).assign(this, init); }
}

export enum CertificateType
{
    Poces = 'Poces',
    Moces = 'Moces',
    Voces = 'Voces',
    Foces = 'Foces',
}

export class SignProperty
{
    public name?: string;
    public value?: string;

    public constructor(init?: Partial<SignProperty>) { (Object as any).assign(this, init); }
}

export enum LogonType
{
    Otp = 'Otp',
    KeyFile = 'KeyFile',
    Unknown = 'Unknown',
}

export class AuthenticationInfo
{
    public pid?: string;
    public dn?: string;
    public commonName?: string;
    public rid?: string;
    public cpr?: string;
    public cvr?: string;
    public company?: string;
    public email?: string;
    public signedXml?: string;
    public issuerDn?: string;
    public isYouthCert?: boolean;
    public certificateType?: CertificateType;
    public subjectSerialNumber?: string;
    public signProperties?: IList<SignProperty>;
    public rememberUserIdToken?: string;
    public logonType?: LogonType;
    public certificateSerialNumber?: string;
    public clientCertificate?: string;
    public authorizedToRepresent?: string;

    public constructor(init?: Partial<AuthenticationInfo>) { (Object as any).assign(this, init); }
}

export class NemIDFlowResult extends FlowResult
{
    public authenticationInfo?: AuthenticationInfo;

    public constructor(init?: Partial<NemIDFlowResult>) { super(init); (Object as any).assign(this, init); }
}

TypeScript ValidateNemIdRequestModel 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.

GET /nemidvalidatelogin HTTP/1.1 
Host: hcbtas-q-albamfs-api.azurewebsites.net 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	authenticationInfo: 
	{
		pid: String,
		dn: String,
		commonName: String,
		rid: String,
		cpr: String,
		cvr: String,
		company: String,
		email: String,
		signedXml: String,
		issuerDn: String,
		isYouthCert: False,
		certificateType: Poces,
		subjectSerialNumber: String,
		rememberUserIdToken: String,
		logonType: Otp,
		certificateSerialNumber: String,
		clientCertificate: AA==,
		authorizedToRepresent: String
	},
	clientFlow: NemID,
	status: Ok,
	isSuccess: True,
	message: String,
	userMessage: String,
	flowErrorCode: String,
	timestamp: String,
	transactionIdentifier: String
}