INTERNAL-Authorization

<back to all web services

AuthorizeUser

Requires Authentication
The following routes are available for this service:
GET,POST/authorizeuser/{Service}/{Profile}
AuthorizeUser Parameters:
NameParameterData TypeRequiredDescription
BearerTokenbodystringYes
ProfilepathstringYes
ServicepathstringYes
CustomerContextheaderstringNo
AuthorizeUserResponse Parameters:
NameParameterData TypeRequiredDescription
UserObjectIdformGuid?No
UserTenantformstringNo
UserTenantIdformstringNo
AuthorizeBaseResponse Parameters:
NameParameterData TypeRequiredDescription
IsAuthorizedformboolNo
SettingsformList<Setting>No
SuggestedStatusCodeformintNo
SuggestedResponseMessageformstringNo
ReasonformstringNo
CustomerIdformGuid?No
Setting Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
StringValueformstringNo
BooleanValueformboolNo
DataTypeformstringNo

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