Hvl Authentication Server
Havelsan authentication services info
Version: 5.1.0-SNAPSHOT
Apache License Version 2.0
https://www.apache.org/licenses/LICENSE-2.0
Access
[ Jump to Models ]
Table of Contents
Up
post /auth/complete-login-with-code
User login with the given code (completeLoginWithCode)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"userModel" : {
"profileName" : "profileName",
"failedLoginCount" : 9,
"userDetail" : {
"updatedBy" : "updatedBy",
"mobileNumber" : "mobileNumber",
"nameSurname" : "nameSurname",
"uuid" : "uuid",
"version" : 1,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"personalIdentifier" : "personalIdentifier",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"integrationCode" : "integrationCode",
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"surname" : "surname",
"name" : "name",
"id" : 5,
"userType" : {
"parameterType" : "parameterType",
"updatedBy" : "updatedBy",
"code" : "code",
"orderNo" : 7,
"description" : "description",
"shortDescription" : "shortDescription",
"uuid" : "uuid",
"version" : 5,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"integrationCode" : "integrationCode",
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"id" : 2
},
"email" : "email"
},
"description" : "description",
"dn" : "dn",
"secret" : "secret",
"uuid" : "uuid",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"lockDescription" : "lockDescription",
"passwordUpdatedDate" : "2000-01-23T04:56:07.000+00:00",
"id" : 6,
"locked" : true,
"tenant" : "tenant",
"expirationDate" : "2000-01-23T04:56:07.000+00:00",
"googleAuthenticatorEnabled" : true,
"passwordMustChange" : true,
"updatedBy" : "updatedBy",
"ou" : "ou",
"lockedDate" : "2000-01-23T04:56:07.000+00:00",
"version" : 0,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"system" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"username" : "username"
},
"attributeMap" : {
"key" : { }
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlAuthAuthenticationResponseModel
Up
post /auth/captcha-image-string
Generates captcha image string. (getCaptchaImageString)
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : "body"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseString
User login with the given username and password (login)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : {
"userModel" : {
"profileName" : "profileName",
"failedLoginCount" : 9,
"userDetail" : {
"updatedBy" : "updatedBy",
"mobileNumber" : "mobileNumber",
"nameSurname" : "nameSurname",
"uuid" : "uuid",
"version" : 1,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"personalIdentifier" : "personalIdentifier",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"integrationCode" : "integrationCode",
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"surname" : "surname",
"name" : "name",
"id" : 5,
"userType" : {
"parameterType" : "parameterType",
"updatedBy" : "updatedBy",
"code" : "code",
"orderNo" : 7,
"description" : "description",
"shortDescription" : "shortDescription",
"uuid" : "uuid",
"version" : 5,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"integrationCode" : "integrationCode",
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"id" : 2
},
"email" : "email"
},
"description" : "description",
"dn" : "dn",
"secret" : "secret",
"uuid" : "uuid",
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
"expired" : true,
"lockDescription" : "lockDescription",
"passwordUpdatedDate" : "2000-01-23T04:56:07.000+00:00",
"id" : 6,
"locked" : true,
"tenant" : "tenant",
"expirationDate" : "2000-01-23T04:56:07.000+00:00",
"googleAuthenticatorEnabled" : true,
"passwordMustChange" : true,
"updatedBy" : "updatedBy",
"ou" : "ou",
"lockedDate" : "2000-01-23T04:56:07.000+00:00",
"version" : 0,
"dateUpdated" : "2000-01-23T04:56:07.000+00:00",
"deleted" : true,
"system" : true,
"createdBy" : "createdBy",
"deletedDate" : "2000-01-23T04:56:07.000+00:00",
"username" : "username"
},
"attributeMap" : {
"key" : { }
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseHvlAuthAuthenticationResponseModel
Deletes the current token and redirects to the given page. The user becomes unable to use the system (logout)
Query parameters
redirect (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : { }
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseVoid
Refreshes existing token. (refresh)
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : "body"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseString
Up
get /auth/setting/registration-enabled
Gets registration enabled setting value (getRegisterEnabled)
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseBoolean
Up
get /auth/setting/register-user-detail-types
Gets register user detail type setting value (getRegisterUserDetailTypes)
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : "body"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseString
Up
get /auth/setting/two-factor-authentication-types
Gets two factor authentication types setting value (getTwoFactorAuthenticationTypes)
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : "body"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseString
Up
get /auth/setting/two-factor-authentication-verification-code-min-duration
Gets two factor authentication verification code min duration setting value (getTwoFactorAuthenticationVerificationCodeMinDuration)
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : 0
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseLong
Up
get /verification/captcha
Generates captcha image. (captcha)
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : "body"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseString
Up
post /verification/exists
System verification is made with the given username and code is exist. (exists)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseBoolean
Up
post /verification/generate
Generates code to nad saves it. (generate)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : "body"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseString
Up
post /verification/validate
System verification is made with the given username and code is validated. (validate)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"errorDetail" : {
"errorClassName" : "errorClassName",
"service" : "service",
"errorMessage" : "errorMessage",
"errorCode" : "errorCode",
"errorDetail" : "errorDetail",
"time" : "2000-01-23T04:56:07.000+00:00",
"uuid" : "uuid",
"errorArguments" : [ { }, { } ]
},
"body" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
OK
HvlResponseBoolean
[ Jump to Methods ]
Table of Contents
HvlAuthAuthenticationRequestModelHvlAuthAuthenticationResponseModelHvlAuthVerificationCodeModelHvlAuthVerificationRequestModelHvlErrorDetailHvlOAuthUserDetailModelHvlOAuthUserModelHvlOAuthUserTypeModelHvlResponseBooleanHvlResponseHvlAuthAuthenticationResponseModelHvlResponseLongHvlResponseStringHvlResponseVoid
username
password (optional)
tenant (optional)
captchaVerificationCode (optional)
authenticationType (optional)
DB
LDAP
EDEVLET
KERBEROS
API_KEY
userModel (optional)
attributeMap (optional)
email
code
tenant (optional)
verificationType (optional)
NONE
SMS
MAIL
GA
captchaVerificationCode (optional)
verificationCodeModel (optional)
uuid (optional)
errorClassName (optional)
errorCode (optional)
errorDetail (optional)
errorMessage (optional)
service (optional)
time (optional)
errorArguments (optional)
uuid
version (optional)
dateCreated (optional)
dateUpdated (optional)
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
id
name
surname
email (optional)
mobileNumber (optional)
userType (optional)
integrationCode (optional)
personalIdentifier (optional)
nameSurname (optional)
uuid
version (optional)
dateCreated (optional)
dateUpdated (optional)
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
id
username
userDetail (optional)
tenant (optional)
system (optional)
failedLoginCount (optional)
locked (optional)
lockedDate (optional)
lockDescription (optional)
expired (optional)
expirationDate (optional)
passwordUpdatedDate (optional)
passwordMustChange (optional)
googleAuthenticatorEnabled (optional)
dn (optional)
ou (optional)
profileName (optional)
secret (optional)
description (optional)
uuid
version (optional)
dateCreated (optional)
dateUpdated (optional)
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
id
code
description (optional)
orderNo (optional)
integrationCode (optional)
shortDescription (optional)
parameterType
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)
body (optional)
errorDetail (optional)