Hvl Authorization Server

Havelsan authorization services info
More information: https://www.havelsan.com.tr
Contact Info: BIT_JAVA_ALTYAPI_YAZILIM_MIM_TK@havelsan.com.tr
Version: 5.1.0-SNAPSHOT
Apache License Version 2.0
https://www.apache.org/licenses/LICENSE-2.0

Access

Methods

[ Jump to Models ]

Table of Contents

AuditAPI

AuthorityAPI

EventLogPublic

GoogleAuthenticatorAPI

LdapAPI

LookupAPI

PasswordRestrictionAPI

PredefinedProxyAPI

PredefinedRoleAPI

ProfileAPI

ProfileBatchProcessingAPI

ProfileDetailAPI

ProfileGroupAPI

ProxyAPI

ProxyAdminAPI

RegistrationAPI

RoleAPI

RoleAssignerAPI

RoleBatchProcessingAPI

RoleGroupAPI

SessionAPI

SystemUserAPI

TagAPI

TrustedProxyAPI

UserAPI

UserBatchProcessingAPI

UserDetailAPI

UserFieldValueGeneratorAPI

UserPasswordPolicyAPI

UserStrategyAPI

AuditAPI

Up
get /audits/list
Gets all audit list (queryList8)

Return type

HvlResponseListHvlOAuthAuditModel

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" : [ {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "auditGroup" : "USER",
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "enabled" : true,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "auditGroup" : "USER",
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "enabled" : true,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthAuditModel

Up
put /audits/update
Updates audit data (update22)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthAuditModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

AuthorityAPI

Up
delete /authorities/by-uuid/{uuid}
Deletes authority with provided uuid (deleteByUuid18)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /authorities/by-uuid/{uuid}
Gets authority by given uuid. (getByUuid18)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthAuthorityModel

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" : {
    "updatedBy" : "updatedBy",
    "code" : "code",
    "critical" : true,
    "description" : "description",
    "label" : "label",
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "id" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthAuthorityModel

Up
post /authorities/tags/list
Query authority tag list by given criteria. (queryAuthorityTagList)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseListHvlOAuthAuthorityTagDataModel

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" : [ {
    "updatedBy" : "updatedBy",
    "tagId" : 2,
    "tagName" : "tagName",
    "uuid" : "uuid",
    "version" : 1,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "authorityId" : 5,
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "authorityCode" : "authorityCode",
    "authorityLabel" : "authorityLabel",
    "id" : 5
  }, {
    "updatedBy" : "updatedBy",
    "tagId" : 2,
    "tagName" : "tagName",
    "uuid" : "uuid",
    "version" : 1,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "authorityId" : 5,
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "authorityCode" : "authorityCode",
    "authorityLabel" : "authorityLabel",
    "id" : 5
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthAuthorityTagDataModel

Up
post /authorities/tags/page
Query authority tags with pagination by given criteria. (queryAuthorityTagPage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthAuthorityTagDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "tagId" : 2,
      "tagName" : "tagName",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "authorityId" : 5,
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "authorityCode" : "authorityCode",
      "authorityLabel" : "authorityLabel",
      "id" : 5
    }, {
      "updatedBy" : "updatedBy",
      "tagId" : 2,
      "tagName" : "tagName",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "authorityId" : 5,
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "authorityCode" : "authorityCode",
      "authorityLabel" : "authorityLabel",
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthAuthorityTagDataModel

Up
post /authorities/data/claim/list
Query authority claim for assigned entity relation as list according to criteria in query model. (queryClaimDataList1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseListHvlOAuthAuthorityClaimDataModel

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" : [ {
    "updatedBy" : "updatedBy",
    "code" : "code",
    "critical" : true,
    "hasChildren" : true,
    "hasAnySelectedChildren" : true,
    "description" : "description",
    "label" : "label",
    "uuid" : "uuid",
    "version" : 1,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "id" : 5,
    "assignedEntityId" : 5
  }, {
    "updatedBy" : "updatedBy",
    "code" : "code",
    "critical" : true,
    "hasChildren" : true,
    "hasAnySelectedChildren" : true,
    "description" : "description",
    "label" : "label",
    "uuid" : "uuid",
    "version" : 1,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "id" : 5,
    "assignedEntityId" : 5
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthAuthorityClaimDataModel

Up
post /authorities/data/claim/page
Queries authority claim for assigned entity relation as paginated according to criteria in query model (queryClaimDataPage5)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthAuthorityClaimDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "critical" : true,
      "hasChildren" : true,
      "hasAnySelectedChildren" : true,
      "description" : "description",
      "label" : "label",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "id" : 5,
      "assignedEntityId" : 5
    }, {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "critical" : true,
      "hasChildren" : true,
      "hasAnySelectedChildren" : true,
      "description" : "description",
      "label" : "label",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "id" : 5,
      "assignedEntityId" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthAuthorityClaimDataModel

Up
post /authorities/page
Queries authority as paginated according to criteria in query model (queryDataPage7)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthAuthorityDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "critical" : true,
      "hasChildren" : true,
      "hasAnySelectedChildren" : true,
      "description" : "description",
      "label" : "label",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "id" : 5
    }, {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "critical" : true,
      "hasChildren" : true,
      "hasAnySelectedChildren" : true,
      "description" : "description",
      "label" : "label",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthAuthorityDataModel

Up
post /authorities/page/with-module-name
Queries authority as paginated according to criteria in query model with module name (queryModuleDataPage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthAuthorityDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "critical" : true,
      "hasChildren" : true,
      "hasAnySelectedChildren" : true,
      "description" : "description",
      "label" : "label",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "id" : 5
    }, {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "critical" : true,
      "hasChildren" : true,
      "hasAnySelectedChildren" : true,
      "description" : "description",
      "label" : "label",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthAuthorityDataModel

Up
post /authorities
Saves authority data (save20)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthAuthorityModel (required)
Body Parameter

Return type

HvlResponseHvlOAuthAuthorityModel

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" : {
    "updatedBy" : "updatedBy",
    "code" : "code",
    "critical" : true,
    "description" : "description",
    "label" : "label",
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "id" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthAuthorityModel

Up
put /authorities
Updates authority data (update21)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthAuthorityModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /authorities/profile-groups
Update profile groups to authority. (updateProfileGroups)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /authorities/tags
Update tags to authority. (updateTags)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

EventLogPublic

Up
get /event-types/failed-login-exist/by-current-user
Check failed login exist by current user (failedLoginExistByCurrentUser)

Return type

HvlResponseBoolean

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseBoolean

Up
post /event-types/page/by-current-user
Gets current user login history. (pageLoginHistoryByCurrentUser)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlLogSearchPage (required)
Body Parameter

Return type

HvlResponseHvlPageHvlEventLogModel

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" : {
    "data" : [ {
      "indexName" : "indexName",
      "attributeMap" : {
        "key" : { }
      },
      "source" : "source",
      "eventType" : "eventType",
      "message" : "message",
      "applicationName" : "applicationName",
      "username" : "username",
      "eventDate" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "indexName" : "indexName",
      "attributeMap" : {
        "key" : { }
      },
      "source" : "source",
      "eventType" : "eventType",
      "message" : "message",
      "applicationName" : "applicationName",
      "username" : "username",
      "eventDate" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlEventLogModel

Up
get /event-types/list
Gets event log type list. (queryList7)

Return type

HvlResponseListHvlOAuthEventLogTypeModel

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" : [ {
    "parameterType" : "parameterType",
    "updatedBy" : "updatedBy",
    "code" : "code",
    "orderNo" : 1,
    "description" : "description",
    "shortDescription" : "shortDescription",
    "uuid" : "uuid",
    "version" : 0,
    "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" : 6
  }, {
    "parameterType" : "parameterType",
    "updatedBy" : "updatedBy",
    "code" : "code",
    "orderNo" : 1,
    "description" : "description",
    "shortDescription" : "shortDescription",
    "uuid" : "uuid",
    "version" : 0,
    "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" : 6
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthEventLogTypeModel

Up
post /event-types/page
Queries event logs according to criteria in query. (queryPage10)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlLogSearchQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlEventLogModel

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" : {
    "data" : [ {
      "indexName" : "indexName",
      "attributeMap" : {
        "key" : { }
      },
      "source" : "source",
      "eventType" : "eventType",
      "message" : "message",
      "applicationName" : "applicationName",
      "username" : "username",
      "eventDate" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "indexName" : "indexName",
      "attributeMap" : {
        "key" : { }
      },
      "source" : "source",
      "eventType" : "eventType",
      "message" : "message",
      "applicationName" : "applicationName",
      "username" : "username",
      "eventDate" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlEventLogModel

GoogleAuthenticatorAPI

Up
post /google-authenticator/disable-google-authenticator
Disables Google Authenticator (disableGoogleAuthenticator)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /google-authenticator/enable-google-authenticator
Enables Google Authenticator (enableGoogleAuthenticator)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /google-authenticator/qr-code
Generates and returns QR code (getQRCode)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseString

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseString

LdapAPI

Up
put /group/entry/add
Adds entry to group (addEntryToGroup)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /ldap/authenticate
Authenticates using with authenticationModel (authenticate)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
delete /ou
Deletes organization unit (delete4)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlLdapBaseModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
delete /group
Deletes ldap group (delete5)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlLdapGroupModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
delete /entry
Deletes ldap entry (delete6)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlLdapEntryModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /entry/by-dn/{dn}
Gets entry by dn (getEntryByDn)

Path parameters

dn (required)
Path Parameter

Return type

HvlResponseHvlLdapEntryModel

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" : {
    "uid" : "uid",
    "firstname" : "firstname",
    "password" : "password",
    "homeDirectory" : "homeDirectory",
    "objectClassList" : [ "objectClassList", "objectClassList" ],
    "surname" : "surname",
    "uidNumber" : "uidNumber",
    "description" : "description",
    "dn" : "dn",
    "cn" : "cn",
    "gidNumber" : "gidNumber",
    "email" : "email"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlLdapEntryModel

Up
get /entry/by-username/{username}
Gets entry by username (getEntryByUsername)

Path parameters

username (required)
Path Parameter

Return type

HvlResponseHvlLdapEntryModel

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" : {
    "uid" : "uid",
    "firstname" : "firstname",
    "password" : "password",
    "homeDirectory" : "homeDirectory",
    "objectClassList" : [ "objectClassList", "objectClassList" ],
    "surname" : "surname",
    "uidNumber" : "uidNumber",
    "description" : "description",
    "dn" : "dn",
    "cn" : "cn",
    "gidNumber" : "gidNumber",
    "email" : "email"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlLdapEntryModel

Up
get /group/by-dn/{dn}
Gets ldap group by dn (getGroupByDn)

Path parameters

dn (required)
Path Parameter

Return type

HvlResponseHvlLdapGroupModel

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" : {
    "objectClassList" : [ "objectClassList", "objectClassList" ],
    "members" : [ {
      "uid" : "uid",
      "firstname" : "firstname",
      "password" : "password",
      "homeDirectory" : "homeDirectory",
      "objectClassList" : [ "objectClassList", "objectClassList" ],
      "surname" : "surname",
      "uidNumber" : "uidNumber",
      "description" : "description",
      "dn" : "dn",
      "cn" : "cn",
      "gidNumber" : "gidNumber",
      "email" : "email"
    }, {
      "uid" : "uid",
      "firstname" : "firstname",
      "password" : "password",
      "homeDirectory" : "homeDirectory",
      "objectClassList" : [ "objectClassList", "objectClassList" ],
      "surname" : "surname",
      "uidNumber" : "uidNumber",
      "description" : "description",
      "dn" : "dn",
      "cn" : "cn",
      "gidNumber" : "gidNumber",
      "email" : "email"
    } ],
    "dn" : "dn",
    "cn" : "cn",
    "gidNumber" : "gidNumber"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlLdapGroupModel

Up
get /group/by-name/{name}
Gets ldap group by name (getGroupByName)

Path parameters

name (required)
Path Parameter

Return type

HvlResponseHvlLdapGroupModel

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" : {
    "objectClassList" : [ "objectClassList", "objectClassList" ],
    "members" : [ {
      "uid" : "uid",
      "firstname" : "firstname",
      "password" : "password",
      "homeDirectory" : "homeDirectory",
      "objectClassList" : [ "objectClassList", "objectClassList" ],
      "surname" : "surname",
      "uidNumber" : "uidNumber",
      "description" : "description",
      "dn" : "dn",
      "cn" : "cn",
      "gidNumber" : "gidNumber",
      "email" : "email"
    }, {
      "uid" : "uid",
      "firstname" : "firstname",
      "password" : "password",
      "homeDirectory" : "homeDirectory",
      "objectClassList" : [ "objectClassList", "objectClassList" ],
      "surname" : "surname",
      "uidNumber" : "uidNumber",
      "description" : "description",
      "dn" : "dn",
      "cn" : "cn",
      "gidNumber" : "gidNumber",
      "email" : "email"
    } ],
    "dn" : "dn",
    "cn" : "cn",
    "gidNumber" : "gidNumber"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlLdapGroupModel

Up
get /ldap/object-class/type/{type}
Gets ldap object class list (getObjectClassListByLdapType)

Path parameters

type (required)
Path Parameter

Return type

HvlResponseListString

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", "body" ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListString

Up
post /ou/list
Gets ou list (getOuList)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlLdapOuQueryModel (required)
Body Parameter

Return type

HvlResponseListHvlLdapOuModel

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" : [ {
    "name" : "name",
    "dn" : "dn",
    "childCount" : 0
  }, {
    "name" : "name",
    "dn" : "dn",
    "childCount" : 0
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlLdapOuModel

Up
post /entry/list
Query ldap entry list (queryEntryList)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlLdapQueryModel (required)
Body Parameter

Return type

HvlResponseListHvlLdapEntryModel

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" : [ {
    "uid" : "uid",
    "firstname" : "firstname",
    "password" : "password",
    "homeDirectory" : "homeDirectory",
    "objectClassList" : [ "objectClassList", "objectClassList" ],
    "surname" : "surname",
    "uidNumber" : "uidNumber",
    "description" : "description",
    "dn" : "dn",
    "cn" : "cn",
    "gidNumber" : "gidNumber",
    "email" : "email"
  }, {
    "uid" : "uid",
    "firstname" : "firstname",
    "password" : "password",
    "homeDirectory" : "homeDirectory",
    "objectClassList" : [ "objectClassList", "objectClassList" ],
    "surname" : "surname",
    "uidNumber" : "uidNumber",
    "description" : "description",
    "dn" : "dn",
    "cn" : "cn",
    "gidNumber" : "gidNumber",
    "email" : "email"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlLdapEntryModel

Up
post /group/list
Query ldap group list (queryGroupList)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlLdapQueryModel (required)
Body Parameter

Return type

HvlResponseListHvlLdapGroupModel

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" : [ {
    "objectClassList" : [ "objectClassList", "objectClassList" ],
    "members" : [ {
      "uid" : "uid",
      "firstname" : "firstname",
      "password" : "password",
      "homeDirectory" : "homeDirectory",
      "objectClassList" : [ "objectClassList", "objectClassList" ],
      "surname" : "surname",
      "uidNumber" : "uidNumber",
      "description" : "description",
      "dn" : "dn",
      "cn" : "cn",
      "gidNumber" : "gidNumber",
      "email" : "email"
    }, {
      "uid" : "uid",
      "firstname" : "firstname",
      "password" : "password",
      "homeDirectory" : "homeDirectory",
      "objectClassList" : [ "objectClassList", "objectClassList" ],
      "surname" : "surname",
      "uidNumber" : "uidNumber",
      "description" : "description",
      "dn" : "dn",
      "cn" : "cn",
      "gidNumber" : "gidNumber",
      "email" : "email"
    } ],
    "dn" : "dn",
    "cn" : "cn",
    "gidNumber" : "gidNumber"
  }, {
    "objectClassList" : [ "objectClassList", "objectClassList" ],
    "members" : [ {
      "uid" : "uid",
      "firstname" : "firstname",
      "password" : "password",
      "homeDirectory" : "homeDirectory",
      "objectClassList" : [ "objectClassList", "objectClassList" ],
      "surname" : "surname",
      "uidNumber" : "uidNumber",
      "description" : "description",
      "dn" : "dn",
      "cn" : "cn",
      "gidNumber" : "gidNumber",
      "email" : "email"
    }, {
      "uid" : "uid",
      "firstname" : "firstname",
      "password" : "password",
      "homeDirectory" : "homeDirectory",
      "objectClassList" : [ "objectClassList", "objectClassList" ],
      "surname" : "surname",
      "uidNumber" : "uidNumber",
      "description" : "description",
      "dn" : "dn",
      "cn" : "cn",
      "gidNumber" : "gidNumber",
      "email" : "email"
    } ],
    "dn" : "dn",
    "cn" : "cn",
    "gidNumber" : "gidNumber"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlLdapGroupModel

Up
put /group/entry/remove
Removes entry from group (removeEntryFromGroup)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body entry_remove_body (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /group/rename
(rename)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlLdapRenameModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /entry/rename
(rename1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlLdapRenameModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /ou/
Saves organization unit (save16)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlLdapOuModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /group/
Saves ldap group (save18)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlLdapGroupModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /entry/
Saves ldap entry (save19)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlLdapEntryModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /ou/
Updates organization unit (update17)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlLdapOuUpdateModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /group/
Updates ldap group (update19)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlLdapGroupUpdateModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /entry/
Updates ldap entry (update20)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlLdapEntryModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

LookupAPI

Up
delete /lookups/by-uuid/{uuid}
Deletes lookup data according to uuid parameter (deleteByUuid17)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /lookups/by-integration-code/{integrationCode}
Gets the lookup with provided integration code (getByIntegrationCode4)

Path parameters

integrationCode (required)
Path Parameter

Return type

HvlResponseHvlOAuthLookupModel

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" : {
    "parameterType" : "parameterType",
    "updatedBy" : "updatedBy",
    "code" : "code",
    "orderNo" : 1,
    "description" : "description",
    "shortDescription" : "shortDescription",
    "uuid" : "uuid",
    "version" : 0,
    "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" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthLookupModel

Up
get /lookups/by-uuid/{uuid}
Gets lookup data according to uuid parameter (getByUuid17)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthLookupModel

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" : {
    "parameterType" : "parameterType",
    "updatedBy" : "updatedBy",
    "code" : "code",
    "orderNo" : 1,
    "description" : "description",
    "shortDescription" : "shortDescription",
    "uuid" : "uuid",
    "version" : 0,
    "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" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthLookupModel

Up
post /lookups/list
Queries list of lookup data (queryList6)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthLookupQueryModel (required)
Body Parameter

Return type

HvlResponseListHvlOAuthLookupModel

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" : [ {
    "parameterType" : "parameterType",
    "updatedBy" : "updatedBy",
    "code" : "code",
    "orderNo" : 1,
    "description" : "description",
    "shortDescription" : "shortDescription",
    "uuid" : "uuid",
    "version" : 0,
    "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" : 6
  }, {
    "parameterType" : "parameterType",
    "updatedBy" : "updatedBy",
    "code" : "code",
    "orderNo" : 1,
    "description" : "description",
    "shortDescription" : "shortDescription",
    "uuid" : "uuid",
    "version" : 0,
    "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" : 6
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthLookupModel

Up
post /lookups/page
Queries lookup data as pageable (queryPage9)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthLookupQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlOAuthLookupModel

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" : {
    "data" : [ {
      "parameterType" : "parameterType",
      "updatedBy" : "updatedBy",
      "code" : "code",
      "orderNo" : 1,
      "description" : "description",
      "shortDescription" : "shortDescription",
      "uuid" : "uuid",
      "version" : 0,
      "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" : 6
    }, {
      "parameterType" : "parameterType",
      "updatedBy" : "updatedBy",
      "code" : "code",
      "orderNo" : 1,
      "description" : "description",
      "shortDescription" : "shortDescription",
      "uuid" : "uuid",
      "version" : 0,
      "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" : 6
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthLookupModel

Up
post /lookups
Saves lookup data (save17)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthLookupModel (required)
Body Parameter

Return type

HvlResponseHvlOAuthLookupModel

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" : {
    "parameterType" : "parameterType",
    "updatedBy" : "updatedBy",
    "code" : "code",
    "orderNo" : 1,
    "description" : "description",
    "shortDescription" : "shortDescription",
    "uuid" : "uuid",
    "version" : 0,
    "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" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthLookupModel

Up
put /lookups
Updates lookup data (update18)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthLookupModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

PasswordRestrictionAPI

Up
delete /user-password-restrictions/by-uuid/{uuid}
Deletes password restriction with with uuid (deleteByUuid2)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /user-password-restrictions/by-uuid/{uuid}
Gets password restriction by given uuid. (getByUuid2)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthPasswordRestrictionModel

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" : {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "blackListedPassword" : "blackListedPassword",
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthPasswordRestrictionModel

Up
post /user-password-restrictions/list
Query password restriction list. (queryList1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseListHvlOAuthPasswordRestrictionModel

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" : [ {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "blackListedPassword" : "blackListedPassword",
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "blackListedPassword" : "blackListedPassword",
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthPasswordRestrictionModel

Up
post /user-password-restrictions/page
Query password restriction page. (queryPage2)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthPasswordRestrictionModel

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" : {
    "data" : [ {
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "updatedBy" : "updatedBy",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "blackListedPassword" : "blackListedPassword",
      "id" : 6,
      "uuid" : "uuid",
      "version" : 0,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "updatedBy" : "updatedBy",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "blackListedPassword" : "blackListedPassword",
      "id" : 6,
      "uuid" : "uuid",
      "version" : 0,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthPasswordRestrictionModel

Up
post /user-password-restrictions
Save password restriction (save2)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthPasswordRestrictionModel

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" : {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "blackListedPassword" : "blackListedPassword",
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthPasswordRestrictionModel

Up
put /user-password-restrictions
Update password restriction (update2)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthPasswordRestrictionModel

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" : {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "blackListedPassword" : "blackListedPassword",
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthPasswordRestrictionModel

PredefinedProxyAPI

Up
delete /predefined-proxies/by-uuid/{uuid}
Deletes predefined proxy with provided uuid (deleteByUuid16)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /predefined-proxies/by-uuid/{uuid}
Gets the predefined proxy with provided uuid (getByUuid16)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthPredefinedProxyModel

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" : {
    "sourceProfileId" : 1,
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "description" : "description",
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthPredefinedProxyModel

Up
post /predefined-proxies/data/page
Queries predefined proxy data as paginated according to criteria in query model (queryDataPage6)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthPredefinedProxyDataModel

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" : {
    "data" : [ {
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "updatedBy" : "updatedBy",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "description" : "description",
      "id" : 5,
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "updatedBy" : "updatedBy",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "description" : "description",
      "id" : 5,
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthPredefinedProxyDataModel

Up
post /predefined-proxies
Saves predefined proxy data (save15)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /predefined-proxies
Updates predefined proxy data (update16)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

PredefinedRoleAPI

Up
delete /predefined-roles/by-uuid/{uuid}
Delete predefined role with provided uuid (deleteByUuid15)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /predefined-roles/by-uuid/{uuid}
Gets the predefined role with provided uuid (getByUuid15)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthPredefinedRoleModel

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" : {
    "userTypeId" : 1,
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "roleId" : 5,
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthPredefinedRoleModel

Up
post /predefined-roles/data/list
Queries predefined roles according to criteria in query model (queryDataList4)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseListHvlOAuthPredefinedRoleDataModel

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" : [ {
    "userTypeId" : 2,
    "updatedBy" : "updatedBy",
    "roleId" : 5,
    "roleEnabled" : true,
    "userTypeDescription" : "userTypeDescription",
    "uuid" : "uuid",
    "version" : 1,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "roleCode" : "roleCode",
    "roleName" : "roleName",
    "id" : 5,
    "roleDescription" : "roleDescription"
  }, {
    "userTypeId" : 2,
    "updatedBy" : "updatedBy",
    "roleId" : 5,
    "roleEnabled" : true,
    "userTypeDescription" : "userTypeDescription",
    "uuid" : "uuid",
    "version" : 1,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "roleCode" : "roleCode",
    "roleName" : "roleName",
    "id" : 5,
    "roleDescription" : "roleDescription"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthPredefinedRoleDataModel

Up
post /predefined-roles/data/page
Queries predefined roles as paginated according to criteria in query model (queryDataPage5)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthPredefinedRoleDataModel

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" : {
    "data" : [ {
      "userTypeId" : 2,
      "updatedBy" : "updatedBy",
      "roleId" : 5,
      "roleEnabled" : true,
      "userTypeDescription" : "userTypeDescription",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "roleCode" : "roleCode",
      "roleName" : "roleName",
      "id" : 5,
      "roleDescription" : "roleDescription"
    }, {
      "userTypeId" : 2,
      "updatedBy" : "updatedBy",
      "roleId" : 5,
      "roleEnabled" : true,
      "userTypeDescription" : "userTypeDescription",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "roleCode" : "roleCode",
      "roleName" : "roleName",
      "id" : 5,
      "roleDescription" : "roleDescription"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthPredefinedRoleDataModel

Up
put /predefined-roles
Update predefined roles (update15)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

ProfileAPI

Up
post /profiles/activate/by-uuid/{uuid}
Activates the profile (activateByUuid2)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /profiles/deactivate/by-uuid/{uuid}
Deactivates the profile (deactivateByUuid2)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
delete /profiles/by-uuid/{uuid}
Deletes profile with provided uuid (deleteByUuid12)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /profiles/data/acquired/list
Gets acquired data list using authenticated session (getAcquiredDataListByUsername)

Return type

HvlResponseListHvlOAuthAcquiredProfileDataModel

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" : [ {
    "profileName" : "profileName",
    "proxyName" : "proxyName",
    "integrationCode" : "integrationCode",
    "combinedProfileDetailName" : [ "combinedProfileDetailName", "combinedProfileDetailName" ],
    "profileId" : 0,
    "proxyUuid" : "proxyUuid"
  }, {
    "profileName" : "profileName",
    "proxyName" : "proxyName",
    "integrationCode" : "integrationCode",
    "combinedProfileDetailName" : [ "combinedProfileDetailName", "combinedProfileDetailName" ],
    "profileId" : 0,
    "proxyUuid" : "proxyUuid"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthAcquiredProfileDataModel

Up
get /profiles/by-integration-code/{integrationCode}
Gets the profile with provided integration code such as citizenship id (getByIntegrationCode2)

Path parameters

integrationCode (required)
Path Parameter

Return type

HvlResponseHvlOAuthProfileModel

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" : {
    "virtual" : true,
    "updatedBy" : "updatedBy",
    "description" : "description",
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "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",
    "profileDetailCopied" : true,
    "name" : "name",
    "id" : 5,
    "user" : {
      "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"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthProfileModel

Up
get /profiles/by-uuid/{uuid}
Gets the profile with provided uuid (getByUuid12)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthProfileModel

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" : {
    "virtual" : true,
    "updatedBy" : "updatedBy",
    "description" : "description",
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "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",
    "profileDetailCopied" : true,
    "name" : "name",
    "id" : 5,
    "user" : {
      "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"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthProfileModel

Up
get /profiles/data/by-uuid/{uuid}
Gets the user data with provided uuid (getDataByUuid)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthProfileDataModel

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" : {
    "virtual" : true,
    "integrationCode" : "integrationCode",
    "name" : "name",
    "description" : "description",
    "id" : 0,
    "uuid" : "uuid",
    "enabled" : true
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthProfileDataModel

Up
get /profiles/id/list/by-profile-group-uuid/{profileGroupUuid}
Gets profile id list according to profile group uuid (getIdListByProfileGroupUuid)

Path parameters

profileGroupUuid (required)
Path Parameter

Return type

HvlResponseListLong

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, 0 ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListLong

Up
get /profiles/data/name/list/by-username/{username}
Queries profile data according to username (getProfileNameListByUsername)

Path parameters

username (required)
Path Parameter

Return type

HvlResponseListHvlOAuthProfileDataModel

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" : [ {
    "virtual" : true,
    "integrationCode" : "integrationCode",
    "name" : "name",
    "description" : "description",
    "id" : 0,
    "uuid" : "uuid",
    "enabled" : true
  }, {
    "virtual" : true,
    "integrationCode" : "integrationCode",
    "name" : "name",
    "description" : "description",
    "id" : 0,
    "uuid" : "uuid",
    "enabled" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthProfileDataModel

Up
get /profiles/exists/by-uuid/{uuid}
Checks if a profile exists according to profileId provided (isExists)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseBoolean

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseBoolean

Up
post /profiles/data/list
Queries profile data according to criteria in query model (queryDataList2)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseListHvlOAuthProfileDataModel

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" : [ {
    "virtual" : true,
    "integrationCode" : "integrationCode",
    "name" : "name",
    "description" : "description",
    "id" : 0,
    "uuid" : "uuid",
    "enabled" : true
  }, {
    "virtual" : true,
    "integrationCode" : "integrationCode",
    "name" : "name",
    "description" : "description",
    "id" : 0,
    "uuid" : "uuid",
    "enabled" : true
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthProfileDataModel

Up
post /profiles/page
Queries profiles as paginated according to criteria in query model (queryPage7)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthProfileModel

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" : {
    "data" : [ {
      "virtual" : true,
      "updatedBy" : "updatedBy",
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "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",
      "profileDetailCopied" : true,
      "name" : "name",
      "id" : 5,
      "user" : {
        "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"
      }
    }, {
      "virtual" : true,
      "updatedBy" : "updatedBy",
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "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",
      "profileDetailCopied" : true,
      "name" : "name",
      "id" : 5,
      "user" : {
        "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"
      }
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthProfileModel

Up
post /profiles/user-data/claim/page
Queries profile user claim data as paginated according to criteria in query model (queryProfileUserClaimDataPage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthProfileUserClaimDataModel

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" : {
    "data" : [ {
      "googleAuthenticatorEnabled" : true,
      "virtual" : true,
      "description" : "description",
      "admin" : true,
      "userFirstName" : "userFirstName",
      "secret" : "secret",
      "uuid" : "uuid",
      "enabled" : true,
      "userTypeCode" : "userTypeCode",
      "system" : true,
      "integrationCode" : "integrationCode",
      "userLastName" : "userLastName",
      "name" : "name",
      "id" : 1,
      "assignedEntityId" : 5,
      "userDetailIntegrationCode" : "userDetailIntegrationCode",
      "tenant" : "tenant",
      "email" : "email",
      "username" : "username",
      "expirationDate" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "googleAuthenticatorEnabled" : true,
      "virtual" : true,
      "description" : "description",
      "admin" : true,
      "userFirstName" : "userFirstName",
      "secret" : "secret",
      "uuid" : "uuid",
      "enabled" : true,
      "userTypeCode" : "userTypeCode",
      "system" : true,
      "integrationCode" : "integrationCode",
      "userLastName" : "userLastName",
      "name" : "name",
      "id" : 1,
      "assignedEntityId" : 5,
      "userDetailIntegrationCode" : "userDetailIntegrationCode",
      "tenant" : "tenant",
      "email" : "email",
      "username" : "username",
      "expirationDate" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthProfileUserClaimDataModel

Up
post /profiles/user-data/page
Queries profile user data as paginated according to criteria in query model (queryProfileUserDataPage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthProfileUserDataModel

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" : {
    "data" : [ {
      "googleAuthenticatorEnabled" : true,
      "virtual" : true,
      "description" : "description",
      "admin" : true,
      "userFirstName" : "userFirstName",
      "secret" : "secret",
      "uuid" : "uuid",
      "enabled" : true,
      "userTypeCode" : "userTypeCode",
      "system" : true,
      "integrationCode" : "integrationCode",
      "userLastName" : "userLastName",
      "name" : "name",
      "id" : 1,
      "userDetailIntegrationCode" : "userDetailIntegrationCode",
      "tenant" : "tenant",
      "email" : "email",
      "username" : "username",
      "expirationDate" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "googleAuthenticatorEnabled" : true,
      "virtual" : true,
      "description" : "description",
      "admin" : true,
      "userFirstName" : "userFirstName",
      "secret" : "secret",
      "uuid" : "uuid",
      "enabled" : true,
      "userTypeCode" : "userTypeCode",
      "system" : true,
      "integrationCode" : "integrationCode",
      "userLastName" : "userLastName",
      "name" : "name",
      "id" : 1,
      "userDetailIntegrationCode" : "userDetailIntegrationCode",
      "tenant" : "tenant",
      "email" : "email",
      "username" : "username",
      "expirationDate" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthProfileUserDataModel

Up
post /profiles/reset/
Reset profile. (resetProfile)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /profiles
Saves profile data (save12)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthProfileModel

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" : {
    "virtual" : true,
    "updatedBy" : "updatedBy",
    "description" : "description",
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "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",
    "profileDetailCopied" : true,
    "name" : "name",
    "id" : 5,
    "user" : {
      "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"
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthProfileModel

Up
put /profiles
Updates profile data (update12)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /profiles/role-profiles
Updates role profiles (updateRoleProfilesRoles)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /profiles/roles
Updates profile roles (updateRoles)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /profiles/roles/by-role-assigner
Updates profile roles by role assigner (updateRolesByRoleAssigner)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /profiles/user-migration/
Migrates profile user to another profile. (userMigrationProfileToProfile)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

ProfileBatchProcessingAPI

Up
post /profiles/batch-process-activate/
Activates profiles through batch process. (activate2)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthzBatchProcessingResultModel

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" : {
    "failCount" : 6,
    "errorModelList" : [ {
      "identifier" : "identifier",
      "error" : "error"
    }, {
      "identifier" : "identifier",
      "error" : "error"
    } ],
    "successCount" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthzBatchProcessingResultModel

Up
post /profiles/batch-process-deactivate/
Deactivates profiles through batch process. (deactivate2)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthzBatchProcessingResultModel

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" : {
    "failCount" : 6,
    "errorModelList" : [ {
      "identifier" : "identifier",
      "error" : "error"
    }, {
      "identifier" : "identifier",
      "error" : "error"
    } ],
    "successCount" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthzBatchProcessingResultModel

Up
post /profiles/batch-process-delete/
Deletes profiles through batch process. (delete3)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthzBatchProcessingResultModel

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" : {
    "failCount" : 6,
    "errorModelList" : [ {
      "identifier" : "identifier",
      "error" : "error"
    }, {
      "identifier" : "identifier",
      "error" : "error"
    } ],
    "successCount" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthzBatchProcessingResultModel

ProfileDetailAPI

Up
delete /profile-details/by-uuid/{uuid}
Deletes profile detail with provided uuid (deleteByUuid14)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /profile-details/by-integration-code/{integrationCode}
Gets the profile detail with provided integration code such as citizenship id (getByIntegrationCode3)

Path parameters

integrationCode (required)
Path Parameter

Return type

HvlResponseHvlOAuthProfileDetailModel

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" : {
    "updatedBy" : "updatedBy",
    "profileDetailType" : {
      "parameterType" : "parameterType",
      "updatedBy" : "updatedBy",
      "code" : "code",
      "orderNo" : 5,
      "description" : "description",
      "shortDescription" : "shortDescription",
      "uuid" : "uuid",
      "version" : 1,
      "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" : 5
    },
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "nameMap" : {
      "key" : {
        "dateCreated" : "2000-01-23T04:56:07.000+00:00",
        "updatedBy" : "updatedBy",
        "deleted" : true,
        "createdBy" : "createdBy",
        "deletedDate" : "2000-01-23T04:56:07.000+00:00",
        "profileDetailId" : 9,
        "name" : "name",
        "id" : 7,
        "locale" : "locale",
        "uuid" : "uuid",
        "version" : 2,
        "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "integrationCode" : "integrationCode",
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "id" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthProfileDetailModel

Up
get /profile-details/by-uuid/{uuid}
Gets the profile detail with provided uuid (getByUuid14)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthProfileDetailModel

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" : {
    "updatedBy" : "updatedBy",
    "profileDetailType" : {
      "parameterType" : "parameterType",
      "updatedBy" : "updatedBy",
      "code" : "code",
      "orderNo" : 5,
      "description" : "description",
      "shortDescription" : "shortDescription",
      "uuid" : "uuid",
      "version" : 1,
      "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" : 5
    },
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "nameMap" : {
      "key" : {
        "dateCreated" : "2000-01-23T04:56:07.000+00:00",
        "updatedBy" : "updatedBy",
        "deleted" : true,
        "createdBy" : "createdBy",
        "deletedDate" : "2000-01-23T04:56:07.000+00:00",
        "profileDetailId" : 9,
        "name" : "name",
        "id" : 7,
        "locale" : "locale",
        "uuid" : "uuid",
        "version" : 2,
        "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "integrationCode" : "integrationCode",
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "id" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthProfileDetailModel

Up
get /profile-details/profile-detail-type/list
Queries profile detail type data (getProfileDetailTypeList)

Return type

HvlResponseListHvlOAuthProfileDetailTypeModel

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" : [ {
    "parameterType" : "parameterType",
    "updatedBy" : "updatedBy",
    "code" : "code",
    "orderNo" : 5,
    "description" : "description",
    "shortDescription" : "shortDescription",
    "uuid" : "uuid",
    "version" : 1,
    "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" : 5
  }, {
    "parameterType" : "parameterType",
    "updatedBy" : "updatedBy",
    "code" : "code",
    "orderNo" : 5,
    "description" : "description",
    "shortDescription" : "shortDescription",
    "uuid" : "uuid",
    "version" : 1,
    "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" : 5
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthProfileDetailTypeModel

Up
post /profile-details/import
Imports a profile data file (importProfileDetails)

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

importFile (optional)
Form Parameter — format: binary

Return type

HvlResponseHvlOAuthzBatchProcessingResultModel

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" : {
    "failCount" : 6,
    "errorModelList" : [ {
      "identifier" : "identifier",
      "error" : "error"
    }, {
      "identifier" : "identifier",
      "error" : "error"
    } ],
    "successCount" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthzBatchProcessingResultModel

Up
post /profile-details/data/claim/list
Queries profile detail claim for assigned entity relation according to criteria in query model (queryClaimDataList)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseListHvlOAuthProfileDetailClaimDataModel

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" : [ {
    "updatedBy" : "updatedBy",
    "hasChildren" : true,
    "typeDescription" : "typeDescription",
    "uuid" : "uuid",
    "version" : 1,
    "parentId" : 2,
    "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",
    "name" : "name",
    "typeId" : 5,
    "id" : 5,
    "assignedEntityId" : 7
  }, {
    "updatedBy" : "updatedBy",
    "hasChildren" : true,
    "typeDescription" : "typeDescription",
    "uuid" : "uuid",
    "version" : 1,
    "parentId" : 2,
    "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",
    "name" : "name",
    "typeId" : 5,
    "id" : 5,
    "assignedEntityId" : 7
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthProfileDetailClaimDataModel

Up
post /profile-details/data/claim/page
Queries profile detail claim for assigned entity relation as paginated according to criteria in query model (queryClaimDataPage4)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthProfileDetailClaimDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "hasChildren" : true,
      "typeDescription" : "typeDescription",
      "uuid" : "uuid",
      "version" : 1,
      "parentId" : 2,
      "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",
      "name" : "name",
      "typeId" : 5,
      "id" : 5,
      "assignedEntityId" : 7
    }, {
      "updatedBy" : "updatedBy",
      "hasChildren" : true,
      "typeDescription" : "typeDescription",
      "uuid" : "uuid",
      "version" : 1,
      "parentId" : 2,
      "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",
      "name" : "name",
      "typeId" : 5,
      "id" : 5,
      "assignedEntityId" : 7
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthProfileDetailClaimDataModel

Up
post /profile-details/data/list
Queries profile details according to criteria in query model (queryDataList3)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseListHvlOAuthProfileDetailDataModel

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" : [ {
    "updatedBy" : "updatedBy",
    "hasChildren" : true,
    "typeDescription" : "typeDescription",
    "uuid" : "uuid",
    "version" : 1,
    "parentId" : 2,
    "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",
    "name" : "name",
    "typeId" : 5,
    "id" : 5
  }, {
    "updatedBy" : "updatedBy",
    "hasChildren" : true,
    "typeDescription" : "typeDescription",
    "uuid" : "uuid",
    "version" : 1,
    "parentId" : 2,
    "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",
    "name" : "name",
    "typeId" : 5,
    "id" : 5
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthProfileDetailDataModel

Up
post /profile-details/data/non-hierarchical/page
Queries non-hierarchical profile details as paginated according to criteria in query model (queryDataNonHierarchicalPage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthProfileDetailDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "hasChildren" : true,
      "typeDescription" : "typeDescription",
      "uuid" : "uuid",
      "version" : 1,
      "parentId" : 2,
      "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",
      "name" : "name",
      "typeId" : 5,
      "id" : 5
    }, {
      "updatedBy" : "updatedBy",
      "hasChildren" : true,
      "typeDescription" : "typeDescription",
      "uuid" : "uuid",
      "version" : 1,
      "parentId" : 2,
      "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",
      "name" : "name",
      "typeId" : 5,
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthProfileDetailDataModel

Up
post /profile-details/data/page
Queries profile details as paginated according to criteria in query model (queryDataPage4)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthProfileDetailDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "hasChildren" : true,
      "typeDescription" : "typeDescription",
      "uuid" : "uuid",
      "version" : 1,
      "parentId" : 2,
      "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",
      "name" : "name",
      "typeId" : 5,
      "id" : 5
    }, {
      "updatedBy" : "updatedBy",
      "hasChildren" : true,
      "typeDescription" : "typeDescription",
      "uuid" : "uuid",
      "version" : 1,
      "parentId" : 2,
      "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",
      "name" : "name",
      "typeId" : 5,
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthProfileDetailDataModel

Up
post /profile-details
Saves profile detail data (save14)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthProfileDetailModel

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" : {
    "updatedBy" : "updatedBy",
    "profileDetailType" : {
      "parameterType" : "parameterType",
      "updatedBy" : "updatedBy",
      "code" : "code",
      "orderNo" : 5,
      "description" : "description",
      "shortDescription" : "shortDescription",
      "uuid" : "uuid",
      "version" : 1,
      "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" : 5
    },
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "nameMap" : {
      "key" : {
        "dateCreated" : "2000-01-23T04:56:07.000+00:00",
        "updatedBy" : "updatedBy",
        "deleted" : true,
        "createdBy" : "createdBy",
        "deletedDate" : "2000-01-23T04:56:07.000+00:00",
        "profileDetailId" : 9,
        "name" : "name",
        "id" : 7,
        "locale" : "locale",
        "uuid" : "uuid",
        "version" : 2,
        "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "integrationCode" : "integrationCode",
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "id" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthProfileDetailModel

Up
put /profile-details
Updates profile detail data (update14)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthProfileDetailModel

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" : {
    "updatedBy" : "updatedBy",
    "profileDetailType" : {
      "parameterType" : "parameterType",
      "updatedBy" : "updatedBy",
      "code" : "code",
      "orderNo" : 5,
      "description" : "description",
      "shortDescription" : "shortDescription",
      "uuid" : "uuid",
      "version" : 1,
      "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" : 5
    },
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "nameMap" : {
      "key" : {
        "dateCreated" : "2000-01-23T04:56:07.000+00:00",
        "updatedBy" : "updatedBy",
        "deleted" : true,
        "createdBy" : "createdBy",
        "deletedDate" : "2000-01-23T04:56:07.000+00:00",
        "profileDetailId" : 9,
        "name" : "name",
        "id" : 7,
        "locale" : "locale",
        "uuid" : "uuid",
        "version" : 2,
        "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
      }
    },
    "integrationCode" : "integrationCode",
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "id" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthProfileDetailModel

ProfileGroupAPI

Up
post /profile-groups/activate/by-uuid/{uuid}
Activates the profile group (activateByUuid3)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /profile-groups/deactivate/by-uuid/{uuid}
Deactivates the profile group (deactivateByUuid3)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
delete /profile-groups/by-uuid/{uuid}
Deletes profie group with provided uuid (deleteByUuid13)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /profile-groups/by-uuid/{uuid}
Gets the profile group with provided uuid (getByUuid13)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthProfileGroupModel

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" : {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "description" : "description",
    "id" : 5,
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthProfileGroupModel

Up
post /profile-groups/data/claim/page
Queries profile group claim for assigned entity relation as paginated according to criteria in query model (queryClaimDataPage3)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthProfileGroupClaimNodeModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "description" : "description",
      "roleGroupName" : "roleGroupName",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5,
      "assignedEntityId" : 5
    }, {
      "updatedBy" : "updatedBy",
      "description" : "description",
      "roleGroupName" : "roleGroupName",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5,
      "assignedEntityId" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthProfileGroupClaimNodeModel

Up
post /profile-groups/list
Queries profile groups according to criteria in query model (queryList5)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseListHvlOAuthProfileGroupModel

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" : [ {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "description" : "description",
    "id" : 5,
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "description" : "description",
    "id" : 5,
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthProfileGroupModel

Up
post /profile-groups/page
Queries profile groups as paginated according to criteria in query model (queryPage8)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthProfileGroupModel

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" : {
    "data" : [ {
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "updatedBy" : "updatedBy",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "description" : "description",
      "id" : 5,
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "updatedBy" : "updatedBy",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "description" : "description",
      "id" : 5,
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthProfileGroupModel

Up
post /profile-groups/admin/data/report/page
Queries profile groups report as paginated according to criteria in report query model by admin (queryReportByAdminDataPage3)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthReportQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlOAuthProfileGroupDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "description" : "description",
      "roleGroupName" : "roleGroupName",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5
    }, {
      "updatedBy" : "updatedBy",
      "description" : "description",
      "roleGroupName" : "roleGroupName",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthProfileGroupDataModel

Up
post /profile-groups/data/report/page
Queries profile groups report as paginated according to criteria in report query model (queryReportDataPage3)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthReportQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlOAuthProfileGroupDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "description" : "description",
      "roleGroupName" : "roleGroupName",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5
    }, {
      "updatedBy" : "updatedBy",
      "description" : "description",
      "roleGroupName" : "roleGroupName",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthProfileGroupDataModel

Up
post /profile-groups
Saves profile group data (save13)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /profile-groups
Updates profile group data (update13)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /profile-groups/roles
Updates profile group roles (updateRoles1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

ProxyAPI

Up
delete /proxies/by-uuid/{uuid}
Deletes proxy with provided uuid (deleteByUuid10)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /proxies/by-uuid/{uuid}
Gets the proxy with provided uuid (getByUuid10)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthProxyModel

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" : {
    "sourceProfileId" : 1,
    "updatedBy" : "updatedBy",
    "trustedProxyId" : 5,
    "endDate" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "targetUserId" : 5,
    "sourceProfileUserUsername" : "sourceProfileUserUsername",
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "targetUserUsername" : "targetUserUsername",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "integrationCode" : "integrationCode",
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "id" : 6,
    "startDate" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthProxyModel

Up
post /proxies/data/borrowed/page
Queries borrowed proxy data as paginated according to criteria in query model (queryBorrowedDataPage1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthProxyQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlOAuthProxyDataModel

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" : {
    "data" : [ {
      "sourceProfileId" : 5,
      "sourceUserSurname" : "sourceUserSurname",
      "updatedBy" : "updatedBy",
      "trustedProxyId" : 7,
      "sourceUserName" : "sourceUserName",
      "endDate" : "2000-01-23T04:56:07.000+00:00",
      "targetUserSurname" : "targetUserSurname",
      "description" : "description",
      "targetUserId" : 2,
      "sourceProfileUserUsername" : "sourceProfileUserUsername",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "targetUserUsername" : "targetUserUsername",
      "targetUserName" : "targetUserName",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "integrationCode" : "integrationCode",
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5,
      "startDate" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "sourceProfileId" : 5,
      "sourceUserSurname" : "sourceUserSurname",
      "updatedBy" : "updatedBy",
      "trustedProxyId" : 7,
      "sourceUserName" : "sourceUserName",
      "endDate" : "2000-01-23T04:56:07.000+00:00",
      "targetUserSurname" : "targetUserSurname",
      "description" : "description",
      "targetUserId" : 2,
      "sourceProfileUserUsername" : "sourceProfileUserUsername",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "targetUserUsername" : "targetUserUsername",
      "targetUserName" : "targetUserName",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "integrationCode" : "integrationCode",
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5,
      "startDate" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthProxyDataModel

Up
post /proxies/data/delegated/page
Queries delegated proxy data as paginated according to criteria in query model (queryDelegatedDataPage1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthProxyQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlOAuthProxyDataModel

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" : {
    "data" : [ {
      "sourceProfileId" : 5,
      "sourceUserSurname" : "sourceUserSurname",
      "updatedBy" : "updatedBy",
      "trustedProxyId" : 7,
      "sourceUserName" : "sourceUserName",
      "endDate" : "2000-01-23T04:56:07.000+00:00",
      "targetUserSurname" : "targetUserSurname",
      "description" : "description",
      "targetUserId" : 2,
      "sourceProfileUserUsername" : "sourceProfileUserUsername",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "targetUserUsername" : "targetUserUsername",
      "targetUserName" : "targetUserName",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "integrationCode" : "integrationCode",
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5,
      "startDate" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "sourceProfileId" : 5,
      "sourceUserSurname" : "sourceUserSurname",
      "updatedBy" : "updatedBy",
      "trustedProxyId" : 7,
      "sourceUserName" : "sourceUserName",
      "endDate" : "2000-01-23T04:56:07.000+00:00",
      "targetUserSurname" : "targetUserSurname",
      "description" : "description",
      "targetUserId" : 2,
      "sourceProfileUserUsername" : "sourceProfileUserUsername",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "targetUserUsername" : "targetUserUsername",
      "targetUserName" : "targetUserName",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "integrationCode" : "integrationCode",
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5,
      "startDate" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthProxyDataModel

Up
post /proxies
Saves proxy data (save10)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /proxies/from-trusted-proxy
Saves proxy data from trusted proxy data (saveFromTrustedProxy)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /proxies
Updates proxy data (update10)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

ProxyAdminAPI

Up
delete /proxies-admin/by-uuid/{uuid}
Deletes proxy with provided uuid (deleteByUuid11)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /proxies-admin/by-uuid/{uuid}
Gets the proxy with provided uuid (getByUuid11)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthProxyModel

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" : {
    "sourceProfileId" : 1,
    "updatedBy" : "updatedBy",
    "trustedProxyId" : 5,
    "endDate" : "2000-01-23T04:56:07.000+00:00",
    "description" : "description",
    "targetUserId" : 5,
    "sourceProfileUserUsername" : "sourceProfileUserUsername",
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "targetUserUsername" : "targetUserUsername",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "integrationCode" : "integrationCode",
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "id" : 6,
    "startDate" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthProxyModel

Up
post /proxies-admin/data/page
Queries proxy data as paginated according to criteria in query model (queryDataPage3)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthProxyQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlOAuthProxyDataModel

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" : {
    "data" : [ {
      "sourceProfileId" : 5,
      "sourceUserSurname" : "sourceUserSurname",
      "updatedBy" : "updatedBy",
      "trustedProxyId" : 7,
      "sourceUserName" : "sourceUserName",
      "endDate" : "2000-01-23T04:56:07.000+00:00",
      "targetUserSurname" : "targetUserSurname",
      "description" : "description",
      "targetUserId" : 2,
      "sourceProfileUserUsername" : "sourceProfileUserUsername",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "targetUserUsername" : "targetUserUsername",
      "targetUserName" : "targetUserName",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "integrationCode" : "integrationCode",
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5,
      "startDate" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "sourceProfileId" : 5,
      "sourceUserSurname" : "sourceUserSurname",
      "updatedBy" : "updatedBy",
      "trustedProxyId" : 7,
      "sourceUserName" : "sourceUserName",
      "endDate" : "2000-01-23T04:56:07.000+00:00",
      "targetUserSurname" : "targetUserSurname",
      "description" : "description",
      "targetUserId" : 2,
      "sourceProfileUserUsername" : "sourceProfileUserUsername",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "targetUserUsername" : "targetUserUsername",
      "targetUserName" : "targetUserName",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "integrationCode" : "integrationCode",
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5,
      "startDate" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthProxyDataModel

Up
post /proxies-admin/admin/data/report/page
Queries proxy report data as paginated according to criteria in report query model by admin. (queryReportByAdminDataPage2)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthReportQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlOAuthProxyDataModel

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" : {
    "data" : [ {
      "sourceProfileId" : 5,
      "sourceUserSurname" : "sourceUserSurname",
      "updatedBy" : "updatedBy",
      "trustedProxyId" : 7,
      "sourceUserName" : "sourceUserName",
      "endDate" : "2000-01-23T04:56:07.000+00:00",
      "targetUserSurname" : "targetUserSurname",
      "description" : "description",
      "targetUserId" : 2,
      "sourceProfileUserUsername" : "sourceProfileUserUsername",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "targetUserUsername" : "targetUserUsername",
      "targetUserName" : "targetUserName",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "integrationCode" : "integrationCode",
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5,
      "startDate" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "sourceProfileId" : 5,
      "sourceUserSurname" : "sourceUserSurname",
      "updatedBy" : "updatedBy",
      "trustedProxyId" : 7,
      "sourceUserName" : "sourceUserName",
      "endDate" : "2000-01-23T04:56:07.000+00:00",
      "targetUserSurname" : "targetUserSurname",
      "description" : "description",
      "targetUserId" : 2,
      "sourceProfileUserUsername" : "sourceProfileUserUsername",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "targetUserUsername" : "targetUserUsername",
      "targetUserName" : "targetUserName",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "integrationCode" : "integrationCode",
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5,
      "startDate" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthProxyDataModel

Up
post /proxies-admin/data/report/page
Queries proxy report data as paginated according to criteria in report query model (queryReportDataPage2)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthReportQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlOAuthProxyDataModel

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" : {
    "data" : [ {
      "sourceProfileId" : 5,
      "sourceUserSurname" : "sourceUserSurname",
      "updatedBy" : "updatedBy",
      "trustedProxyId" : 7,
      "sourceUserName" : "sourceUserName",
      "endDate" : "2000-01-23T04:56:07.000+00:00",
      "targetUserSurname" : "targetUserSurname",
      "description" : "description",
      "targetUserId" : 2,
      "sourceProfileUserUsername" : "sourceProfileUserUsername",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "targetUserUsername" : "targetUserUsername",
      "targetUserName" : "targetUserName",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "integrationCode" : "integrationCode",
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5,
      "startDate" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "sourceProfileId" : 5,
      "sourceUserSurname" : "sourceUserSurname",
      "updatedBy" : "updatedBy",
      "trustedProxyId" : 7,
      "sourceUserName" : "sourceUserName",
      "endDate" : "2000-01-23T04:56:07.000+00:00",
      "targetUserSurname" : "targetUserSurname",
      "description" : "description",
      "targetUserId" : 2,
      "sourceProfileUserUsername" : "sourceProfileUserUsername",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "targetUserUsername" : "targetUserUsername",
      "targetUserName" : "targetUserName",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "integrationCode" : "integrationCode",
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5,
      "startDate" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthProxyDataModel

Up
post /proxies-admin
Saves proxy data (save11)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /proxies-admin/from-trusted-proxy
Saves proxy data from trusted proxy data (saveFromTrustedProxy1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /proxies-admin
Updates proxy data (update11)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

RegistrationAPI

Up
post /registration/complete-registration
Complete registration (completeRegistration)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseBoolean

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseBoolean

Up
post /registration/register
The method that provides the user to register via email. (register)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /registration/verify-registered-user
The method that verifies the user with mail and code. (verifyRegisteredUser)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseBoolean

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseBoolean

RoleAPI

Up
post /roles/activate/by-uuid/{uuid}
Activates the role (activateByUuid)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /roles/deactivate/by-uuid/{uuid}
Deactivates the role (deactivateByUuid)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
delete /roles/by-uuid/{uuid}
Deletes role with provided uuid (deleteByUuid8)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /roles/by-uuid/{uuid}
Gets the role with provided uuid (getByUuid8)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthRoleModel

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" : {
    "updatedBy" : "updatedBy",
    "code" : "code",
    "description" : "description",
    "uuid" : "uuid",
    "version" : 0,
    "proxyable" : true,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "hierarchical" : true,
    "name" : "name",
    "id" : 6
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthRoleModel

Up
post /roles/data/assigner/page
Queries roles as paginated according to criteria in query model (queryAssignerDataPage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthRoleQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlOAuthRoleDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "editable" : true,
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "proxyable" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "hierarchical" : true,
      "name" : "name",
      "id" : 5
    }, {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "editable" : true,
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "proxyable" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "hierarchical" : true,
      "name" : "name",
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthRoleDataModel

Up
post /roles/data/claim/page
Queries role claim for assigned entity relation as paginated according to criteria in query model (queryClaimDataPage1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthRoleClaimDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "editable" : true,
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "proxyable" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "hierarchical" : true,
      "name" : "name",
      "id" : 5,
      "assignedEntityId" : 5
    }, {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "editable" : true,
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "proxyable" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "hierarchical" : true,
      "name" : "name",
      "id" : 5,
      "assignedEntityId" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthRoleClaimDataModel

Up
post /roles/data/list
Queries roles according to criteria in query model (queryDataList)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthRoleQueryModel (required)
Body Parameter

Return type

HvlResponseListHvlOAuthRoleDataModel

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" : [ {
    "updatedBy" : "updatedBy",
    "code" : "code",
    "editable" : true,
    "description" : "description",
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "proxyable" : true,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "hierarchical" : true,
    "name" : "name",
    "id" : 5
  }, {
    "updatedBy" : "updatedBy",
    "code" : "code",
    "editable" : true,
    "description" : "description",
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "proxyable" : true,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "hierarchical" : true,
    "name" : "name",
    "id" : 5
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthRoleDataModel

Up
post /roles/data/page
Queries roles as paginated according to criteria in query model (queryDataPage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthRoleQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlOAuthRoleDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "editable" : true,
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "proxyable" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "hierarchical" : true,
      "name" : "name",
      "id" : 5
    }, {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "editable" : true,
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "proxyable" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "hierarchical" : true,
      "name" : "name",
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthRoleDataModel

Up
post /roles/admin/data/report/page
Queries roles report as paginated according to criteria in report query model by admin (queryReportByAdminDataPage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthReportQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlOAuthRoleDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "editable" : true,
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "proxyable" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "hierarchical" : true,
      "name" : "name",
      "id" : 5
    }, {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "editable" : true,
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "proxyable" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "hierarchical" : true,
      "name" : "name",
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthRoleDataModel

Up
post /roles/data/report/page
Queries roles report as paginated according to criteria in report query model (queryReportDataPage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthReportQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlOAuthRoleDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "editable" : true,
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "proxyable" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "hierarchical" : true,
      "name" : "name",
      "id" : 5
    }, {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "editable" : true,
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "proxyable" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "hierarchical" : true,
      "name" : "name",
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthRoleDataModel

Up
post /roles/save
Saves role data (save8)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /roles/update
Updates role data (update8)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthRolePersistModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

RoleAssignerAPI

Up
get /role-assigners/data/list
Queries role assigner (getDataList)

Return type

HvlResponseListHvlOAuthRoleDataModel

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" : [ {
    "updatedBy" : "updatedBy",
    "code" : "code",
    "editable" : true,
    "description" : "description",
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "proxyable" : true,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "hierarchical" : true,
    "name" : "name",
    "id" : 5
  }, {
    "updatedBy" : "updatedBy",
    "code" : "code",
    "editable" : true,
    "description" : "description",
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "proxyable" : true,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "hierarchical" : true,
    "name" : "name",
    "id" : 5
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthRoleDataModel

Up
post /role-assigners/data/page
Queries roles as paginated according to criteria in query model (queryDataPage2)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthRoleDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "editable" : true,
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "proxyable" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "hierarchical" : true,
      "name" : "name",
      "id" : 5
    }, {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "editable" : true,
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "proxyable" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "hierarchical" : true,
      "name" : "name",
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthRoleDataModel

Up
put /role-assigners/update
Update role assigner relations (updateRoleAssignerRelations)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

RoleBatchProcessingAPI

Up
post /roles/batch-process-activate/
Activates roles through batch process. (activate1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthzBatchProcessingResultModel

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" : {
    "failCount" : 6,
    "errorModelList" : [ {
      "identifier" : "identifier",
      "error" : "error"
    }, {
      "identifier" : "identifier",
      "error" : "error"
    } ],
    "successCount" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthzBatchProcessingResultModel

Up
post /roles/batch-process-deactivate/
Deactivates roles through batch process. (deactivate1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthzBatchProcessingResultModel

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" : {
    "failCount" : 6,
    "errorModelList" : [ {
      "identifier" : "identifier",
      "error" : "error"
    }, {
      "identifier" : "identifier",
      "error" : "error"
    } ],
    "successCount" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthzBatchProcessingResultModel

Up
post /roles/batch-process-delete/
Deletes roles through batch process. (delete2)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthzBatchProcessingResultModel

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" : {
    "failCount" : 6,
    "errorModelList" : [ {
      "identifier" : "identifier",
      "error" : "error"
    }, {
      "identifier" : "identifier",
      "error" : "error"
    } ],
    "successCount" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthzBatchProcessingResultModel

RoleGroupAPI

Up
post /role-groups/activate/by-uuid/{uuid}
Activates the role group (activateByUuid1)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /role-groups/deactivate/by-uuid/{uuid}
Deactivates the role group (deactivateByUuid1)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
delete /role-groups/by-uuid/{uuid}
Deletes role group with provided uuid (deleteByUuid9)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /role-groups/by-uuid/{uuid}
Gets the role group with provided uuid (getByUuid9)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthRoleGroupModel

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" : {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "code" : "code",
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "description" : "description",
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthRoleGroupModel

Up
post /role-groups/data/claim/page
Queries role group claim for assigned entity relation as paginated according to criteria in query model (queryClaimDataPage2)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthRoleGroupClaimDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "id" : 5,
      "assignedEntityId" : 5
    }, {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "id" : 5,
      "assignedEntityId" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthRoleGroupClaimDataModel

Up
post /role-groups/data/list
Queries role groups according to criteria in query model (queryDataList1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseListHvlOAuthRoleGroupDataModel

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" : [ {
    "updatedBy" : "updatedBy",
    "code" : "code",
    "description" : "description",
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "roleName" : "roleName",
    "id" : 5
  }, {
    "updatedBy" : "updatedBy",
    "code" : "code",
    "description" : "description",
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "roleName" : "roleName",
    "id" : 5
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthRoleGroupDataModel

Up
post /role-groups/data/page
Queries role groups as paginated according to criteria in query model (queryDataPage1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthRoleGroupDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5
    }, {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthRoleGroupDataModel

Up
post /role-groups/admin/data/report/page
Queries role groups report as paginated according to criteria in report query model by admin (queryReportByAdminDataPage1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthReportQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlOAuthRoleGroupDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5
    }, {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthRoleGroupDataModel

Up
post /role-groups/data/report/page
Queries role groups report as paginated according to criteria in report query model (queryReportDataPage1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthReportQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlOAuthRoleGroupDataModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5
    }, {
      "updatedBy" : "updatedBy",
      "code" : "code",
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "roleName" : "roleName",
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthRoleGroupDataModel

Up
post /role-groups
Saves role group data (save9)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /role-groups
Updates role group data (update9)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

SessionAPI

Up
post /session/fill-with-authority
Fill session with acquired roles of profile (fillWithAuthority)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthSessionModel

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" : {
    "hasProxiedProfile" : true,
    "googleAuthenticatorEnabled" : true,
    "profileIdentity" : "profileIdentity",
    "authorityCodeSet" : [ "authorityCodeSet", "authorityCodeSet" ],
    "userIntegrationId" : "userIntegrationId",
    "profileIntegrationCode" : "profileIntegrationCode",
    "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
    },
    "secret" : "secret",
    "email" : "email",
    "username" : "username",
    "tenantIdentifier" : "tenantIdentifier"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthSessionModel

Up
get /session/user-info
Gets current user info data (getUserInfo)

Query parameters

userInfoPredicateModel (required)
Query Parameter

Return type

HvlResponseHvlOAuthUserInfoDataModel

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" : {
    "profileInfoDataModelList" : [ {
      "profileName" : "profileName",
      "proxyName" : "proxyName",
      "integrationCode" : "integrationCode",
      "combinedProfileDetailName" : [ "combinedProfileDetailName", "combinedProfileDetailName" ],
      "profileId" : 0,
      "proxyUuid" : "proxyUuid"
    }, {
      "profileName" : "profileName",
      "proxyName" : "proxyName",
      "integrationCode" : "integrationCode",
      "combinedProfileDetailName" : [ "combinedProfileDetailName", "combinedProfileDetailName" ],
      "profileId" : 0,
      "proxyUuid" : "proxyUuid"
    } ],
    "roleGroupInfoDataModelList" : [ {
      "profileId" : 2,
      "roleGroupUuid" : "roleGroupUuid",
      "roleGroupName" : "roleGroupName",
      "roleGroupId" : 7
    }, {
      "profileId" : 2,
      "roleGroupUuid" : "roleGroupUuid",
      "roleGroupName" : "roleGroupName",
      "roleGroupId" : 7
    } ],
    "profileGroupInfoDataModelList" : [ {
      "profileGroupName" : "profileGroupName",
      "profileGroupUuid" : "profileGroupUuid",
      "profileId" : 5
    }, {
      "profileGroupName" : "profileGroupName",
      "profileGroupUuid" : "profileGroupUuid",
      "profileId" : 5
    } ],
    "userDetailInfoDataModelList" : [ {
      "personalIdentifier" : "personalIdentifier",
      "userDetailUuid" : "userDetailUuid",
      "integrationCode" : "integrationCode",
      "surname" : "surname",
      "mobileNumber" : "mobileNumber",
      "name" : "name",
      "email" : "email"
    }, {
      "personalIdentifier" : "personalIdentifier",
      "userDetailUuid" : "userDetailUuid",
      "integrationCode" : "integrationCode",
      "surname" : "surname",
      "mobileNumber" : "mobileNumber",
      "name" : "name",
      "email" : "email"
    } ],
    "roleInfoDataModelList" : [ {
      "profileId" : 5,
      "roleCode" : "roleCode",
      "roleName" : "roleName",
      "proxyUuid" : "proxyUuid",
      "roleUuid" : "roleUuid"
    }, {
      "profileId" : 5,
      "roleCode" : "roleCode",
      "roleName" : "roleName",
      "proxyUuid" : "proxyUuid",
      "roleUuid" : "roleUuid"
    } ],
    "username" : "username",
    "profileDetailInfoDataModelList" : [ {
      "integrationCode" : "integrationCode",
      "profileGroupUuid" : "profileGroupUuid",
      "profileDetailTypeId" : 6,
      "profileId" : 1,
      "proxyUuid" : "proxyUuid",
      "profileDetailUuid" : "profileDetailUuid",
      "profileDetailName" : "profileDetailName"
    }, {
      "integrationCode" : "integrationCode",
      "profileGroupUuid" : "profileGroupUuid",
      "profileDetailTypeId" : 6,
      "profileId" : 1,
      "proxyUuid" : "proxyUuid",
      "profileDetailUuid" : "profileDetailUuid",
      "profileDetailName" : "profileDetailName"
    } ]
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthUserInfoDataModel

SystemUserAPI

Up
delete /system-users/by-uuid/{uuid}
Deletes system user with provided uuid (deleteByUuid7)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /system-users/by-uuid/{uuid}
Gets the system user with provided uuid (getByUuid7)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthSystemUserModel

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" : {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "apiKey" : "apiKey",
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "profile" : {
      "virtual" : true,
      "updatedBy" : "updatedBy",
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "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",
      "profileDetailCopied" : true,
      "name" : "name",
      "id" : 5,
      "user" : {
        "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"
      }
    },
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthSystemUserModel

Up
post /system-users/list
Saves system user data (queryList4)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseListHvlOAuthSystemUserModel

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" : [ {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "apiKey" : "apiKey",
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "profile" : {
      "virtual" : true,
      "updatedBy" : "updatedBy",
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "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",
      "profileDetailCopied" : true,
      "name" : "name",
      "id" : 5,
      "user" : {
        "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"
      }
    },
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "apiKey" : "apiKey",
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "profile" : {
      "virtual" : true,
      "updatedBy" : "updatedBy",
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "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",
      "profileDetailCopied" : true,
      "name" : "name",
      "id" : 5,
      "user" : {
        "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"
      }
    },
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthSystemUserModel

Up
post /system-users/page
Queries system users as paginated according to criteria in query model (queryPage6)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthSystemUserModel

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" : {
    "data" : [ {
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "updatedBy" : "updatedBy",
      "deleted" : true,
      "apiKey" : "apiKey",
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "profile" : {
        "virtual" : true,
        "updatedBy" : "updatedBy",
        "description" : "description",
        "uuid" : "uuid",
        "version" : 1,
        "enabled" : true,
        "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",
        "profileDetailCopied" : true,
        "name" : "name",
        "id" : 5,
        "user" : {
          "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"
        }
      },
      "id" : 6,
      "uuid" : "uuid",
      "version" : 0,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "updatedBy" : "updatedBy",
      "deleted" : true,
      "apiKey" : "apiKey",
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "profile" : {
        "virtual" : true,
        "updatedBy" : "updatedBy",
        "description" : "description",
        "uuid" : "uuid",
        "version" : 1,
        "enabled" : true,
        "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",
        "profileDetailCopied" : true,
        "name" : "name",
        "id" : 5,
        "user" : {
          "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"
        }
      },
      "id" : 6,
      "uuid" : "uuid",
      "version" : 0,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthSystemUserModel

Up
post /system-users
Saves system user data (save7)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthSystemUserModel (required)
Body Parameter

Return type

HvlResponseHvlOAuthSystemUserModel

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" : {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "apiKey" : "apiKey",
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "profile" : {
      "virtual" : true,
      "updatedBy" : "updatedBy",
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "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",
      "profileDetailCopied" : true,
      "name" : "name",
      "id" : 5,
      "user" : {
        "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"
      }
    },
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthSystemUserModel

Up
put /system-users
Update system user data (update7)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthSystemUserModel (required)
Body Parameter

Return type

HvlResponseHvlOAuthSystemUserModel

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" : {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "apiKey" : "apiKey",
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "profile" : {
      "virtual" : true,
      "updatedBy" : "updatedBy",
      "description" : "description",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "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",
      "profileDetailCopied" : true,
      "name" : "name",
      "id" : 5,
      "user" : {
        "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"
      }
    },
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthSystemUserModel

TagAPI

Up
delete /tags/by-uuid/{uuid}
Deletes tag with with uuid (deleteByUuid6)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /tags/by-uuid/{uuid}
Gets tag by given uuid. (getByUuid6)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthTagModel

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" : {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthTagModel

Up
post /tags/list
Query tag list. (queryList3)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthTagQueryModel (required)
Body Parameter

Return type

HvlResponseListHvlOAuthTagModel

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" : [ {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthTagModel

Up
post /tags/page
Query tag page. (queryPage5)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthTagQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlOAuthTagModel

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" : {
    "data" : [ {
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "updatedBy" : "updatedBy",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "id" : 6,
      "uuid" : "uuid",
      "version" : 0,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "updatedBy" : "updatedBy",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "id" : 6,
      "uuid" : "uuid",
      "version" : 0,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthTagModel

Up
post /tags
Save tag (save6)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthTagModel (required)
Body Parameter

Return type

HvlResponseHvlOAuthTagModel

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" : {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthTagModel

Up
put /tags
Update tag (update6)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthTagModel (required)
Body Parameter

Return type

HvlResponseHvlOAuthTagModel

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" : {
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthTagModel

TrustedProxyAPI

Up
delete /trusted-proxies/by-uuid/{uuid}
Deletes trusted proxy with provided uuid (deleteByUuid5)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
delete /trusted-proxies/delete/by-uuid/{uuid}
Deletes trusted proxy that belongs to current user by uuid (deleteTrustedProxyBelongsToCurrentUserByUuid)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /trusted-proxies/by-uuid/{uuid}
Gets the trusted proxy with provided uuid (getByUuid5)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthTrustedProxyModel

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" : {
    "sourceProfileId" : 1,
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "updatedBy" : "updatedBy",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "name" : "name",
    "id" : 6,
    "uuid" : "uuid",
    "version" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthTrustedProxyModel

Up
post /trusted-proxies/data/borrowed/page
Queries borrowed trusted proxy data as paginated according to criteria in query model (queryBorrowedDataPage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthTrustedProxyDataModel

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" : {
    "data" : [ {
      "sourceUserSurname" : "sourceUserSurname",
      "updatedBy" : "updatedBy",
      "sourceUserName" : "sourceUserName",
      "sourceUserUsername" : "sourceUserUsername",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "id" : 5
    }, {
      "sourceUserSurname" : "sourceUserSurname",
      "updatedBy" : "updatedBy",
      "sourceUserName" : "sourceUserName",
      "sourceUserUsername" : "sourceUserUsername",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthTrustedProxyDataModel

Up
post /trusted-proxies/data/delegated/page
Queries delegated trusted proxy data as paginated according to criteria in query model (queryDelegatedDataPage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthTrustedProxyDataModel

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" : {
    "data" : [ {
      "sourceUserSurname" : "sourceUserSurname",
      "updatedBy" : "updatedBy",
      "sourceUserName" : "sourceUserName",
      "sourceUserUsername" : "sourceUserUsername",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "id" : 5
    }, {
      "sourceUserSurname" : "sourceUserSurname",
      "updatedBy" : "updatedBy",
      "sourceUserName" : "sourceUserName",
      "sourceUserUsername" : "sourceUserUsername",
      "uuid" : "uuid",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "id" : 5
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthTrustedProxyDataModel

Up
post /trusted-proxies
Saves trusted proxy data (save5)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /trusted-proxies
Updates trusted proxy data (update5)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

UserAPI

Up
put /users/password
Updates user's password data (changePassword)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /users/password-by-admin
Updates user's password data by admin (changePasswordByAdmin)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /users/password-with-verification
Updates user's password data using verification way (changePasswordUsingVerification)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
delete /users/by-uuid/{uuid}
Deletes user with provided uuid (deleteByUuid)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /users/by-code/{code}
Gets the user with provided integration code such as citizenship id (getByIntegrationCode)

Path parameters

code (required)
Path Parameter

Return type

HvlResponseHvlOAuthUserModel

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" : {
    "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"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthUserModel

Up
get /users/by-username/{username}
Gets the user with provided username (getByUsername)

Path parameters

username (required)
Path Parameter

Return type

HvlResponseHvlOAuthUserModel

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" : {
    "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"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthUserModel

Up
get /users/by-uuid/{uuid}
Gets the user with provided uuid (getByUuid)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthUserModel

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" : {
    "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"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthUserModel

Up
put /users/lock
Lock user (lock)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthUserLockModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /users/data/claim/page
Queries user claim for assigned entity relation as paginated according to criteria in query model (queryClaimDataPage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthUserClaimDataModel

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" : {
    "data" : [ {
      "admin" : true,
      "description" : "description",
      "dn" : "dn",
      "uuid" : "uuid",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "expired" : true,
      "surname" : "surname",
      "passwordUpdatedDate" : "2000-01-23T04:56:07.000+00:00",
      "id" : 5,
      "locked" : true,
      "tenant" : "tenant",
      "email" : "email",
      "expirationDate" : "2000-01-23T04:56:07.000+00:00",
      "userRegistrationSourceType" : "ADMIN_REGISTRATION",
      "updatedBy" : "updatedBy",
      "userDetailDataModel" : {
        "updatedBy" : "updatedBy",
        "mobileNumber" : "mobileNumber",
        "uuid" : "uuid",
        "version" : 7,
        "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",
        "surname" : "surname",
        "name" : "name",
        "id" : 9,
        "email" : "email",
        "userTypeDataModel" : {
          "code" : "code",
          "description" : "description"
        }
      },
      "lockedDate" : "2000-01-23T04:56:07.000+00:00",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "system" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "assignedEntityId" : 5,
      "username" : "username"
    }, {
      "admin" : true,
      "description" : "description",
      "dn" : "dn",
      "uuid" : "uuid",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "expired" : true,
      "surname" : "surname",
      "passwordUpdatedDate" : "2000-01-23T04:56:07.000+00:00",
      "id" : 5,
      "locked" : true,
      "tenant" : "tenant",
      "email" : "email",
      "expirationDate" : "2000-01-23T04:56:07.000+00:00",
      "userRegistrationSourceType" : "ADMIN_REGISTRATION",
      "updatedBy" : "updatedBy",
      "userDetailDataModel" : {
        "updatedBy" : "updatedBy",
        "mobileNumber" : "mobileNumber",
        "uuid" : "uuid",
        "version" : 7,
        "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",
        "surname" : "surname",
        "name" : "name",
        "id" : 9,
        "email" : "email",
        "userTypeDataModel" : {
          "code" : "code",
          "description" : "description"
        }
      },
      "lockedDate" : "2000-01-23T04:56:07.000+00:00",
      "version" : 1,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "system" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "assignedEntityId" : 5,
      "username" : "username"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthUserClaimDataModel

Up
post /users/page
Queries users as paginated according to criteria in query model (queryPage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthUserQueryModel (required)
Body Parameter

Return type

HvlResponseHvlPageHvlOAuthUserDataModel

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" : {
    "data" : [ {
      "userRegistrationSourceType" : "ADMIN_REGISTRATION",
      "updatedBy" : "updatedBy",
      "admin" : true,
      "userDetailDataModel" : {
        "updatedBy" : "updatedBy",
        "mobileNumber" : "mobileNumber",
        "uuid" : "uuid",
        "version" : 7,
        "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",
        "surname" : "surname",
        "name" : "name",
        "id" : 9,
        "email" : "email",
        "userTypeDataModel" : {
          "code" : "code",
          "description" : "description"
        }
      },
      "description" : "description",
      "lockedDate" : "2000-01-23T04:56:07.000+00:00",
      "dn" : "dn",
      "uuid" : "uuid",
      "version" : 5,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "system" : true,
      "expired" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "passwordUpdatedDate" : "2000-01-23T04:56:07.000+00:00",
      "id" : 2,
      "locked" : true,
      "tenant" : "tenant",
      "username" : "username",
      "expirationDate" : "2000-01-23T04:56:07.000+00:00"
    }, {
      "userRegistrationSourceType" : "ADMIN_REGISTRATION",
      "updatedBy" : "updatedBy",
      "admin" : true,
      "userDetailDataModel" : {
        "updatedBy" : "updatedBy",
        "mobileNumber" : "mobileNumber",
        "uuid" : "uuid",
        "version" : 7,
        "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",
        "surname" : "surname",
        "name" : "name",
        "id" : 9,
        "email" : "email",
        "userTypeDataModel" : {
          "code" : "code",
          "description" : "description"
        }
      },
      "description" : "description",
      "lockedDate" : "2000-01-23T04:56:07.000+00:00",
      "dn" : "dn",
      "uuid" : "uuid",
      "version" : 5,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "system" : true,
      "expired" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "passwordUpdatedDate" : "2000-01-23T04:56:07.000+00:00",
      "id" : 2,
      "locked" : true,
      "tenant" : "tenant",
      "username" : "username",
      "expirationDate" : "2000-01-23T04:56:07.000+00:00"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthUserDataModel

Up
post /users
Saves user data (save)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthUserModel (required)
Body Parameter

Return type

HvlResponseHvlOAuthUserModel

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" : {
    "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"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthUserModel

Up
post /users/ldap
Saves user with ldap entry (saveLdapEntry)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthUserLdapResultModel

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" : {
    "failedUserModelSet" : [ {
      "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"
    }, {
      "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"
    } ],
    "failedCount" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthUserLdapResultModel

Up
post /users/default-create
Saves user with predefined values (saveWithPredefinedValues)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthUserModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /users/unlock/by-uuid/{uuid}
Unlock user (unlock1)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /users
Updates user data (update)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthUserModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

UserBatchProcessingAPI

Up
post /users/batch-process-change-password/
Changes users password users through batch process. (changePasswordByAdmin1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthzBatchProcessingResultModel

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" : {
    "failCount" : 6,
    "errorModelList" : [ {
      "identifier" : "identifier",
      "error" : "error"
    }, {
      "identifier" : "identifier",
      "error" : "error"
    } ],
    "successCount" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthzBatchProcessingResultModel

Up
post /users/batch-process-delete/
Deletes users through batch process. (delete)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthzBatchProcessingResultModel

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" : {
    "failCount" : 6,
    "errorModelList" : [ {
      "identifier" : "identifier",
      "error" : "error"
    }, {
      "identifier" : "identifier",
      "error" : "error"
    } ],
    "successCount" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthzBatchProcessingResultModel

Up
post /users/batch-process-lock/
Locks users through batch process. (lock1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthzBatchProcessingResultModel

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" : {
    "failCount" : 6,
    "errorModelList" : [ {
      "identifier" : "identifier",
      "error" : "error"
    }, {
      "identifier" : "identifier",
      "error" : "error"
    } ],
    "successCount" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthzBatchProcessingResultModel

Up
post /users/batch-process-unlock/
Unlock users through batch process. (unlock)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthzBatchProcessingResultModel

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" : {
    "failCount" : 6,
    "errorModelList" : [ {
      "identifier" : "identifier",
      "error" : "error"
    }, {
      "identifier" : "identifier",
      "error" : "error"
    } ],
    "successCount" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthzBatchProcessingResultModel

UserDetailAPI

Up
post /user-details/batch-process-delete/
Deletes user details through batch process. (delete1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlOAuthzBatchProcessingResultModel

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" : {
    "failCount" : 6,
    "errorModelList" : [ {
      "identifier" : "identifier",
      "error" : "error"
    }, {
      "identifier" : "identifier",
      "error" : "error"
    } ],
    "successCount" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthzBatchProcessingResultModel

Up
delete /user-details/by-uuid/{uuid}
Deletes user detail data according to uuid parameter (deleteByUuid4)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /user-details/by-integration-code/{integrationCode}
Gets the user detail with provided integration code such as citizenship id (getByIntegrationCode1)

Path parameters

integrationCode (required)
Path Parameter

Return type

HvlResponseHvlOAuthUserDetailModel

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" : {
    "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"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthUserDetailModel

Up
get /user-details/by-uuid/{uuid}
Gets user detail data according to uuid parameter (getByUuid4)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthUserDetailModel

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" : {
    "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"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthUserDetailModel

Up
get /user-details/user-type/list
Gets all user type list (getUserTypes)

Return type

HvlResponseListHvlOAuthUserTypeModel

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" : [ {
    "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
  }, {
    "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
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthUserTypeModel

Up
post /user-details/import
Imports a user detail file (importUserDetails)

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

importFile (optional)
Form Parameter — format: binary

Return type

HvlResponseHvlOAuthzBatchProcessingResultModel

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" : {
    "failCount" : 6,
    "errorModelList" : [ {
      "identifier" : "identifier",
      "error" : "error"
    }, {
      "identifier" : "identifier",
      "error" : "error"
    } ],
    "successCount" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthzBatchProcessingResultModel

Up
post /user-details/list
Queries list of user detail data according to criteria in userDetailQueryModel parameter (queryList2)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseListHvlOAuthUserDetailModel

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" : [ {
    "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"
  }, {
    "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"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthUserDetailModel

Up
post /user-details/page
Queries user detail data as pageable according to criteria in userDetailQueryModel parameter (queryPage4)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthUserDetailModel

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" : {
    "data" : [ {
      "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"
    }, {
      "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"
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthUserDetailModel

Up
post /user-details
Saves user detail data (save4)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthUserDetailModel (required)
Body Parameter

Return type

HvlResponseHvlOAuthUserDetailModel

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" : {
    "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"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthUserDetailModel

Up
put /user-details
Updates user detail data (update4)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthUserDetailModel (required)
Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

UserFieldValueGeneratorAPI

Up
post /user-value-generators/generate
Generate username, email or password according to user model data (generateByStrategyType)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body HvlOAuthUserDetailModel (required)
Body Parameter

Query parameters

strategyType (required)
Query Parameter

Return type

HvlResponseString

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseString

UserPasswordPolicyAPI

Up
get /user-password-policies/activate/by-uuid/{uuid}
Activates the user password policy (activate3)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
delete /user-password-policies/by-uuid/{uuid}
Deletes user password policy with provided uuid (deleteByUuid3)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /user-password-policies/active
Gets active user password policy (getActive)

Return type

HvlResponseHvlOAuthUserPasswordPolicyModel

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" : {
    "symbolCharCount" : 4,
    "threeSameCharactersAllowed" : true,
    "allUsersPasswordMustBeChanged" : true,
    "updatedBy" : "updatedBy",
    "minLength" : 11,
    "upperCaseCharCount" : 14,
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "maxPasswordAge" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "personalInformationAllowed" : true,
    "threeConsecutiveAlphabeticalLettersAllowed" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "threeConsecutiveNumbersAllowed" : true,
    "name" : "name",
    "lowerCaseCharCount" : 18,
    "id" : 5,
    "numericCharCount" : 7,
    "maxLength" : 4,
    "notEqualsLastPasswordCount" : 7
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthUserPasswordPolicyModel

Up
get /user-password-policies/by-uuid/{uuid}
Gets the user password policy with provided uuid (getByUuid3)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthUserPasswordPolicyModel

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" : {
    "symbolCharCount" : 4,
    "threeSameCharactersAllowed" : true,
    "allUsersPasswordMustBeChanged" : true,
    "updatedBy" : "updatedBy",
    "minLength" : 11,
    "upperCaseCharCount" : 14,
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "maxPasswordAge" : 0,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "personalInformationAllowed" : true,
    "threeConsecutiveAlphabeticalLettersAllowed" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "threeConsecutiveNumbersAllowed" : true,
    "name" : "name",
    "lowerCaseCharCount" : 18,
    "id" : 5,
    "numericCharCount" : 7,
    "maxLength" : 4,
    "notEqualsLastPasswordCount" : 7
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthUserPasswordPolicyModel

Up
post /user-password-policies/page
Queries user password policy as paginated according to criteria in query model (queryPage3)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthUserPasswordPolicyModel

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" : {
    "data" : [ {
      "symbolCharCount" : 4,
      "threeSameCharactersAllowed" : true,
      "allUsersPasswordMustBeChanged" : true,
      "updatedBy" : "updatedBy",
      "minLength" : 11,
      "upperCaseCharCount" : 14,
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "maxPasswordAge" : 0,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "personalInformationAllowed" : true,
      "threeConsecutiveAlphabeticalLettersAllowed" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "threeConsecutiveNumbersAllowed" : true,
      "name" : "name",
      "lowerCaseCharCount" : 18,
      "id" : 5,
      "numericCharCount" : 7,
      "maxLength" : 4,
      "notEqualsLastPasswordCount" : 7
    }, {
      "symbolCharCount" : 4,
      "threeSameCharactersAllowed" : true,
      "allUsersPasswordMustBeChanged" : true,
      "updatedBy" : "updatedBy",
      "minLength" : 11,
      "upperCaseCharCount" : 14,
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "maxPasswordAge" : 0,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "personalInformationAllowed" : true,
      "threeConsecutiveAlphabeticalLettersAllowed" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "threeConsecutiveNumbersAllowed" : true,
      "name" : "name",
      "lowerCaseCharCount" : 18,
      "id" : 5,
      "numericCharCount" : 7,
      "maxLength" : 4,
      "notEqualsLastPasswordCount" : 7
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthUserPasswordPolicyModel

Up
post /user-password-policies
Saves the given user password policy (save3)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /user-password-policies
Updates the user password policy (update3)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

UserStrategyAPI

Up
post /user-strategies/activate/by-uuid/{uuid}
Activates the user strategy (activate)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
post /user-strategies/deactivate/by-uuid/{uuid}
Deactivates the user strategy (deactivate)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
delete /user-strategies/by-uuid/{uuid}
Deletes user strategy with provided uuid (deleteByUuid1)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
get /user-strategies/by-user-type-id/{userTypeId}
Gets the active user strategy with user type id (getActiveByUserTypeId)

Path parameters

userTypeId (required)
Path Parameter — format: int64

Return type

HvlResponseHvlOAuthUserStrategyModel

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" : {
    "updatedBy" : "updatedBy",
    "usernameStrategy" : "NAME_SURNAME",
    "description" : "description",
    "emailStrategy" : "NAME_SURNAME",
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "emailExtension" : "emailExtension",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "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
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthUserStrategyModel

Up
get /user-strategies/by-uuid/{uuid}
Gets the user strategy with provided uuid (getByUuid1)

Path parameters

uuid (required)
Path Parameter

Return type

HvlResponseHvlOAuthUserStrategyModel

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" : {
    "updatedBy" : "updatedBy",
    "usernameStrategy" : "NAME_SURNAME",
    "description" : "description",
    "emailStrategy" : "NAME_SURNAME",
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "emailExtension" : "emailExtension",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "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
    }
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlOAuthUserStrategyModel

Up
post /user-strategies/list
Queries user strategies according to criteria in query model (queryList)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseListHvlOAuthUserStrategyModel

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" : [ {
    "updatedBy" : "updatedBy",
    "usernameStrategy" : "NAME_SURNAME",
    "description" : "description",
    "emailStrategy" : "NAME_SURNAME",
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "emailExtension" : "emailExtension",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "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
    }
  }, {
    "updatedBy" : "updatedBy",
    "usernameStrategy" : "NAME_SURNAME",
    "description" : "description",
    "emailStrategy" : "NAME_SURNAME",
    "uuid" : "uuid",
    "version" : 1,
    "enabled" : true,
    "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
    "emailExtension" : "emailExtension",
    "dateCreated" : "2000-01-23T04:56:07.000+00:00",
    "deleted" : true,
    "createdBy" : "createdBy",
    "deletedDate" : "2000-01-23T04:56:07.000+00:00",
    "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
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseListHvlOAuthUserStrategyModel

Up
post /user-strategies/page
Queries user strategy as paginated according to criteria in query model (queryPage1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseHvlPageHvlOAuthUserStrategyModel

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" : {
    "data" : [ {
      "updatedBy" : "updatedBy",
      "usernameStrategy" : "NAME_SURNAME",
      "description" : "description",
      "emailStrategy" : "NAME_SURNAME",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "emailExtension" : "emailExtension",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "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
      }
    }, {
      "updatedBy" : "updatedBy",
      "usernameStrategy" : "NAME_SURNAME",
      "description" : "description",
      "emailStrategy" : "NAME_SURNAME",
      "uuid" : "uuid",
      "version" : 1,
      "enabled" : true,
      "dateUpdated" : "2000-01-23T04:56:07.000+00:00",
      "emailExtension" : "emailExtension",
      "dateCreated" : "2000-01-23T04:56:07.000+00:00",
      "deleted" : true,
      "createdBy" : "createdBy",
      "deletedDate" : "2000-01-23T04:56:07.000+00:00",
      "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
      }
    } ],
    "totalPages" : 6,
    "pageable" : {
      "pageNumber" : 1,
      "pageSize" : 5,
      "sort" : {
        "properties" : [ "properties", "properties" ],
        "direction" : "ASC"
      }
    },
    "totalElements" : 0
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseHvlPageHvlOAuthUserStrategyModel

Up
post /user-strategies
Saves the given user strategy (save1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Up
put /user-strategies
Updates the user strategy (update1)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

Body Parameter

Return type

HvlResponseVoid

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 Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK HvlResponseVoid

Models

[ Jump to Methods ]

Table of Contents

  1. HvlAuthAuthorizationRequestModel
  2. HvlErrorDetail
  3. HvlEventLogModel
  4. HvlLdapAddMemberToGroupModel
  5. HvlLdapAuthenticationModel
  6. HvlLdapBaseModel
  7. HvlLdapEntryModel
  8. HvlLdapGroupModel
  9. HvlLdapGroupUpdateModel
  10. HvlLdapOuModel
  11. HvlLdapOuQueryModel
  12. HvlLdapOuUpdateModel
  13. HvlLdapQueryModel
  14. HvlLdapRenameModel
  15. HvlLogSearchCriteria
  16. HvlLogSearchPage
  17. HvlLogSearchQueryModel
  18. HvlLogSearchSubQueryModel
  19. HvlOAuthAcquiredProfileDataModel
  20. HvlOAuthAcquiredProfileDetailDataModel
  21. HvlOAuthAcquiredProfileGroupDataModel
  22. HvlOAuthAcquiredRoleDataModel
  23. HvlOAuthAcquiredRoleGroupDataModel
  24. HvlOAuthAcquiredUserDetailDataModel
  25. HvlOAuthAuditModel
  26. HvlOAuthAuthorityClaimDataModel
  27. HvlOAuthAuthorityClaimQueryModel
  28. HvlOAuthAuthorityDataModel
  29. HvlOAuthAuthorityModel
  30. HvlOAuthAuthorityProfileGroupPersistModel
  31. HvlOAuthAuthorityQueryModel
  32. HvlOAuthAuthorityTagDataModel
  33. HvlOAuthAuthorityTagPersistModel
  34. HvlOAuthBaseBatchProcessModel
  35. HvlOAuthBatchProcessUserChangePasswordModel
  36. HvlOAuthBatchProcessUserLockModel
  37. HvlOAuthEventLogTypeModel
  38. HvlOAuthLookupModel
  39. HvlOAuthLookupQueryModel
  40. HvlOAuthPasswordRestrictionModel
  41. HvlOAuthPasswordRestrictionQueryModel
  42. HvlOAuthPredefinedProxyCopiablePersistModel
  43. HvlOAuthPredefinedProxyDataModel
  44. HvlOAuthPredefinedProxyModel
  45. HvlOAuthPredefinedProxyPersistModel
  46. HvlOAuthPredefinedProxyQueryModel
  47. HvlOAuthPredefinedRoleDataModel
  48. HvlOAuthPredefinedRoleModel
  49. HvlOAuthPredefinedRolePersistModel
  50. HvlOAuthPredefinedRoleQueryModel
  51. HvlOAuthProfileAcquiredRolePredicateModel
  52. HvlOAuthProfileClaimQueryModel
  53. HvlOAuthProfileCopiablePersistModel
  54. HvlOAuthProfileDataModel
  55. HvlOAuthProfileDetailClaimDataModel
  56. HvlOAuthProfileDetailClaimQueryModel
  57. HvlOAuthProfileDetailDataModel
  58. HvlOAuthProfileDetailModel
  59. HvlOAuthProfileDetailNameModel
  60. HvlOAuthProfileDetailQueryModel
  61. HvlOAuthProfileDetailQueryModel_locale
  62. HvlOAuthProfileDetailTypeModel
  63. HvlOAuthProfileGroupClaimNodeModel
  64. HvlOAuthProfileGroupClaimQueryModel
  65. HvlOAuthProfileGroupCopiablePersistModel
  66. HvlOAuthProfileGroupDataModel
  67. HvlOAuthProfileGroupModel
  68. HvlOAuthProfileGroupPersistModel
  69. HvlOAuthProfileGroupQueryModel
  70. HvlOAuthProfileGroupRolePersistModel
  71. HvlOAuthProfileModel
  72. HvlOAuthProfilePersistModel
  73. HvlOAuthProfileQueryModel
  74. HvlOAuthProfileResetModel
  75. HvlOAuthProfileRolePersistByAdminModel
  76. HvlOAuthProfileRolePersistByRoleAssignerModel
  77. HvlOAuthProfileUserClaimDataModel
  78. HvlOAuthProfileUserDataModel
  79. HvlOAuthProxyCopiablePersistModel
  80. HvlOAuthProxyDataModel
  81. HvlOAuthProxyFromTrustedProxyModel
  82. HvlOAuthProxyModel
  83. HvlOAuthProxyPersistModel
  84. HvlOAuthProxyQueryModel
  85. HvlOAuthReportQueryModel
  86. HvlOAuthRoleAssignerPersistModel
  87. HvlOAuthRoleAssignerQueryModel
  88. HvlOAuthRoleClaimDataModel
  89. HvlOAuthRoleClaimQueryModel
  90. HvlOAuthRoleCopiablePersistModel
  91. HvlOAuthRoleDataModel
  92. HvlOAuthRoleGroupClaimDataModel
  93. HvlOAuthRoleGroupClaimQueryModel
  94. HvlOAuthRoleGroupCopiablePersistModel
  95. HvlOAuthRoleGroupDataModel
  96. HvlOAuthRoleGroupModel
  97. HvlOAuthRoleGroupPersistModel
  98. HvlOAuthRoleGroupQueryModel
  99. HvlOAuthRoleModel
  100. HvlOAuthRolePersistModel
  101. HvlOAuthRoleProfilePersistModel
  102. HvlOAuthRoleQueryModel
  103. HvlOAuthSessionModel
  104. HvlOAuthSystemUserModel
  105. HvlOAuthSystemUserQueryModel
  106. HvlOAuthTagModel
  107. HvlOAuthTagQueryModel
  108. HvlOAuthTrustedProxyCopiablePersistModel
  109. HvlOAuthTrustedProxyDataModel
  110. HvlOAuthTrustedProxyModel
  111. HvlOAuthTrustedProxyPersistModel
  112. HvlOAuthTrustedProxyQueryModel
  113. HvlOAuthUserChangePasswordByAdminModel
  114. HvlOAuthUserChangePasswordModel
  115. HvlOAuthUserChangePasswordWithVerificationModel
  116. HvlOAuthUserClaimDataModel
  117. HvlOAuthUserClaimQueryModel
  118. HvlOAuthUserDataModel
  119. HvlOAuthUserDetailDataModel
  120. HvlOAuthUserDetailModel
  121. HvlOAuthUserDetailQueryModel
  122. HvlOAuthUserInfoDataModel
  123. HvlOAuthUserInfoPredicateModel
  124. HvlOAuthUserLdapPersistModel
  125. HvlOAuthUserLdapResultModel
  126. HvlOAuthUserLockModel
  127. HvlOAuthUserMigrationModel
  128. HvlOAuthUserModel
  129. HvlOAuthUserPasswordPolicyModel
  130. HvlOAuthUserPasswordPolicyQueryModel
  131. HvlOAuthUserProfilePredicateModel
  132. HvlOAuthUserQueryModel
  133. HvlOAuthUserRegistrationCompletionModel
  134. HvlOAuthUserRegistrationRequestModel
  135. HvlOAuthUserStrategyModel
  136. HvlOAuthUserStrategyQueryModel
  137. HvlOAuthUserTypeDataModel
  138. HvlOAuthUserTypeModel
  139. HvlOAuthzBatchProcessingErrorModel
  140. HvlOAuthzBatchProcessingResultModel
  141. HvlPageHvlEventLogModel
  142. HvlPageHvlOAuthAuthorityClaimDataModel
  143. HvlPageHvlOAuthAuthorityDataModel
  144. HvlPageHvlOAuthAuthorityTagDataModel
  145. HvlPageHvlOAuthLookupModel
  146. HvlPageHvlOAuthPasswordRestrictionModel
  147. HvlPageHvlOAuthPredefinedProxyDataModel
  148. HvlPageHvlOAuthPredefinedRoleDataModel
  149. HvlPageHvlOAuthProfileDetailClaimDataModel
  150. HvlPageHvlOAuthProfileDetailDataModel
  151. HvlPageHvlOAuthProfileGroupClaimNodeModel
  152. HvlPageHvlOAuthProfileGroupDataModel
  153. HvlPageHvlOAuthProfileGroupModel
  154. HvlPageHvlOAuthProfileModel
  155. HvlPageHvlOAuthProfileUserClaimDataModel
  156. HvlPageHvlOAuthProfileUserDataModel
  157. HvlPageHvlOAuthProxyDataModel
  158. HvlPageHvlOAuthRoleClaimDataModel
  159. HvlPageHvlOAuthRoleDataModel
  160. HvlPageHvlOAuthRoleGroupClaimDataModel
  161. HvlPageHvlOAuthRoleGroupDataModel
  162. HvlPageHvlOAuthSystemUserModel
  163. HvlPageHvlOAuthTagModel
  164. HvlPageHvlOAuthTrustedProxyDataModel
  165. HvlPageHvlOAuthUserClaimDataModel
  166. HvlPageHvlOAuthUserDataModel
  167. HvlPageHvlOAuthUserDetailModel
  168. HvlPageHvlOAuthUserPasswordPolicyModel
  169. HvlPageHvlOAuthUserStrategyModel
  170. HvlPageable
  171. HvlResponseBoolean
  172. HvlResponseHvlLdapEntryModel
  173. HvlResponseHvlLdapGroupModel
  174. HvlResponseHvlOAuthAuthorityModel
  175. HvlResponseHvlOAuthLookupModel
  176. HvlResponseHvlOAuthPasswordRestrictionModel
  177. HvlResponseHvlOAuthPredefinedProxyModel
  178. HvlResponseHvlOAuthPredefinedRoleModel
  179. HvlResponseHvlOAuthProfileDataModel
  180. HvlResponseHvlOAuthProfileDetailModel
  181. HvlResponseHvlOAuthProfileGroupModel
  182. HvlResponseHvlOAuthProfileModel
  183. HvlResponseHvlOAuthProxyModel
  184. HvlResponseHvlOAuthRoleGroupModel
  185. HvlResponseHvlOAuthRoleModel
  186. HvlResponseHvlOAuthSessionModel
  187. HvlResponseHvlOAuthSystemUserModel
  188. HvlResponseHvlOAuthTagModel
  189. HvlResponseHvlOAuthTrustedProxyModel
  190. HvlResponseHvlOAuthUserDetailModel
  191. HvlResponseHvlOAuthUserInfoDataModel
  192. HvlResponseHvlOAuthUserLdapResultModel
  193. HvlResponseHvlOAuthUserModel
  194. HvlResponseHvlOAuthUserPasswordPolicyModel
  195. HvlResponseHvlOAuthUserStrategyModel
  196. HvlResponseHvlOAuthzBatchProcessingResultModel
  197. HvlResponseHvlPageHvlEventLogModel
  198. HvlResponseHvlPageHvlOAuthAuthorityClaimDataModel
  199. HvlResponseHvlPageHvlOAuthAuthorityDataModel
  200. HvlResponseHvlPageHvlOAuthAuthorityTagDataModel
  201. HvlResponseHvlPageHvlOAuthLookupModel
  202. HvlResponseHvlPageHvlOAuthPasswordRestrictionModel
  203. HvlResponseHvlPageHvlOAuthPredefinedProxyDataModel
  204. HvlResponseHvlPageHvlOAuthPredefinedRoleDataModel
  205. HvlResponseHvlPageHvlOAuthProfileDetailClaimDataModel
  206. HvlResponseHvlPageHvlOAuthProfileDetailDataModel
  207. HvlResponseHvlPageHvlOAuthProfileGroupClaimNodeModel
  208. HvlResponseHvlPageHvlOAuthProfileGroupDataModel
  209. HvlResponseHvlPageHvlOAuthProfileGroupModel
  210. HvlResponseHvlPageHvlOAuthProfileModel
  211. HvlResponseHvlPageHvlOAuthProfileUserClaimDataModel
  212. HvlResponseHvlPageHvlOAuthProfileUserDataModel
  213. HvlResponseHvlPageHvlOAuthProxyDataModel
  214. HvlResponseHvlPageHvlOAuthRoleClaimDataModel
  215. HvlResponseHvlPageHvlOAuthRoleDataModel
  216. HvlResponseHvlPageHvlOAuthRoleGroupClaimDataModel
  217. HvlResponseHvlPageHvlOAuthRoleGroupDataModel
  218. HvlResponseHvlPageHvlOAuthSystemUserModel
  219. HvlResponseHvlPageHvlOAuthTagModel
  220. HvlResponseHvlPageHvlOAuthTrustedProxyDataModel
  221. HvlResponseHvlPageHvlOAuthUserClaimDataModel
  222. HvlResponseHvlPageHvlOAuthUserDataModel
  223. HvlResponseHvlPageHvlOAuthUserDetailModel
  224. HvlResponseHvlPageHvlOAuthUserPasswordPolicyModel
  225. HvlResponseHvlPageHvlOAuthUserStrategyModel
  226. HvlResponseListHvlLdapEntryModel
  227. HvlResponseListHvlLdapGroupModel
  228. HvlResponseListHvlLdapOuModel
  229. HvlResponseListHvlOAuthAcquiredProfileDataModel
  230. HvlResponseListHvlOAuthAuditModel
  231. HvlResponseListHvlOAuthAuthorityClaimDataModel
  232. HvlResponseListHvlOAuthAuthorityTagDataModel
  233. HvlResponseListHvlOAuthEventLogTypeModel
  234. HvlResponseListHvlOAuthLookupModel
  235. HvlResponseListHvlOAuthPasswordRestrictionModel
  236. HvlResponseListHvlOAuthPredefinedRoleDataModel
  237. HvlResponseListHvlOAuthProfileDataModel
  238. HvlResponseListHvlOAuthProfileDetailClaimDataModel
  239. HvlResponseListHvlOAuthProfileDetailDataModel
  240. HvlResponseListHvlOAuthProfileDetailTypeModel
  241. HvlResponseListHvlOAuthProfileGroupModel
  242. HvlResponseListHvlOAuthRoleDataModel
  243. HvlResponseListHvlOAuthRoleGroupDataModel
  244. HvlResponseListHvlOAuthSystemUserModel
  245. HvlResponseListHvlOAuthTagModel
  246. HvlResponseListHvlOAuthUserDetailModel
  247. HvlResponseListHvlOAuthUserStrategyModel
  248. HvlResponseListHvlOAuthUserTypeModel
  249. HvlResponseListLong
  250. HvlResponseListString
  251. HvlResponseString
  252. HvlResponseVoid
  253. HvlSearchCriteria
  254. HvlSort
  255. entry_remove_body
  256. profiledetails_import_body
  257. userdetails_import_body

HvlAuthAuthorizationRequestModel Up

email
code
tenant (optional)

HvlErrorDetail Up

uuid (optional)
errorClassName (optional)
errorCode (optional)
errorDetail (optional)
errorMessage (optional)
service (optional)
time (optional)
Date format: date-time
errorArguments (optional)

HvlEventLogModel Up

indexName
applicationName
username
message
source (optional)
eventType
eventDate (optional)
Date format: date-time
attributeMap (optional)

HvlLdapAddMemberToGroupModel Up

groupModel (optional)
entryModelSet (optional)

HvlLdapAuthenticationModel Up

username
password (optional)

HvlLdapBaseModel Up

dn
cn

HvlLdapEntryModel Up

dn
cn
uid (optional)
firstname (optional)
surname (optional)
password (optional)
email (optional)
description (optional)
gidNumber (optional)
uidNumber (optional)
homeDirectory (optional)
objectClassList (optional)

HvlLdapGroupModel Up

dn
cn
members (optional)
gidNumber (optional)
objectClassList (optional)

HvlLdapGroupUpdateModel Up

dn
cn
gidNumber (optional)
addedMembers (optional)
removedMembers (optional)

HvlLdapOuModel Up

name
dn (optional)
childCount (optional)
Integer format: int32

HvlLdapOuQueryModel Up

parentDn (optional)

HvlLdapOuUpdateModel Up

name
currentDn
parentDn (optional)

HvlLdapQueryModel Up

dn (optional)
name (optional)
ldapTypeEnum (optional)
Enum:
ENTRY
GROUP

HvlLdapRenameModel Up

dn
cn
updatedDn (optional)
updatedCn (optional)

HvlLogSearchCriteria Up

criteriaList (optional)

HvlLogSearchPage Up

pageNumber (optional)
Integer format: int32
pageSize (optional)
Integer format: int32
sort (optional)
sortPropertiesTypeMap (optional)
Enum:

HvlLogSearchQueryModel Up

criteria (optional)
orCriteria (optional)
subQueryModelList (optional)
page (optional)
indices (optional)

HvlLogSearchSubQueryModel Up

criteria (optional)
orCriteria (optional)

HvlOAuthAcquiredProfileDataModel Up

profileId (optional)
Long format: int64
profileName (optional)
combinedProfileDetailName (optional)
proxyName (optional)
integrationCode (optional)
proxyUuid (optional)

HvlOAuthAcquiredProfileDetailDataModel Up

profileDetailUuid (optional)
profileDetailTypeId (optional)
Long format: int64
integrationCode (optional)
profileDetailName (optional)
profileId (optional)
Long format: int64
profileGroupUuid (optional)
proxyUuid (optional)

HvlOAuthAcquiredProfileGroupDataModel Up

profileId (optional)
Long format: int64
profileGroupUuid (optional)
profileGroupName (optional)

HvlOAuthAcquiredRoleDataModel Up

profileId (optional)
Long format: int64
roleUuid (optional)
roleCode (optional)
roleName (optional)
proxyUuid (optional)

HvlOAuthAcquiredRoleGroupDataModel Up

profileId (optional)
Long format: int64
roleGroupUuid (optional)
roleGroupId (optional)
Long format: int64
roleGroupName (optional)

HvlOAuthAcquiredUserDetailDataModel Up

userDetailUuid (optional)
name (optional)
surname (optional)
email (optional)
mobileNumber (optional)
integrationCode (optional)
personalIdentifier (optional)

HvlOAuthAuditModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
auditGroup
Enum:
USER
PROFILE
ROLE
PROXY
SETTING
enabled (optional)

HvlOAuthAuthorityClaimDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
code (optional)
label (optional)
description (optional)
critical (optional)
hasChildren (optional)
hasAnySelectedChildren (optional)
assignedEntityId (optional)
Long format: int64

HvlOAuthAuthorityClaimQueryModel Up

pageable (optional)
filters (optional)
uuid (optional)
parentId (optional)
Long format: int64
code (optional)
moduleAuthorityCode (optional)
label (optional)
moduleName (optional)
critical (optional)
deleted (optional)
onlyRoot (optional)
idSet (optional)
array[Long] format: int64
tagIdSet (optional)
array[Long] format: int64
roleIdSet (optional)
array[Long] format: int64
profileGroupIdSet (optional)
array[Long] format: int64
assignedEntityType
Enum:
ROLE
PROFILE_GROUP
OTHER
assignedEntityId (optional)
Long format: int64
onlyAssigned (optional)
addableIdSet (optional)
array[Long] format: int64
removeableIdSet (optional)
array[Long] format: int64

HvlOAuthAuthorityDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
code (optional)
label (optional)
description (optional)
critical (optional)
hasChildren (optional)
hasAnySelectedChildren (optional)

HvlOAuthAuthorityModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
code
label (optional)
description (optional)
critical (optional)
parent (optional)

HvlOAuthAuthorityProfileGroupPersistModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
authorityUuid
profileGroupIdSetToAdd (optional)
array[Long] format: int64
profileGroupIdSetToRemove (optional)
array[Long] format: int64

HvlOAuthAuthorityQueryModel Up

pageable (optional)
filters (optional)
uuid (optional)
parentId (optional)
Long format: int64
code (optional)
moduleAuthorityCode (optional)
label (optional)
moduleName (optional)
critical (optional)
deleted (optional)
onlyRoot (optional)
idSet (optional)
array[Long] format: int64
tagIdSet (optional)
array[Long] format: int64
roleIdSet (optional)
array[Long] format: int64
profileGroupIdSet (optional)
array[Long] format: int64

HvlOAuthAuthorityTagDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
authorityId (optional)
Long format: int64
authorityCode (optional)
authorityLabel (optional)
tagId (optional)
Long format: int64
tagName (optional)

HvlOAuthAuthorityTagPersistModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
authorityUuid
tagIdSetToAdd (optional)
array[Long] format: int64
tagIdSetToRemove (optional)
array[Long] format: int64

HvlOAuthBaseBatchProcessModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
uuidSet

HvlOAuthBatchProcessUserChangePasswordModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
uuidSet
ldapUpdateEnable (optional)
password (optional)

HvlOAuthBatchProcessUserLockModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
uuidSet
description

HvlOAuthEventLogTypeModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
code
description (optional)
orderNo (optional)
Integer format: int32
integrationCode (optional)
shortDescription (optional)
parameterType

HvlOAuthLookupModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
code
description (optional)
orderNo (optional)
Integer format: int32
integrationCode (optional)
shortDescription (optional)
parameterType

HvlOAuthLookupQueryModel Up

pageable (optional)
filters (optional)
uuid (optional)
code (optional)
description (optional)
orderNo (optional)
Integer format: int32
integrationCode (optional)
shortDescription (optional)
lookupParameterType (optional)
Enum:
USER_TYPE
PROFILE_DETAIL_TYPE
EVENT_TYPE

HvlOAuthPasswordRestrictionModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
blackListedPassword

HvlOAuthPasswordRestrictionQueryModel Up

pageable (optional)
filters (optional)
blackListedPassword (optional)

HvlOAuthPredefinedProxyCopiablePersistModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
description (optional)
sourceProfileId
Long format: int64
roleIdSetToAdd (optional)
array[Long] format: int64
roleIdSetToRemove (optional)
array[Long] format: int64
sourcePredefinedProxyIdToCopy (optional)
Long format: int64

HvlOAuthPredefinedProxyDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name (optional)
description (optional)

HvlOAuthPredefinedProxyModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
description (optional)
sourceProfileId
Long format: int64

HvlOAuthPredefinedProxyPersistModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
description (optional)
sourceProfileId
Long format: int64
roleIdSetToAdd (optional)
array[Long] format: int64
roleIdSetToRemove (optional)
array[Long] format: int64

HvlOAuthPredefinedProxyQueryModel Up

pageable (optional)
filters (optional)
uuid (optional)
name (optional)
deleted (optional)
userProfilePredicateModel

HvlOAuthPredefinedRoleDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
roleId (optional)
Long format: int64
roleName (optional)
roleCode (optional)
roleEnabled (optional)
roleDescription (optional)
userTypeId (optional)
Long format: int64
userTypeDescription (optional)

HvlOAuthPredefinedRoleModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
userTypeId
Long format: int64
roleId
Long format: int64

HvlOAuthPredefinedRolePersistModel Up

userTypeUuid
roleIdSetToAdd (optional)
array[Long] format: int64
roleIdSetToRemove (optional)
array[Long] format: int64

HvlOAuthPredefinedRoleQueryModel Up

pageable (optional)
filters (optional)
deleted (optional)
uuid (optional)
roleIdSet (optional)
array[Long] format: int64
enabled (optional)
userTypeId (optional)
Long format: int64
roleName (optional)
roleCode (optional)
authorityTagIdSet (optional)
array[Long] format: int64

HvlOAuthProfileAcquiredRolePredicateModel Up

profileId
Long format: int64
profileName (optional)
proxyId (optional)
Long format: int64
proxyUuid (optional)

HvlOAuthProfileClaimQueryModel Up

pageable (optional)
filters (optional)
uuid (optional)
id (optional)
Long format: int64
uuidList (optional)
notInUuidList (optional)
idList (optional)
array[Long] format: int64
name (optional)
nameWithEquals (optional)
virtual (optional)
integrationCode (optional)
userId (optional)
Long format: int64
userUsername (optional)
userIntegrationCode (optional)
userEmail (optional)
userFirstName (optional)
userLastName (optional)
userTypeId (optional)
Long format: int64
enabled (optional)
roleAssignerId (optional)
Long format: int64
roleAssignerProfileQuery (optional)
system (optional)
profileGroupIdSet (optional)
array[Long] format: int64
profileDetailIdSet (optional)
array[Long] format: int64
authorityIdSet (optional)
array[Long] format: int64
roleIdSet (optional)
array[Long] format: int64
roleGroupIdSet (optional)
array[Long] format: int64
authorityCodeSet (optional)
roleCodeSet (optional)
assignedEntityType
Enum:
PROFILE_GROUP
ROLE_ASSIGNER
ROLE
OTHER
assignedEntityId (optional)
Long format: int64
onlyAssigned (optional)
addableIdSet (optional)
array[Long] format: int64
removeableIdSet (optional)
array[Long] format: int64

HvlOAuthProfileCopiablePersistModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
description (optional)
enabled (optional)
user (optional)
virtual (optional)
profileDetailCopied (optional)
integrationCode (optional)
profileDetailIdSetToAdd (optional)
array[Long] format: int64
profileDetailIdSetToRemove (optional)
array[Long] format: int64
sourceProfileIdToCopy (optional)
Long format: int64
copyRoles (optional)
copyRoleGroups (optional)
copyProfileGroups (optional)

HvlOAuthProfileDataModel Up

id (optional)
Long format: int64
uuid (optional)
name (optional)
description (optional)
virtual (optional)
enabled (optional)
integrationCode (optional)

HvlOAuthProfileDetailClaimDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name (optional)
typeId (optional)
Long format: int64
typeDescription (optional)
hasChildren (optional)
parentId (optional)
Long format: int64
integrationCode (optional)
assignedEntityId (optional)
Long format: int64

HvlOAuthProfileDetailClaimQueryModel Up

pageable (optional)
filters (optional)
uuid (optional)
parentUuid (optional)
parentId (optional)
Long format: int64
profileDetailTypeId (optional)
Long format: int64
name (optional)
integrationCode (optional)
onlyRoot (optional)
profileId (optional)
Long format: int64
profileGroupId (optional)
Long format: int64
locale (optional)
roleAssignerIdSet (optional)
array[Long] format: int64
idSet (optional)
array[Long] format: int64
uuidSet (optional)
assignedEntityType
Enum:
PROFILE
PROFILE_GROUP
OTHER
ROLE_ASSIGNER
assignedEntityId (optional)
Long format: int64
onlyAssigned (optional)
addableIdSet (optional)
array[Long] format: int64
removeableIdSet (optional)
array[Long] format: int64

HvlOAuthProfileDetailDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name (optional)
typeId (optional)
Long format: int64
typeDescription (optional)
hasChildren (optional)
parentId (optional)
Long format: int64
integrationCode (optional)

HvlOAuthProfileDetailModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
profileDetailType
integrationCode (optional)
parent (optional)
nameMap (optional)

HvlOAuthProfileDetailNameModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
locale (optional)
profileDetailId (optional)
Long format: int64

HvlOAuthProfileDetailQueryModel Up

pageable (optional)
filters (optional)
uuid (optional)
parentUuid (optional)
parentId (optional)
Long format: int64
profileDetailTypeId (optional)
Long format: int64
name (optional)
integrationCode (optional)
onlyRoot (optional)
profileId (optional)
Long format: int64
profileGroupId (optional)
Long format: int64
locale (optional)
roleAssignerIdSet (optional)
array[Long] format: int64
idSet (optional)
array[Long] format: int64
uuidSet (optional)

HvlOAuthProfileDetailQueryModel_locale Up

language (optional)
displayName (optional)
country (optional)
variant (optional)
script (optional)
unicodeLocaleAttributes (optional)
unicodeLocaleKeys (optional)
displayLanguage (optional)
displayScript (optional)
displayCountry (optional)
displayVariant (optional)
extensionKeys (optional)
iso3Language (optional)
iso3Country (optional)

HvlOAuthProfileDetailTypeModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
code
description (optional)
orderNo (optional)
Integer format: int32
integrationCode (optional)
shortDescription (optional)
parameterType

HvlOAuthProfileGroupClaimNodeModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name (optional)
description (optional)
enabled (optional)
roleName (optional)
roleGroupName (optional)
assignedEntityId (optional)
Long format: int64

HvlOAuthProfileGroupClaimQueryModel Up

pageable (optional)
filters (optional)
idSet (optional)
array[Long] format: int64
uuidSet (optional)
name (optional)
enabled (optional)
authorityIdSet (optional)
array[Long] format: int64
roleIdSet (optional)
array[Long] format: int64
profileIdSet (optional)
array[Long] format: int64
profileDetailIdSet (optional)
array[Long] format: int64
roleAssignerIdSet (optional)
array[Long] format: int64
roleGroupIdSet (optional)
array[Long] format: int64
assignedEntityType
Enum:
ROLE_ASSIGNER
AUTHORITY
OTHER
assignedEntityId (optional)
Long format: int64
onlyAssigned (optional)
addableIdSet (optional)
array[Long] format: int64
removeableIdSet (optional)
array[Long] format: int64

HvlOAuthProfileGroupCopiablePersistModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
description (optional)
enabled (optional)
profileIdSetToAdd (optional)
array[Long] format: int64
profileIdSetToRemove (optional)
array[Long] format: int64
profileDetailIdSetToAdd (optional)
array[Long] format: int64
profileDetailIdSetToRemove (optional)
array[Long] format: int64
sourceProfileGroupIdToCopy (optional)
Long format: int64

HvlOAuthProfileGroupDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name (optional)
description (optional)
enabled (optional)
roleName (optional)
roleGroupName (optional)

HvlOAuthProfileGroupModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
description (optional)
enabled (optional)

HvlOAuthProfileGroupPersistModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
description (optional)
enabled (optional)
profileIdSetToAdd (optional)
array[Long] format: int64
profileIdSetToRemove (optional)
array[Long] format: int64
profileDetailIdSetToAdd (optional)
array[Long] format: int64
profileDetailIdSetToRemove (optional)
array[Long] format: int64

HvlOAuthProfileGroupQueryModel Up

pageable (optional)
filters (optional)
idSet (optional)
array[Long] format: int64
uuidSet (optional)
name (optional)
enabled (optional)
authorityIdSet (optional)
array[Long] format: int64
roleIdSet (optional)
array[Long] format: int64
profileIdSet (optional)
array[Long] format: int64
profileDetailIdSet (optional)
array[Long] format: int64
roleAssignerIdSet (optional)
array[Long] format: int64
roleGroupIdSet (optional)
array[Long] format: int64

HvlOAuthProfileGroupRolePersistModel Up

profileGroupUuid
roleIdSetToAdd (optional)
array[Long] format: int64
roleIdSetToRemove (optional)
array[Long] format: int64
roleGroupIdSetToAdd (optional)
array[Long] format: int64
roleGroupIdSetToRemove (optional)
array[Long] format: int64

HvlOAuthProfileModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
description (optional)
enabled (optional)
user (optional)
virtual (optional)
profileDetailCopied (optional)
integrationCode (optional)

HvlOAuthProfilePersistModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
description (optional)
enabled (optional)
user (optional)
virtual (optional)
profileDetailCopied (optional)
integrationCode (optional)
profileDetailIdSetToAdd (optional)
array[Long] format: int64
profileDetailIdSetToRemove (optional)
array[Long] format: int64

HvlOAuthProfileQueryModel Up

pageable (optional)
filters (optional)
uuid (optional)
id (optional)
Long format: int64
uuidList (optional)
notInUuidList (optional)
idList (optional)
array[Long] format: int64
name (optional)
nameWithEquals (optional)
virtual (optional)
integrationCode (optional)
userId (optional)
Long format: int64
userUsername (optional)
userIntegrationCode (optional)
userEmail (optional)
userFirstName (optional)
userLastName (optional)
userTypeId (optional)
Long format: int64
enabled (optional)
roleAssignerId (optional)
Long format: int64
roleAssignerProfileQuery (optional)
system (optional)
profileGroupIdSet (optional)
array[Long] format: int64
profileDetailIdSet (optional)
array[Long] format: int64
authorityIdSet (optional)
array[Long] format: int64
roleIdSet (optional)
array[Long] format: int64
roleGroupIdSet (optional)
array[Long] format: int64
authorityCodeSet (optional)
roleCodeSet (optional)

HvlOAuthProfileResetModel Up

profileIntegrationCode
clearRole (optional)
clearRoleGroups (optional)
clearProfileGroups (optional)

HvlOAuthProfileRolePersistByAdminModel Up

profileUuid
roleIdSetToAdd (optional)
array[Long] format: int64
roleIdSetToRemove (optional)
array[Long] format: int64
roleGroupIdSetToAdd (optional)
array[Long] format: int64
roleGroupIdSetToRemove (optional)
array[Long] format: int64

HvlOAuthProfileRolePersistByRoleAssignerModel Up

profileUuid
roleIdSetToAdd (optional)
array[Long] format: int64
roleIdSetToRemove (optional)
array[Long] format: int64
roleAssignerId
Long format: int64

HvlOAuthProfileUserClaimDataModel Up

id (optional)
Long format: int64
uuid (optional)
name (optional)
description (optional)
virtual (optional)
enabled (optional)
integrationCode (optional)
username (optional)
admin (optional)
tenant (optional)
userFirstName (optional)
userLastName (optional)
email (optional)
userDetailIntegrationCode (optional)
userTypeCode (optional)
system (optional)
googleAuthenticatorEnabled (optional)
secret (optional)
expirationDate (optional)
Date format: date-time
assignedEntityId (optional)
Long format: int64

HvlOAuthProfileUserDataModel Up

id (optional)
Long format: int64
uuid (optional)
name (optional)
description (optional)
virtual (optional)
enabled (optional)
integrationCode (optional)
username (optional)
admin (optional)
tenant (optional)
userFirstName (optional)
userLastName (optional)
email (optional)
userDetailIntegrationCode (optional)
userTypeCode (optional)
system (optional)
googleAuthenticatorEnabled (optional)
secret (optional)
expirationDate (optional)
Date format: date-time

HvlOAuthProxyCopiablePersistModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
sourceProfileId
Long format: int64
targetUserId
Long format: int64
trustedProxyId (optional)
Long format: int64
startDate
Date format: date-time
endDate
Date format: date-time
name (optional)
description
integrationCode (optional)
sourceProfileUserUsername (optional)
targetUserUsername (optional)
roleIdSetToAdd (optional)
array[Long] format: int64
roleIdSetToRemove (optional)
array[Long] format: int64
criticalAuthorityIdSet (optional)
array[Long] format: int64
sourceProxyIdToCopy (optional)
Long format: int64

HvlOAuthProxyDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
sourceProfileId (optional)
Long format: int64
sourceProfileUserUsername (optional)
sourceUserName (optional)
sourceUserSurname (optional)
targetUserId (optional)
Long format: int64
targetUserUsername (optional)
targetUserName (optional)
targetUserSurname (optional)
startDate (optional)
Date format: date-time
endDate (optional)
Date format: date-time
description (optional)
integrationCode (optional)
name (optional)
roleName (optional)
trustedProxyId (optional)
Long format: int64

HvlOAuthProxyFromTrustedProxyModel Up

startDate
Date format: date-time
endDate
Date format: date-time
trustedProxyId
Long format: int64
name
description

HvlOAuthProxyModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
sourceProfileId
Long format: int64
targetUserId
Long format: int64
trustedProxyId (optional)
Long format: int64
startDate
Date format: date-time
endDate
Date format: date-time
name (optional)
description
integrationCode (optional)
sourceProfileUserUsername (optional)
targetUserUsername (optional)

HvlOAuthProxyPersistModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
sourceProfileId
Long format: int64
targetUserId
Long format: int64
trustedProxyId (optional)
Long format: int64
startDate
Date format: date-time
endDate
Date format: date-time
name (optional)
description
integrationCode (optional)
sourceProfileUserUsername (optional)
targetUserUsername (optional)
roleIdSetToAdd (optional)
array[Long] format: int64
roleIdSetToRemove (optional)
array[Long] format: int64
criticalAuthorityIdSet (optional)
array[Long] format: int64

HvlOAuthProxyQueryModel Up

pageable (optional)
filters (optional)
uuid (optional)
sourceProfileId (optional)
Long format: int64
targetUserId (optional)
Long format: int64
trustedProxyId (optional)
Long format: int64
deleted (optional)
onlyDelegated (optional)
onlyBorrowed (optional)
startDate (optional)
Date format: date-time
endDate (optional)
Date format: date-time
integrationCode (optional)
idSet (optional)
array[Long] format: int64
roleIdSet (optional)
array[Long] format: int64
authorityIdSet (optional)
array[Long] format: int64
userProfilePredicateModel
name (optional)
onlyTrustedProxy (optional)

HvlOAuthReportQueryModel Up

pageable (optional)
filters (optional)
id
Long format: int64
reportType
Enum:
PROFILE_DIRECT_ROLE
PROFILE_ROLE_GROUP_ROLE
PROFILE_PROFILE_GROUP_ROLE
PROFILE_PROFILE_GROUP_ROLE_GROUP_ROLE
TAKEN_PROXY_ROLE
PROFILE_DIRECT_PROFILE_GROUP
PROFILE_DIRECT_ROLE_GROUP
PROFILE_PROFILE_GROUP_ROLE_GROUP

HvlOAuthRoleAssignerPersistModel Up

roleId (optional)
Long format: int64
roleUuid (optional)
hierarchical (optional)
roleGroupIdSetToAdd (optional)
array[Long] format: int64
roleGroupIdSetToRemove (optional)
array[Long] format: int64
profileGroupIdSetToAdd (optional)
array[Long] format: int64
profileGroupIdSetToRemove (optional)
array[Long] format: int64
profileDetailIdSetToAdd (optional)
array[Long] format: int64
profileDetailIdSetToRemove (optional)
array[Long] format: int64

HvlOAuthRoleAssignerQueryModel Up

pageable (optional)
filters (optional)
uuid (optional)
name (optional)
code (optional)
enabled (optional)
editable (optional)
proxyable (optional)
deleted (optional)
roleAssignerId (optional)
Long format: int64
onlyRoleAssigner (optional)
idSet (optional)
array[Long] format: int64
authorityIdSet (optional)
array[Long] format: int64
authorityTagIdSet (optional)
array[Long] format: int64
roleGroupIdSet (optional)
array[Long] format: int64
profileIdSet (optional)
array[Long] format: int64
profileGroupIdSet (optional)
array[Long] format: int64
predefinedProxyIdSet (optional)
array[Long] format: int64
proxyIdSet (optional)
array[Long] format: int64
trustedProxyIdSet (optional)
array[Long] format: int64
uuidSet (optional)

HvlOAuthRoleClaimDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name (optional)
code (optional)
editable (optional)
enabled (optional)
proxyable (optional)
description (optional)
hierarchical (optional)
assignedEntityId (optional)
Long format: int64

HvlOAuthRoleClaimQueryModel Up

pageable (optional)
filters (optional)
uuid (optional)
name (optional)
code (optional)
enabled (optional)
editable (optional)
proxyable (optional)
deleted (optional)
roleAssignerId (optional)
Long format: int64
onlyRoleAssigner (optional)
idSet (optional)
array[Long] format: int64
authorityIdSet (optional)
array[Long] format: int64
authorityTagIdSet (optional)
array[Long] format: int64
roleGroupIdSet (optional)
array[Long] format: int64
profileIdSet (optional)
array[Long] format: int64
profileGroupIdSet (optional)
array[Long] format: int64
predefinedProxyIdSet (optional)
array[Long] format: int64
proxyIdSet (optional)
array[Long] format: int64
trustedProxyIdSet (optional)
array[Long] format: int64
uuidSet (optional)
assignedEntityType
Enum:
PREDEFINED_ROLE
ROLE_GROUP
PROFILE
PROFILE_GROUP
PREDEFINED_PROXY
PROXY
TRUSTED_PROXY
OTHER
assignedEntityId (optional)
Long format: int64
onlyAssigned (optional)
addableIdSet (optional)
array[Long] format: int64
removeableIdSet (optional)
array[Long] format: int64

HvlOAuthRoleCopiablePersistModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
code
proxyable
description (optional)
hierarchical (optional)
authorityIdSetToAdd (optional)
array[Long] format: int64
authorityIdSetToRemove (optional)
array[Long] format: int64
sourceRoleIdToCopy (optional)
Long format: int64

HvlOAuthRoleDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name (optional)
code (optional)
editable (optional)
enabled (optional)
proxyable (optional)
description (optional)
hierarchical (optional)

HvlOAuthRoleGroupClaimDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
code
description (optional)
assignedEntityId (optional)
Long format: int64

HvlOAuthRoleGroupClaimQueryModel Up

pageable (optional)
filters (optional)
uuid (optional)
code (optional)
name (optional)
enabled (optional)
deleted (optional)
idSet (optional)
array[Long] format: int64
roleIdSet (optional)
array[Long] format: int64
authorityIdSet (optional)
array[Long] format: int64
roleAuthorityTagIdSet (optional)
array[Long] format: int64
profileIdSet (optional)
array[Long] format: int64
profileGroupIdSet (optional)
array[Long] format: int64
roleAssignerIdSet (optional)
array[Long] format: int64
assignedEntityType
Enum:
PROFILE
PROFILE_GROUP
ROLE_ASSIGNER
OTHER
assignedEntityId (optional)
Long format: int64
onlyAssigned (optional)
addableIdSet (optional)
array[Long] format: int64
removeableIdSet (optional)
array[Long] format: int64

HvlOAuthRoleGroupCopiablePersistModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
code
description (optional)
roleIdSetToAdd (optional)
array[Long] format: int64
roleIdSetToRemove (optional)
array[Long] format: int64
sourceRoleGroupIdToCopy (optional)
Long format: int64

HvlOAuthRoleGroupDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name (optional)
code (optional)
enabled (optional)
description (optional)
roleName (optional)

HvlOAuthRoleGroupModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
code
description (optional)

HvlOAuthRoleGroupPersistModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
code
description (optional)
roleIdSetToAdd (optional)
array[Long] format: int64
roleIdSetToRemove (optional)
array[Long] format: int64

HvlOAuthRoleGroupQueryModel Up

pageable (optional)
filters (optional)
uuid (optional)
code (optional)
name (optional)
enabled (optional)
deleted (optional)
idSet (optional)
array[Long] format: int64
roleIdSet (optional)
array[Long] format: int64
authorityIdSet (optional)
array[Long] format: int64
roleAuthorityTagIdSet (optional)
array[Long] format: int64
profileIdSet (optional)
array[Long] format: int64
profileGroupIdSet (optional)
array[Long] format: int64
roleAssignerIdSet (optional)
array[Long] format: int64

HvlOAuthRoleModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
code
proxyable
description (optional)
hierarchical (optional)

HvlOAuthRolePersistModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
code
proxyable
description (optional)
hierarchical (optional)
authorityIdSetToAdd (optional)
array[Long] format: int64
authorityIdSetToRemove (optional)
array[Long] format: int64

HvlOAuthRoleProfilePersistModel Up

roleUuid
profileIdSetToAdd (optional)
array[Long] format: int64
profileIdSetToRemove (optional)
array[Long] format: int64

HvlOAuthRoleQueryModel Up

pageable (optional)
filters (optional)
uuid (optional)
name (optional)
code (optional)
enabled (optional)
editable (optional)
proxyable (optional)
deleted (optional)
roleAssignerId (optional)
Long format: int64
onlyRoleAssigner (optional)
idSet (optional)
array[Long] format: int64
authorityIdSet (optional)
array[Long] format: int64
authorityTagIdSet (optional)
array[Long] format: int64
roleGroupIdSet (optional)
array[Long] format: int64
profileIdSet (optional)
array[Long] format: int64
profileGroupIdSet (optional)
array[Long] format: int64
predefinedProxyIdSet (optional)
array[Long] format: int64
proxyIdSet (optional)
array[Long] format: int64
trustedProxyIdSet (optional)
array[Long] format: int64
uuidSet (optional)

HvlOAuthSessionModel Up

username (optional)
email (optional)
tenantIdentifier (optional)
profileIdentity (optional)
profileIntegrationCode (optional)
hasProxiedProfile (optional)
userType (optional)
userIntegrationId (optional)
authorityCodeSet (optional)
googleAuthenticatorEnabled (optional)
secret (optional)

HvlOAuthSystemUserModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
profile (optional)
apiKey (optional)

HvlOAuthSystemUserQueryModel Up

pageable (optional)
filters (optional)
id (optional)
Long format: int64
uuid (optional)
username (optional)
email (optional)
deleted (optional)
startDate (optional)
Date format: date-time
endDate (optional)
Date format: date-time

HvlOAuthTagModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name

HvlOAuthTagQueryModel Up

pageable (optional)
filters (optional)
name (optional)
deleted (optional)

HvlOAuthTrustedProxyCopiablePersistModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
sourceProfileId
Long format: int64
name (optional)
roleIdSetToAdd (optional)
array[Long] format: int64
roleIdSetToRemove (optional)
array[Long] format: int64
userIdSetToAdd (optional)
array[Long] format: int64
userIdSetToRemove (optional)
array[Long] format: int64
sourceTrustedProxyIdToCopy (optional)
Long format: int64

HvlOAuthTrustedProxyDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
sourceUserUsername (optional)
sourceUserName (optional)
sourceUserSurname (optional)
name (optional)

HvlOAuthTrustedProxyModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
sourceProfileId
Long format: int64
name (optional)

HvlOAuthTrustedProxyPersistModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
sourceProfileId
Long format: int64
name (optional)
roleIdSetToAdd (optional)
array[Long] format: int64
roleIdSetToRemove (optional)
array[Long] format: int64
userIdSetToAdd (optional)
array[Long] format: int64
userIdSetToRemove (optional)
array[Long] format: int64

HvlOAuthTrustedProxyQueryModel Up

pageable (optional)
filters (optional)
uuid (optional)
sourceProfileId (optional)
Long format: int64
targetUserIdSet (optional)
array[Long] format: int64
deleted (optional)
onlyDelegated (optional)
onlyBorrowed (optional)
idSet (optional)
array[Long] format: int64
userProfilePredicateModel
name (optional)

HvlOAuthUserChangePasswordByAdminModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
ldapUpdateEnable (optional)
password (optional)

HvlOAuthUserChangePasswordModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
ldapUpdateEnable (optional)
username
oldPassword
newPassword

HvlOAuthUserChangePasswordWithVerificationModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
ldapUpdateEnable (optional)
email
newPassword
code

HvlOAuthUserClaimDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
username (optional)
system (optional)
admin (optional)
expirationDate (optional)
Date format: date-time
lockedDate (optional)
Date format: date-time
passwordUpdatedDate (optional)
Date format: date-time
userDetailDataModel (optional)
tenant (optional)
userRegistrationSourceType (optional)
Enum:
ADMIN_REGISTRATION
SELF_REGISTRATION
dn (optional)
description (optional)
assignedEntityId (optional)
Long format: int64
name (optional)
surname (optional)
email (optional)
locked (optional)
expired (optional)

HvlOAuthUserClaimQueryModel Up

pageable (optional)
filters (optional)
id (optional)
Long format: int64
uuid (optional)
username (optional)
name (optional)
surname (optional)
email (optional)
integrationCode (optional)
password (optional)
tenantIdentifier (optional)
system (optional)
locked (optional)
expired (optional)
passwordExpired (optional)
userTypeId (optional)
Long format: int64
userDetailId (optional)
Long format: int64
userDetailUuid (optional)
admin (optional)
deleted (optional)
trustedProxyIdSet (optional)
array[Long] format: int64
userRegistrationSourceType (optional)
Enum:
ADMIN_REGISTRATION
SELF_REGISTRATION
startDate (optional)
Date format: date-time
endDate (optional)
Date format: date-time
onlyWithDn (optional)
onlyNoDn (optional)
dn (optional)
assignedEntityType
Enum:
TRUSTED_PROXY
OTHER
assignedEntityId (optional)
Long format: int64
onlyAssigned (optional)
addableIdSet (optional)
array[Long] format: int64
removeableIdSet (optional)
array[Long] format: int64

HvlOAuthUserDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
username (optional)
system (optional)
admin (optional)
expirationDate (optional)
Date format: date-time
lockedDate (optional)
Date format: date-time
passwordUpdatedDate (optional)
Date format: date-time
userDetailDataModel (optional)
tenant (optional)
userRegistrationSourceType (optional)
Enum:
ADMIN_REGISTRATION
SELF_REGISTRATION
dn (optional)
description (optional)
locked (optional)
expired (optional)

HvlOAuthUserDetailDataModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name (optional)
surname (optional)
email (optional)
mobileNumber (optional)
integrationCode (optional)
userTypeDataModel (optional)

HvlOAuthUserDetailModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
surname
email (optional)
mobileNumber (optional)
userType (optional)
integrationCode (optional)
personalIdentifier (optional)
nameSurname (optional)

HvlOAuthUserDetailQueryModel Up

pageable (optional)
filters (optional)
name (optional)
surname (optional)
email (optional)
mobileNumber (optional)
emailList (optional)
userTypeId (optional)
Long format: int64
integrationCode (optional)
integrationCodeList (optional)
personalIdentifier (optional)

HvlOAuthUserInfoDataModel Up

username (optional)
userDetailInfoDataModelList (optional)
profileInfoDataModelList (optional)
profileDetailInfoDataModelList (optional)
profileGroupInfoDataModelList (optional)
roleInfoDataModelList (optional)
roleGroupInfoDataModelList (optional)

HvlOAuthUserInfoPredicateModel Up

includeUserDetailInfo (optional)
includeProfileInfo (optional)
includeProfileDetailInfo (optional)
includeProfileGroupInfo (optional)
includeRoleInfo (optional)
includeRoleGroupInfo (optional)

HvlOAuthUserLdapPersistModel Up

userUuidSet (optional)
ou

HvlOAuthUserLdapResultModel Up

failedCount (optional)
Integer format: int32
failedUserModelSet (optional)

HvlOAuthUserLockModel Up

description
uuid

HvlOAuthUserMigrationModel Up

sourceProfileIntegrationCode
targetProfileIntegrationCode
migrateOwnedRoles (optional)
migrateOwnedRoleGroups (optional)
clearRolesFromSourceProfile (optional)
clearRoleGroupsFromSourceProfile (optional)
exitExistingProfileGroupsForSourceProfile (optional)
clearRolesFromTargetProfile (optional)
clearRoleGroupsFromTargetProfile (optional)
exitExistingProfileGroupsForTargetProfile (optional)

HvlOAuthUserModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
username
userDetail (optional)
tenant (optional)
system (optional)
failedLoginCount (optional)
Integer format: int32
locked (optional)
lockedDate (optional)
Date format: date-time
lockDescription (optional)
expired (optional)
expirationDate (optional)
Date format: date-time
passwordUpdatedDate (optional)
Date format: date-time
passwordMustChange (optional)
googleAuthenticatorEnabled (optional)
dn (optional)
ou (optional)
profileName (optional)
secret (optional)
description (optional)

HvlOAuthUserPasswordPolicyModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
name
enabled (optional)
minLength (optional)
Integer format: int32
maxLength (optional)
Integer format: int32
upperCaseCharCount (optional)
Integer format: int32
lowerCaseCharCount (optional)
Integer format: int32
numericCharCount (optional)
Integer format: int32
symbolCharCount (optional)
Integer format: int32
notEqualsLastPasswordCount (optional)
Integer format: int32
threeSameCharactersAllowed (optional)
threeConsecutiveNumbersAllowed (optional)
threeConsecutiveAlphabeticalLettersAllowed (optional)
personalInformationAllowed (optional)
maxPasswordAge (optional)
Integer format: int32
allUsersPasswordMustBeChanged (optional)

HvlOAuthUserPasswordPolicyQueryModel Up

pageable (optional)
filters (optional)
uuid (optional)
name (optional)
enabled (optional)

HvlOAuthUserProfilePredicateModel Up

hasAdmin (optional)
userId
Long format: int64
profileId
Long format: int64
hasProxiedProfile (optional)

HvlOAuthUserQueryModel Up

pageable (optional)
filters (optional)
id (optional)
Long format: int64
uuid (optional)
username (optional)
name (optional)
surname (optional)
email (optional)
integrationCode (optional)
password (optional)
tenantIdentifier (optional)
system (optional)
locked (optional)
expired (optional)
passwordExpired (optional)
userTypeId (optional)
Long format: int64
userDetailId (optional)
Long format: int64
userDetailUuid (optional)
admin (optional)
deleted (optional)
trustedProxyIdSet (optional)
array[Long] format: int64
userRegistrationSourceType (optional)
Enum:
ADMIN_REGISTRATION
SELF_REGISTRATION
startDate (optional)
Date format: date-time
endDate (optional)
Date format: date-time
onlyWithDn (optional)
onlyNoDn (optional)
dn (optional)

HvlOAuthUserRegistrationCompletionModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
username
name
surname
password (optional)
email
mobileNumber (optional)
userType (optional)
code
url
description (optional)

HvlOAuthUserRegistrationRequestModel Up

email
code
url
tenant (optional)
captchaVerificationCode (optional)

HvlOAuthUserStrategyModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
userType (optional)
usernameStrategy (optional)
Enum:
NAME_SURNAME
NAME_SURNAME_WITH_DOT
NAME_FIRST_CHAR_SURNAME
NAME_SURNAME_FIRST_CHARACTER
INTEGRATION_CODE
PERSONAL_IDENTIFIER
emailStrategy (optional)
Enum:
NAME_SURNAME
NAME_SURNAME_WITH_DOT
NAME_FIRST_CHAR_SURNAME
NAME_SURNAME_FIRST_CHARACTER
emailExtension (optional)
description (optional)
enabled (optional)

HvlOAuthUserStrategyQueryModel Up

pageable (optional)
filters (optional)
id (optional)
Long format: int64
uuid (optional)
userTypeId (optional)
Long format: int64
usernameStrategy (optional)
Enum:
NAME_SURNAME
NAME_SURNAME_WITH_DOT
NAME_FIRST_CHAR_SURNAME
NAME_SURNAME_FIRST_CHARACTER
INTEGRATION_CODE
PERSONAL_IDENTIFIER
emailStrategy (optional)
Enum:
NAME_SURNAME
NAME_SURNAME_WITH_DOT
NAME_FIRST_CHAR_SURNAME
NAME_SURNAME_FIRST_CHARACTER
emailExtension (optional)
description (optional)
enabled (optional)

HvlOAuthUserTypeDataModel Up

description (optional)
code (optional)

HvlOAuthUserTypeModel Up

uuid
version (optional)
Integer format: int32
dateCreated (optional)
Date format: date-time
dateUpdated (optional)
Date format: date-time
createdBy (optional)
updatedBy (optional)
deleted
deletedDate (optional)
Date format: date-time
id
Long format: int64
code
description (optional)
orderNo (optional)
Integer format: int32
integrationCode (optional)
shortDescription (optional)
parameterType

HvlOAuthzBatchProcessingErrorModel Up

identifier (optional)
error (optional)

HvlOAuthzBatchProcessingResultModel Up

successCount (optional)
Long format: int64
failCount (optional)
Long format: int64
errorModelList (optional)

HvlPageHvlEventLogModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthAuthorityClaimDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthAuthorityDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthAuthorityTagDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthLookupModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthPasswordRestrictionModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthPredefinedProxyDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthPredefinedRoleDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthProfileDetailClaimDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthProfileDetailDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthProfileGroupClaimNodeModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthProfileGroupDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthProfileGroupModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthProfileModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthProfileUserClaimDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthProfileUserDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthProxyDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthRoleClaimDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthRoleDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthRoleGroupClaimDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthRoleGroupDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthSystemUserModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthTagModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthTrustedProxyDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthUserClaimDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthUserDataModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthUserDetailModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthUserPasswordPolicyModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageHvlOAuthUserStrategyModel Up

totalElements (optional)
Long format: int64
totalPages (optional)
Integer format: int32
pageable (optional)
data (optional)

HvlPageable Up

pageNumber (optional)
Integer format: int32
pageSize (optional)
Integer format: int32
sort (optional)

HvlResponseBoolean Up

body (optional)
errorDetail (optional)

HvlResponseHvlLdapEntryModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlLdapGroupModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthAuthorityModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthLookupModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthPasswordRestrictionModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthPredefinedProxyModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthPredefinedRoleModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthProfileDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthProfileDetailModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthProfileGroupModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthProfileModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthProxyModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthRoleGroupModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthRoleModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthSessionModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthSystemUserModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthTagModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthTrustedProxyModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthUserDetailModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthUserInfoDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthUserLdapResultModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthUserModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthUserPasswordPolicyModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthUserStrategyModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlOAuthzBatchProcessingResultModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlEventLogModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthAuthorityClaimDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthAuthorityDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthAuthorityTagDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthLookupModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthPasswordRestrictionModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthPredefinedProxyDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthPredefinedRoleDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthProfileDetailClaimDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthProfileDetailDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthProfileGroupClaimNodeModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthProfileGroupDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthProfileGroupModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthProfileModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthProfileUserClaimDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthProfileUserDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthProxyDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthRoleClaimDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthRoleDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthRoleGroupClaimDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthRoleGroupDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthSystemUserModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthTagModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthTrustedProxyDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthUserClaimDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthUserDataModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthUserDetailModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthUserPasswordPolicyModel Up

body (optional)
errorDetail (optional)

HvlResponseHvlPageHvlOAuthUserStrategyModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlLdapEntryModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlLdapGroupModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlLdapOuModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthAcquiredProfileDataModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthAuditModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthAuthorityClaimDataModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthAuthorityTagDataModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthEventLogTypeModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthLookupModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthPasswordRestrictionModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthPredefinedRoleDataModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthProfileDataModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthProfileDetailClaimDataModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthProfileDetailDataModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthProfileDetailTypeModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthProfileGroupModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthRoleDataModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthRoleGroupDataModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthSystemUserModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthTagModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthUserDetailModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthUserStrategyModel Up

body (optional)
errorDetail (optional)

HvlResponseListHvlOAuthUserTypeModel Up

body (optional)
errorDetail (optional)

HvlResponseListLong Up

body (optional)
array[Long] format: int64
errorDetail (optional)

HvlResponseListString Up

body (optional)
errorDetail (optional)

HvlResponseString Up

body (optional)
errorDetail (optional)

HvlResponseVoid Up

body (optional)
errorDetail (optional)

HvlSearchCriteria Up

field (optional)
operation (optional)
value (optional)

HvlSort Up

direction (optional)
Enum:
ASC
DESC
UNSORTED
properties (optional)

entry_remove_body Up

groupModel (optional)
entryModel (optional)

profiledetails_import_body Up

importFile
byte[] format: binary

userdetails_import_body Up

importFile
byte[] format: binary