INTERNAL-Authorization

<back to all web services

AuthorizeUser

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

public class AuthorizeUser : IAuthorizeUser, Codable
{
    // @ApiMember(IsRequired=true)
    public var bearerToken:String

    // @ApiMember(IsRequired=true, ParameterType="path")
    public var profile:String

    // @ApiMember(IsRequired=true, ParameterType="path")
    public var service:String

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

    required public init(){}
}

public class AuthorizeUserResponse : AuthorizeBaseResponse, IAuthorizeUserResponse
{
    public var userObjectId:String?
    public var userTenant:String
    public var userTenantId:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case userObjectId
        case userTenant
        case userTenantId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        userObjectId = try container.decodeIfPresent(String.self, forKey: .userObjectId)
        userTenant = try container.decodeIfPresent(String.self, forKey: .userTenant)
        userTenantId = try container.decodeIfPresent(String.self, forKey: .userTenantId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if userObjectId != nil { try container.encode(userObjectId, forKey: .userObjectId) }
        if userTenant != nil { try container.encode(userTenant, forKey: .userTenant) }
        if userTenantId != nil { try container.encode(userTenantId, forKey: .userTenantId) }
    }
}

public class AuthorizeBaseResponse : Codable
{
    public var isAuthorized:Bool
    public var settings:[Setting] = []
    public var suggestedStatusCode:Int
    public var suggestedResponseMessage:String
    public var reason:String
    public var customerId:String?

    required public init(){}
}

public class Setting : Codable
{
    public var name:String
    public var stringValue:String
    public var booleanValue:Bool
    public var dataType:String

    required public init(){}
}


Swift AuthorizeUser DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

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

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