Auth.Api

<back to all web services

AuthenticationDTO

The following routes are available for this service:
All Verbs/authentication
AuthenticationDTO Parameters:
NameParameterData TypeRequiredDescription
PublicKeyquerystringNo
RedirectquerystringNo
AuthenticationResponse Parameters:
NameParameterData TypeRequiredDescription
ApplicationformApplicationsNo
ApplicationsAccessSSONameformstringNo
DefaultLoginProvidersformLoginProvidersNo
LoginProvidersformList<LoginProviders>No
PublicKeyformstringNo
RedirectformstringNo
LoginDesignformLoginDesignNo
DisplayLoginProviderformboolNo
DisplayAccountManagementformboolNo
DisplaySignatureCommentformboolNo
LayoutResponse Parameters:
NameParameterData TypeRequiredDescription
TitleformstringNo
Applications Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DomainsIdformintNo
CodeformstringNo
NameformstringNo
DescriptionformstringNo
IsSystemformboolNo
IsLockedformboolNo
ApplicationLanguagesIdformint?No
TokenExpirationMinutesformintNo
TokenAllowedRefreshesformint?No
TokenExpirationWarningTimeMinutesformintNo
TokenValidAfterExpirationMinutesformintNo
AllowUserDataOverrideformboolNo
RecordStatusIdformintNo
UserIdInsformint?No
UserIdUpdformint?No
UserIdValformint?No
UserIdDelformint?No
UTCRecordTimestampformDateTimeNo
UTCRecordTimestampUpdformDateTimeNo
UTCRecordTimestampValformDateTimeNo
UTCRecordTimestampDelformDateTimeNo
TimezoneIdformint?No
TimezoneStandardNameformstringNo
LoginProviders Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ApplicationsIdformintNo
CodeformstringNo
UserIdentificationPrefixformstringNo
LoginProviderTypeCodeformstringNo
RecordStatusIdformintNo
LoginDesign Parameters:
NameParameterData TypeRequiredDescription
logoformstringNo
bgColorformstringNo
textColorformstringNo
mainColorformstringNo

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 /authentication HTTP/1.1 
Host: auth.mepis.si 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	public-key: String,
	redirect: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	application: 
	{
		id: 0,
		domainsId: 0,
		code: String,
		name: String,
		description: String,
		isSystem: False,
		isLocked: False,
		applicationLanguagesId: 0,
		tokenExpirationMinutes: 0,
		tokenAllowedRefreshes: 0,
		tokenExpirationWarningTimeMinutes: 0,
		tokenValidAfterExpirationMinutes: 0,
		allowUserDataOverride: False,
		recordStatusId: 0,
		userIdIns: 0,
		userIdUpd: 0,
		userIdVal: 0,
		userIdDel: 0,
		utcRecordTimestamp: 0001-01-01,
		utcRecordTimestampUpd: 0001-01-01,
		utcRecordTimestampVal: 0001-01-01,
		utcRecordTimestampDel: 0001-01-01,
		timezoneId: 0,
		timezoneStandardName: String
	},
	applicationsAccessSSOName: String,
	defaultLoginProviders: 
	{
		id: 0,
		applicationsId: 0,
		code: String,
		userIdentificationPrefix: String,
		loginProviderTypeCode: String,
		recordStatusId: 0
	},
	loginProviders: 
	[
		{
			id: 0,
			applicationsId: 0,
			code: String,
			userIdentificationPrefix: String,
			loginProviderTypeCode: String,
			recordStatusId: 0
		}
	],
	publicKey: String,
	redirect: String,
	loginDesign: 
	{
		logo: String,
		bgColor: String,
		textColor: String,
		mainColor: String
	},
	displayLoginProvider: False,
	displayAccountManagement: False,
	displaySignatureComment: False,
	title: String
}