INTERNAL-Authorization

<back to all web services

AuthorizeUser

Requires Authentication
The following routes are available for this service:
GET,POST/authorizeuser/{Service}/{Profile}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Setting:
    name: Optional[str] = None
    string_value: Optional[str] = None
    boolean_value: bool = False
    data_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AuthorizeBaseResponse:
    is_authorized: bool = False
    settings: Optional[List[Setting]] = None
    suggested_status_code: int = 0
    suggested_response_message: Optional[str] = None
    reason: Optional[str] = None
    customer_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AuthorizeUserResponse(AuthorizeBaseResponse, IAuthorizeUserResponse):
    user_object_id: Optional[str] = None
    user_tenant: Optional[str] = None
    user_tenant_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AuthorizeUser(IAuthorizeUser):
    # @ApiMember(IsRequired=true)
    bearer_token: Optional[str] = None

    # @ApiMember(IsRequired=true, ParameterType="path")
    profile: Optional[str] = None

    # @ApiMember(IsRequired=true, ParameterType="path")
    service: Optional[str] = None

    # @ApiMember(Name="X-WAAPI-CONTEXT", ParameterType="header")
    customer_context: Optional[str] = None

Python 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
}