Auth.Api

<back to all web services

TokenRefreshDTO

The following routes are available for this service:
POST/admin/v1/token/refresh
TokenRefreshDTO Parameters:
NameParameterData TypeRequiredDescription
RefreshTokenbodystringNo
JwtbodystringNo
TokenDTOResponse Parameters:
NameParameterData TypeRequiredDescription
TokensformTokensNo
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
StatusformApiResponseStatusNo
CodeformintNo
apiVersionformstringNo
appVersionformstringNo
ApiResponseStatus Enum:
OK
FAIL
Default
Tokens Parameters:
NameParameterData TypeRequiredDescription
AccessTokenformstringNo
RefreshTokenformstringNo
ExpiresInformintNo
ExpirationWarningformintNo
AllowedRefreshesformint?No
TokenValidAfterExpirationformintNo
UsernameformstringNo
TokenTypeformstringNo
ScopeformList<string>No
RolesformList<string>No
ApplicationsformApplicationsNo
ApplicationLanguagesformApplicationLanguagesNo
TimezonesformTimezonesNo
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
ApplicationLanguages Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CodeISOformstringNo
NameformstringNo
RecordStatusIdformintNo
Timezones Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DisplayNameformstringNo
StandardNameformstringNo
DaylightNameformstringNo
UtcOffsetformstringNo
SupportsDaylightSavingsformboolNo

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

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

{
	tokens: 
	{
		accessToken: String,
		refreshToken: String,
		expiresIn: 0,
		expirationWarning: 0,
		allowedRefreshes: 0,
		tokenValidAfterExpiration: 0,
		username: String,
		tokenType: String,
		scope: 
		[
			String
		],
		roles: 
		[
			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
		},
		applicationLanguages: 
		{
			id: 0,
			codeISO: String,
			name: String,
			recordStatusId: 0
		},
		timezones: 
		{
			id: 0,
			displayName: String,
			standardName: String,
			daylightName: String,
			utcOffset: String,
			supportsDaylightSavings: False
		}
	},
	status: OK,
	code: 0,
	apiVersion: String,
	appVersion: String
}