Overview

Version information

Version : 2.3.0

URI scheme

Host : localhost:9080
BasePath : /

Tags

  • loggers-mvc-endpoint : Loggers Mvc Endpoint

  • module-resource : Module Resource

  • endpoint-mvc-adapter : Endpoint Mvc Adapter

  • hystrix-dashboard-controller : Hystrix Dashboard Controller

  • ad-config-resource : Ad Config Resource

  • ad-config-preview-resource : Ad Config Preview Resource

  • password-policy-resource : Password Policy Resource

  • user-role-resource : User Role Resource

  • ad-user-config-resource : Ad User Config Resource

  • permission-resource : Permission Resource

  • ad-user-group-resource : Ad User Group Resource

  • user-resource : User Resource

  • mailbox-resource : Mailbox Resource

  • security-process : Security Process

  • session-resource : Session Resource

  • brand-resource : Brand Resource

Paths

createAdConfig

POST /ad-configs

Parameters

Type Name Description Schema Default

Body

adConfigDto
required

adConfigDto

AdConfigDto

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • ad-config-resource

getAllAdConfigs

GET /ad-configs

Responses

HTTP Code Description Schema

200

OK

< AdConfigDto > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • ad-config-resource

getConflictsMap

GET /ad-configs/conflicts-map

Responses

HTTP Code Description Schema

200

OK

< string, < string > array > map

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • ad-config-resource

triggerAdConfigPreview

PUT /ad-configs/{adConfigId}/preview/{adUserGroupId}

Parameters

Type Name Description Schema Default

Path

adConfigId
required

adConfigId

string

Path

adUserGroupId
required

adUserGroupId

string

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • ad-config-preview-resource

getAdConfig

GET /ad-configs/{id}

Parameters

Type Name Description Schema Default

Path

id
required

id

string

Responses

HTTP Code Description Schema

200

OK

AdConfigDto

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • ad-config-resource

updateAdConfig

PUT /ad-configs/{id}

Parameters

Type Name Description Schema Default

Path

id
required

id

string

Body

adConfig
required

adConfig

AdConfigDto

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • ad-config-resource

deleteAdConfig

DELETE /ad-configs/{id}

Parameters

Type Name Description Schema Default

Path

id
required

id

string

Responses

HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • ad-config-resource

createUserGroup

POST /ad-user-groups/{brand}

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Body

adUserGroupDto
required

adUserGroupDto

AdUserGroupDto

Responses

HTTP Code Description Schema

200

OK

No Content

201

Created

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • ad-user-group-resource

getAllUserGroups

GET /ad-user-groups/{brand}

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Responses

HTTP Code Description Schema

200

OK

< AdUserGroupDto > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • ad-user-group-resource

getUserGroup

GET /ad-user-groups/{brand}/{id}

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Path

id
required

id

string

Responses

HTTP Code Description Schema

200

OK

AdUserGroupDto

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • ad-user-group-resource

updateUserGroup

PUT /ad-user-groups/{brand}/{id}

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Path

id
required

id

string

Body

adUserGroupDto
required

adUserGroupDto

AdUserGroupDto

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • ad-user-group-resource

deleteUserGroup

DELETE /ad-user-groups/{brand}/{id}

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Path

id
required

id

string

Responses

HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • ad-user-group-resource

createBrand

POST /brands

Parameters

Type Name Description Schema Default

Body

brandDto
required

brandDto

BrandDto

Responses

HTTP Code Description Schema

201

Created

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • brand-resource

getBrands

GET /brands

Responses

HTTP Code Description Schema

200

OK

< BrandDto > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • brand-resource

getCurrentBrand

GET /brands/current

Responses

HTTP Code Description Schema

200

OK

BrandDto

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • brand-resource

getCurrentBrandStyle

GET /brands/current/css

Responses

HTTP Code Description Schema

200

OK

InputStreamResource

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • brand-resource

getCurrentBrandLogo

GET /brands/current/logo

Responses

HTTP Code Description Schema

200

OK

InputStreamResource

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • brand-resource

getCurrentPasswordPolicy

GET /brands/current/password-policy

Responses

HTTP Code Description Schema

200

OK

PasswordPolicyDto

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • password-policy-resource

getBrand

GET /brands/{brand}

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Responses

HTTP Code Description Schema

200

OK

BrandDto

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • brand-resource

updateBrand

PUT /brands/{brand}

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Body

brandDto
required

brandDto

BrandDto

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • brand-resource

deleteBrand

DELETE /brands/{brand}

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Responses

HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • brand-resource

getBrandStyle

GET /brands/{brand}/css

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Responses

HTTP Code Description Schema

200

OK

InputStreamResource

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • brand-resource

updateBrandCss

PUT /brands/{brand}/css

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

FormData

file
required

file

file

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • multipart/form-data

Produces

  • /

Tags

  • brand-resource

getBrandLogo

GET /brands/{brand}/logo

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Responses

HTTP Code Description Schema

200

OK

InputStreamResource

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • brand-resource

updateBrandLogo

PUT /brands/{brand}/logo

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

FormData

file
required

file

file

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • multipart/form-data

Produces

  • /

Tags

  • brand-resource

getPasswordPolicy

GET /brands/{brand}/password-policy

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Responses

HTTP Code Description Schema

200

OK

PasswordPolicyDto

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • password-policy-resource

updatePasswordPolicy

PUT /brands/{brand}/password-policy

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Body

passwordPolicyDto
required

passwordPolicyDto

PasswordPolicyDto

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • password-policy-resource

home

POST /hystrix

Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • hystrix-dashboard-controller

home

GET /hystrix

Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • hystrix-dashboard-controller

home

PUT /hystrix

Responses

HTTP Code Description Schema

200

OK

string

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • hystrix-dashboard-controller

home

DELETE /hystrix

Responses

HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • hystrix-dashboard-controller

home

PATCH /hystrix

Responses

HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • hystrix-dashboard-controller

home

HEAD /hystrix

Responses

HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • hystrix-dashboard-controller

home

OPTIONS /hystrix

Responses

HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • hystrix-dashboard-controller

monitor

POST /hystrix/{path}

Parameters

Type Name Description Schema Default

Path

path
required

path

string

Responses

HTTP Code Description Schema

200

OK

string

201

Created

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • hystrix-dashboard-controller

monitor

GET /hystrix/{path}

Parameters

Type Name Description Schema Default

Path

path
required

path

string

Responses

HTTP Code Description Schema

200

OK

string

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • hystrix-dashboard-controller

monitor

PUT /hystrix/{path}

Parameters

Type Name Description Schema Default

Path

path
required

path

string

Responses

HTTP Code Description Schema

200

OK

string

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • hystrix-dashboard-controller

monitor

DELETE /hystrix/{path}

Parameters

Type Name Description Schema Default

Path

path
required

path

string

Responses

HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • hystrix-dashboard-controller

monitor

PATCH /hystrix/{path}

Parameters

Type Name Description Schema Default

Path

path
required

path

string

Responses

HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • hystrix-dashboard-controller

monitor

HEAD /hystrix/{path}

Parameters

Type Name Description Schema Default

Path

path
required

path

string

Responses

HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • hystrix-dashboard-controller

monitor

OPTIONS /hystrix/{path}

Parameters

Type Name Description Schema Default

Path

path
required

path

string

Responses

HTTP Code Description Schema

200

OK

string

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • hystrix-dashboard-controller

GET /logout

Description

Logout method

Responses

HTTP Code Description Schema

200

OK

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Tags

  • login-logout-endpoints

getMailboxByEmail

GET /mailboxes

Parameters

Type Name Description Schema Default

Query

email
required

email

string

Responses

HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • mailbox-resource

createMailboxAliases

POST /mailboxes/{userId}/aliases

Parameters

Type Name Description Schema Default

Path

userId
required

userId

string

Body

alias
required

alias

string

Responses

HTTP Code Description Schema

200

OK

< string > array

201

Created

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • mailbox-resource

getMailboxAliases

GET /mailboxes/{userId}/aliases

Parameters

Type Name Description Schema Default

Path

userId
required

userId

string

Responses

HTTP Code Description Schema

200

OK

< string > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • mailbox-resource

getMailboxAliasesAvailable

GET /mailboxes/{userId}/aliases/available/{aliasAddress}

Parameters

Type Name Description Schema Default

Path

aliasAddress
required

aliasAddress

string

Path

userId
required

userId

string

Responses

HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • mailbox-resource

deleteMailboxAliases

DELETE /mailboxes/{userId}/aliases/{alias}

Parameters

Type Name Description Schema Default

Path

alias
required

alias

string

Path

userId
required

userId

string

Responses

HTTP Code Description Schema

202

Accepted

No Content

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • mailbox-resource

getAntispamBlacklist

GET /mailboxes/{userId}/antispam/blacklist

Parameters

Type Name Description Schema Default

Path

userId
required

userId

string

Responses

HTTP Code Description Schema

200

OK

< string > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • mailbox-resource

deleteAntispamBlacklistEntry

DELETE /mailboxes/{userId}/antispam/blacklist/{entry}

Parameters

Type Name Description Schema Default

Path

entry
required

entry

string

Path

userId
required

userId

string

Responses

HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • mailbox-resource

getAntispamWhitelist

GET /mailboxes/{userId}/antispam/whitelist

Parameters

Type Name Description Schema Default

Path

userId
required

userId

string

Responses

HTTP Code Description Schema

200

OK

< string > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • mailbox-resource

deleteAntispamWhitelistEntry

DELETE /mailboxes/{userId}/antispam/whitelist/{entry}

Parameters

Type Name Description Schema Default

Path

entry
required

entry

string

Path

userId
required

userId

string

Responses

HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • mailbox-resource

getFilters

GET /mailboxes/{userId}/filters

Parameters

Type Name Description Schema Default

Path

userId
required

userId

string

Responses

HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • mailbox-resource

getMailboxLogins

GET /mailboxes/{userId}/logins

Parameters

Type Name Description Schema Default

Path

userId
required

userId

string

Responses

HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • mailbox-resource

getMailboxPermissions

GET /mailboxes/{userId}/permissions

Parameters

Type Name Description Schema Default

Path

userId
required

userId

string

Responses

HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • mailbox-resource

updateMailboxPermissions

PUT /mailboxes/{userId}/permissions

Parameters

Type Name Description Schema Default

Path

userId
required

userId

string

Body

permissions
required

permissions

object

Responses

HTTP Code Description Schema

200

OK

object

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • mailbox-resource

getMailboxQuota

GET /mailboxes/{userId}/quota

Parameters

Type Name Description Schema Default

Path

userId
required

userId

string

Responses

HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • mailbox-resource

getMailboxSender

GET /mailboxes/{userId}/sender

Parameters

Type Name Description Schema Default

Path

userId
required

userId

string

Responses

HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • mailbox-resource

invoke

GET /management/info

Responses

HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

Tags

  • endpoint-mvc-adapter

invoke

GET /management/loggers

Responses

HTTP Code Description Schema

200

OK

object

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • application/vnd.spring-boot.actuator.v1+json

  • application/json

Tags

  • loggers-mvc-endpoint

getBrandModuleResourceMappings

GET /modules/resource-mappings/{brand}

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Responses

HTTP Code Description Schema

200

OK

< ModuleResourceMappingDto > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • module-resource

getBrandModuleRoleMappings

GET /modules/role-mappings

Responses

HTTP Code Description Schema

200

OK

< ModuleRoleMappingDto > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • module-resource

getBrandModules

GET /modules/{brand}

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Responses

HTTP Code Description Schema

200

OK

< enum (USER_ADMINISTRATION, BANNER, CUSTOMER_CARE) > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • module-resource

setBrandModules

PUT /modules/{brand}

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Body

modules
required

modules

< enum (USER_ADMINISTRATION, BANNER, CUSTOMER_CARE) > array

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • module-resource

getUserPermissions

GET /permissions/{brand}/{principal}

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Path

principal
required

principal

string

Responses

HTTP Code Description Schema

200

OK

< PermissionDto > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • permission-resource

updateUserPermissions

PUT /permissions/{brand}/{principal}

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Path

principal
required

principal

string

Body

permissions
required

permissions

< PermissionDto > array

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • permission-resource

getUserRoles

GET /roles/users/{user}

Parameters

Type Name Description Schema Default

Path

user
required

user

string

Responses

HTTP Code Description Schema

200

OK

< enum (BANNER_VIEW, BANNER_EDIT, CC_AGENT, CC_EXTENDED_AGENT, USER_ADMINISTRATION) > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • user-role-resource

updateUserRoles

PUT /roles/users/{user}

Parameters

Type Name Description Schema Default

Path

user
required

user

string

Body

newRoles
required

newRoles

< enum (BANNER_VIEW, BANNER_EDIT, CC_AGENT, CC_EXTENDED_AGENT, USER_ADMINISTRATION) > array

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • user-role-resource

resetPassword

PUT /security/reset-password

Parameters

Type Name Description Schema Default

Body

requestData
required

requestData

PasswordRequestDto

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • security-process

revokePassword

PUT /security/revoke-password

Parameters

Type Name Description Schema Default

Body

requestData
required

requestData

PasswordRequestDto

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • security-process

setNewPassword

POST /session/password

Parameters

Type Name Description Schema Default

Body

passwordDto
required

passwordDto

PasswordDto

Responses

HTTP Code Description Schema

201

Created

No Content

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • session-resource

updatePassword

PUT /session/password

Parameters

Type Name Description Schema Default

Body

passwordDto
required

passwordDto

PasswordDto

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • session-resource

user

GET /session/principal

Responses

HTTP Code Description Schema

200

OK

Session

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • session-resource

processUserToken

GET /session/sudo/{brand}

Parameters

Type Name Description Schema Default

Path

brand
required

brand

string

Responses

HTTP Code Description Schema

200

OK

No Content

301

Moved Permanently

ResponseEntity

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • session-resource

processUserToken

GET /session/tokens/{tokenId}

Parameters

Type Name Description Schema Default

Path

tokenId
required

tokenId

string

Responses

HTTP Code Description Schema

200

OK

No Content

301

Moved Permanently

ResponseEntity

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • session-resource

updateUserAdConfig

PUT /user-ad-configs

Parameters

Type Name Description Schema Default

Body

adUserConfigDtos
required

adUserConfigDtos

< AdUserConfigDto > array

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • ad-user-config-resource

createUser

POST /users

Parameters

Type Name Description Schema Default

Body

newUser
required

newUser

UserDto

Responses

HTTP Code Description Schema

201

Created

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • user-resource

getAllUsers

GET /users

Responses

HTTP Code Description Schema

200

OK

< UserDto > array

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • user-resource

getCurrentUser

GET /users/current

Responses

HTTP Code Description Schema

200

OK

UserDto

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • user-resource

updateLanguage

PUT /users/current/language

Parameters

Type Name Description Schema Default

Body

languageDto
required

languageDto

LanguageDto

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • user-resource

getUser

GET /users/{uid}

Parameters

Type Name Description Schema Default

Path

uid
required

uid

string

Responses

HTTP Code Description Schema

200

OK

UserDto

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • user-resource

updateUser

PUT /users/{uid}

Parameters

Type Name Description Schema Default

Path

uid
required

uid

string

Body

user
required

user

UserDto

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • user-resource

deleteUser

DELETE /users/{uid}

Parameters

Type Name Description Schema Default

Path

uid
required

uid

string

Responses

HTTP Code Description Schema

204

No Content

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

404

Not Found

No Content

Consumes

  • application/json

Produces

  • /

Tags

  • user-resource

POST /web/html/login

Description

Login method

Parameters

Type Name Description Schema Default

FormData

password
required

password of the user

string

FormData

remember-me
optional

enable user session cookies (remember-me)

boolean

FormData

username
required

login of the user

string

Responses

HTTP Code Description Schema

201

Created

No Content

400

Bad Request

No Content

401

Unauthorized

No Content

403

Forbidden

No Content

Consumes

  • application/x-www-form-urlencoded

Tags

  • login-logout-endpoints

Definitions

AdConfigDto

Name Description Schema

adSpaces
optional

< AdSpaceDto > array

id
optional

string

name
optional

string

networkCode
optional

string

AdSpaceDto

Name Description Schema

adConfigId
optional

string

adModuleId
optional

string

coolDown
optional

integer(int32)

enabled
optional

boolean

googlePublisherTags
optional

< string, string > map

id
optional

string

position
optional

integer(int32)

reloadAfter
optional

integer(int32)

AdUserConfigDto

Name Description Schema

adConfigId
optional

string

adUserGroupId
optional

string

AdUserGroupDto

Name Description Schema

adConfigId
optional

The associated ad-config (read only)

string

contextId
required

The preview user context id

string

id
required

The package id

string

loginName
required

The preview username

string

loginPassword
required

The preview user password

string

name
required

The name of the group

string

published
optional

The status if publised (read only)
Example : false

boolean

userId
required

The preview user id

string

BrandDto

Name Description Schema

appSuiteUrl
required

A link to the OX app suite

string

defaultLanguage
required

The brand’s default language

string

helpUrl
optional

A link to a support page

string

host
required

The hostname which maps to the brand

string

name
required

The name of the brand

string

rememberMe
optional

Enable rememberMe feature
Example : false

boolean

rememberMeTokenValidity
optional

integer(int32)

smtpHost
required

The mail server host

string

smtpPassword
optional

The mail server password

string

smtpPort
required

The mail server port

integer(int32)

smtpSenderAddress
required

The sender e-mail address

string

smtpSenderName
required

The name of the sender

string

smtpUsername
optional

The mail server username

string

title
required

The title which is used in the web GUI e.g. for the page title

string

File

Name Description Schema

absolute
optional

boolean

absoluteFile
optional

File

absolutePath
optional

string

canonicalFile
optional

File

canonicalPath
optional

string

directory
optional

boolean

file
optional

boolean

freeSpace
optional

integer(int64)

hidden
optional

boolean

name
optional

string

parent
optional

string

parentFile
optional

File

path
optional

string

totalSpace
optional

integer(int64)

usableSpace
optional

integer(int64)

InputStream

Type : object

InputStreamResource

Name Description Schema

description
optional

string

file
optional

File

filename
optional

string

inputStream
optional

InputStream

open
optional

boolean

readable
optional

boolean

uri
optional

URI

url
optional

URL

LanguageDto

Name Description Schema

preferredLanguage
optional

string

ModuleResourceMappingDto

Name Description Schema

module
optional

string

resource
optional

string

ModuleRoleMappingDto

Name Description Schema

module
optional

string

role
optional

string

PasswordDto

Name Description Schema

current
optional

string

first
optional

string

second
optional

string

PasswordPolicyDto

Name Description Schema

minLength
optional

integer(int32)

requireLowerCaseLetters
optional

boolean

requireNumbers
optional

boolean

requireSpecialCharacters
optional

boolean

requireUpperCaseLetters
optional

boolean

PasswordRequestDto

Name Description Schema

payload
optional

string

PermissionDto

Name Description Schema

operation
optional

string

resource
optional

string

ResponseEntity

Name Description Schema

body
optional

object

statusCode
optional

enum (100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511)

statusCodeValue
optional

integer(int32)

Session

Name Description Schema

brand
optional

string

displayName
optional

string

permissions
optional

< string > array

uid
optional

string

URI

Name Description Schema

absolute
optional

boolean

authority
optional

string

fragment
optional

string

host
optional

string

opaque
optional

boolean

path
optional

string

port
optional

integer(int32)

query
optional

string

rawAuthority
optional

string

rawFragment
optional

string

rawPath
optional

string

rawQuery
optional

string

rawSchemeSpecificPart
optional

string

rawUserInfo
optional

string

scheme
optional

string

schemeSpecificPart
optional

string

userInfo
optional

string

URL

Name Description Schema

authority
optional

string

content
optional

object

defaultPort
optional

integer(int32)

file
optional

string

host
optional

string

path
optional

string

port
optional

integer(int32)

protocol
optional

string

query
optional

string

ref
optional

string

userInfo
optional

string

UserDto

Name Description Schema

displayName
optional

The name of the user

string

email
optional

The email address of the user

string

preferredLanguage
optional

The preferred language of the user

string

status
optional

The user account status

string

uid
optional

The user unique identifier

string