INTERNAL-Authorization

<back to all web services

AuthorizeUser

Requires Authentication
The following routes are available for this service:
GET,POST/authorizeuser/{Service}/{Profile}
"use strict";
export class Setting {
    /** @param {{name?:string,stringValue?:string,booleanValue?:boolean,dataType?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    name;
    /** @type {string} */
    stringValue;
    /** @type {boolean} */
    booleanValue;
    /** @type {string} */
    dataType;
}
export class AuthorizeBaseResponse {
    /** @param {{isAuthorized?:boolean,settings?:Setting[],suggestedStatusCode?:number,suggestedResponseMessage?:string,reason?:string,customerId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    isAuthorized;
    /** @type {Setting[]} */
    settings;
    /** @type {number} */
    suggestedStatusCode;
    /** @type {string} */
    suggestedResponseMessage;
    /** @type {string} */
    reason;
    /** @type {?string} */
    customerId;
}
export class AuthorizeUserResponse extends AuthorizeBaseResponse {
    /** @param {{userObjectId?:string,userTenant?:string,userTenantId?:string,isAuthorized?:boolean,settings?:Setting[],suggestedStatusCode?:number,suggestedResponseMessage?:string,reason?:string,customerId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?string} */
    userObjectId;
    /** @type {string} */
    userTenant;
    /** @type {string} */
    userTenantId;
}
export class AuthorizeUser {
    /** @param {{bearerToken?:string,profile?:string,service?:string,customerContext?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    bearerToken;
    /** @type {string} */
    profile;
    /** @type {string} */
    service;
    /** @type {string} */
    customerContext;
}

JavaScript AuthorizeUser 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 /authorizeuser/{Service}/{Profile} HTTP/1.1 
Host: nkapi-sgepz3-auth-r1.azurewebsites.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	bearerToken: String,
	profile: String,
	service: String,
	customerContext: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	userTenant: String,
	userTenantId: String,
	isAuthorized: False,
	settings: 
	[
		{
			name: String,
			stringValue: String,
			booleanValue: False,
			dataType: String
		}
	],
	suggestedStatusCode: 0,
	suggestedResponseMessage: String,
	reason: String
}