INTERNAL-Authorization

<back to all web services

AuthorizeUser

Requires Authentication
The following routes are available for this service:
GET,POST/authorizeuser/{Service}/{Profile}

export class Setting
{
    public name: string;
    public stringValue: string;
    public booleanValue: boolean;
    public dataType: string;

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

export class AuthorizeBaseResponse
{
    public isAuthorized: boolean;
    public settings: Setting[];
    public suggestedStatusCode: number;
    public suggestedResponseMessage: string;
    public reason: string;
    public customerId?: string;

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

export class AuthorizeUserResponse extends AuthorizeBaseResponse implements IAuthorizeUserResponse
{
    public userObjectId?: string;
    public userTenant: string;
    public userTenantId: string;

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

export class AuthorizeUser implements IAuthorizeUser
{
    // @ApiMember(IsRequired=true)
    public bearerToken: string;

    // @ApiMember(IsRequired=true, ParameterType="path")
    public profile: string;

    // @ApiMember(IsRequired=true, ParameterType="path")
    public service: string;

    // @ApiMember(Name="X-WAAPI-CONTEXT", ParameterType="header")
    public customerContext: string;

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

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