Auth.Api

<back to all web services

ApplicationAuthenticationDTO

The following routes are available for this service:
POST/admin/v1/applications/authentication
ApplicationAuthenticationDTO Parameters:
NameParameterData TypeRequiredDescription
CodebodystringNo
SecretKeybodystringNo
ApplicationDTOResponse Parameters:
NameParameterData TypeRequiredDescription
RolesformList<string>No
ScopeformList<string>No
ApplicationsformApplicationsNo
SiblingApplicationsIdformList<int>No
ApplicationAccessformApplicationAccessNo
ApplicationLanguagesformApplicationLanguagesNo
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
StatusformApiResponseStatusNo
CodeformintNo
apiVersionformstringNo
appVersionformstringNo
ApiResponseStatus Enum:
OK
FAIL
Default
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
ApplicationAccess Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ApplicationsIdformintNo
CodeformstringNo
NameformstringNo
DescriptionformstringNo
RecordStatusIdformintNo
SystemAttributes Parameters:
NameParameterData TypeRequiredDescription
UserIdformint?No
UserIdUpdformint?No
UserIdValformint?No
UserIdDelformint?No
UTCRecordTimestampformDateTimeNo
UTCRecordTimestampUpdformDateTimeNo
UTCRecordTimestampValformDateTimeNo
UTCRecordTimestampDelformDateTimeNo
ApplicationLanguages Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CodeISOformstringNo
NameformstringNo
RecordStatusIdformintNo

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

{
	code: String,
	secretKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	appVersion: String,
	roles: 
	[
		String
	],
	scope: 
	[
		String
	],
	applications: 
	{
		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
	},
	siblingApplicationsId: 
	[
		0
	],
	applicationAccess: 
	{
		id: 0,
		applicationsId: 0,
		code: String,
		name: String,
		description: String,
		recordStatusId: 0,
		userId: 0,
		userIdUpd: 0,
		userIdVal: 0,
		userIdDel: 0,
		utcRecordTimestamp: 0001-01-01,
		utcRecordTimestampUpd: 0001-01-01,
		utcRecordTimestampVal: 0001-01-01,
		utcRecordTimestampDel: 0001-01-01
	},
	applicationLanguages: 
	{
		id: 0,
		codeISO: String,
		name: String,
		recordStatusId: 0
	},
	status: OK,
	code: 0,
	apiVersion: String
}