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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<AuthorizeUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Norkart.Api.Authorization.ServiceModel">
  <BearerToken>String</BearerToken>
  <CustomerContext>String</CustomerContext>
  <Profile>String</Profile>
  <Service>String</Service>
</AuthorizeUser>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AuthorizeUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Norkart.Api.Authorization.ServiceModel">
  <CustomerId i:nil="true" />
  <IsAuthorized>false</IsAuthorized>
  <Reason>String</Reason>
  <Settings>
    <Setting>
      <BooleanValue>false</BooleanValue>
      <DataType>String</DataType>
      <Name>String</Name>
      <StringValue>String</StringValue>
    </Setting>
  </Settings>
  <SuggestedResponseMessage>String</SuggestedResponseMessage>
  <SuggestedStatusCode>0</SuggestedStatusCode>
  <UserObjectId i:nil="true" />
  <UserTenant>String</UserTenant>
  <UserTenantId>String</UserTenantId>
</AuthorizeUserResponse>