Documentation Powered by ReDoc

ocp swagger documentation (2.8.0)

Download OpenAPI specification:Download

loggers-mvc-endpoint

Loggers Mvc Endpoint

invoke

get /management/loggers
https://localhost:9080/management/loggers

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

Response samples

Content type
application/vnd.spring-boot.actuator.v1+json
Copy
 Expand all Collapse all
{ }

module-resource

Module Resource

getBrandModuleResourceMappings

get /modules/resource-mappings/{brand}
https://localhost:9080/modules/resource-mappings/{brand}
path Parameters
brand
required
string

brand

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

getCurrentBrandModuleRoleMappings

get /modules/role-mappings
https://localhost:9080/modules/role-mappings

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

getBrandModuleRoleMappings

get /modules/role-mappings/{brand}
https://localhost:9080/modules/role-mappings/{brand}
path Parameters
brand
required
string

brand

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

getBrandModules

get /modules/{brand}
https://localhost:9080/modules/{brand}
path Parameters
brand
required
string

brand

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

setBrandModules

put /modules/{brand}
https://localhost:9080/modules/{brand}
path Parameters
brand
required
string

brand

Request Body schema: application/json

modules

Array
string
Enum: "USER_ADMINISTRATION" "BANNER" "CUSTOMER_CARE"

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "USER_ADMINISTRATION"
]

endpoint-mvc-adapter

Endpoint Mvc Adapter

invoke

get /management/info
https://localhost:9080/management/info

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

Response samples

Content type
application/vnd.spring-boot.actuator.v1+json
Copy
 Expand all Collapse all
{ }

hystrix-dashboard-controller

Hystrix Dashboard Controller

home

get /hystrix
https://localhost:9080/hystrix

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

home

head /hystrix
https://localhost:9080/hystrix

Responses

200

OK

204

No Content

401

Unauthorized

403

Forbidden

home

post /hystrix
https://localhost:9080/hystrix

Responses

200

OK

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

home

put /hystrix
https://localhost:9080/hystrix

Responses

200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

home

delete /hystrix
https://localhost:9080/hystrix

Responses

200

OK

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

home

options /hystrix
https://localhost:9080/hystrix

Responses

200

OK

204

No Content

401

Unauthorized

403

Forbidden

home

patch /hystrix
https://localhost:9080/hystrix

Responses

200

OK

204

No Content

401

Unauthorized

403

Forbidden

monitor

get /hystrix/{path}
https://localhost:9080/hystrix/{path}
path Parameters
path
required
string

path

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

monitor

head /hystrix/{path}
https://localhost:9080/hystrix/{path}
path Parameters
path
required
string

path

Responses

200

OK

204

No Content

401

Unauthorized

403

Forbidden

monitor

post /hystrix/{path}
https://localhost:9080/hystrix/{path}
path Parameters
path
required
string

path

Responses

200

OK

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

monitor

put /hystrix/{path}
https://localhost:9080/hystrix/{path}
path Parameters
path
required
string

path

Responses

200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

monitor

delete /hystrix/{path}
https://localhost:9080/hystrix/{path}
path Parameters
path
required
string

path

Responses

200

OK

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

monitor

options /hystrix/{path}
https://localhost:9080/hystrix/{path}
path Parameters
path
required
string

path

Responses

200

OK

204

No Content

401

Unauthorized

403

Forbidden

monitor

patch /hystrix/{path}
https://localhost:9080/hystrix/{path}
path Parameters
path
required
string

path

Responses

200

OK

204

No Content

401

Unauthorized

403

Forbidden

ad-config-resource

Ad Config Resource

getAllAdConfigs

get /ad-configs
https://localhost:9080/ad-configs

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

createAdConfig

post /ad-configs
https://localhost:9080/ad-configs
Request Body schema: application/json

adConfigDto

adSpaces
Array of objects (AdSpaceDto)
id
string
name
string
networkCode
string

Responses

200

OK

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "adSpaces":
    [
    ],
  • "id": "string",
  • "name": "string",
  • "networkCode": "string"
}

getConflictsMap

get /ad-configs/conflicts-map
https://localhost:9080/ad-configs/conflicts-map

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

getAdConfig

get /ad-configs/{id}
https://localhost:9080/ad-configs/{id}
path Parameters
id
required
string

id

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

updateAdConfig

put /ad-configs/{id}
https://localhost:9080/ad-configs/{id}
path Parameters
id
required
string

id

Request Body schema: application/json

adConfig

adSpaces
Array of objects (AdSpaceDto)
id
string
name
string
networkCode
string

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "adSpaces":
    [
    ],
  • "id": "string",
  • "name": "string",
  • "networkCode": "string"
}

deleteAdConfig

delete /ad-configs/{id}
https://localhost:9080/ad-configs/{id}
path Parameters
id
required
string

id

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

ad-config-preview-resource

Ad Config Preview Resource

triggerAdConfigPreview

put /ad-configs/{adConfigId}/preview/{adUserGroupId}
https://localhost:9080/ad-configs/{adConfigId}/preview/{adUserGroupId}
path Parameters
adConfigId
required
string

adConfigId

adUserGroupId
required
string

adUserGroupId

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

password-policy-resource

Password Policy Resource

getCurrentPasswordPolicy

get /brands/current/password-policy
https://localhost:9080/brands/current/password-policy

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

getPasswordPolicy

get /brands/{brand}/password-policy
https://localhost:9080/brands/{brand}/password-policy
path Parameters
brand
required
string

brand

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

updatePasswordPolicy

put /brands/{brand}/password-policy
https://localhost:9080/brands/{brand}/password-policy
path Parameters
brand
required
string

brand

Request Body schema: application/json

passwordPolicyDto

minLength
integer <int32>
requireLowerCaseLetters
boolean
requireNumbers
boolean
requireSpecialCharacters
boolean
requireUpperCaseLetters
boolean

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "minLength": 0,
  • "requireLowerCaseLetters": true,
  • "requireNumbers": true,
  • "requireSpecialCharacters": true,
  • "requireUpperCaseLetters": true
}

user-role-resource

User Role Resource

getUserRoles

get /roles/users/{user}
https://localhost:9080/roles/users/{user}
path Parameters
user
required
string

user

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

updateUserRoles

put /roles/users/{user}
https://localhost:9080/roles/users/{user}
path Parameters
user
required
string

user

Request Body schema: application/json

newRoles

Array
string
Enum: "BANNER_VIEW" "BANNER_EDIT" "CC_AGENT" "CC_EXTENDED_AGENT" "USER_ADMINISTRATION" "SUPER_ADMINISTRATOR" "SUPPORT_USER"

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • "BANNER_VIEW"
]

ad-user-config-resource

Ad User Config Resource

updateUserAdConfig

put /user-ad-configs
https://localhost:9080/user-ad-configs
Request Body schema: application/json

adUserConfigDtos

Array
adConfigId
string
adUserGroupId
string

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

permission-resource

Permission Resource

getUserPermissions

get /permissions/{brand}/{principal}
https://localhost:9080/permissions/{brand}/{principal}
path Parameters
brand
required
string

brand

principal
required
string

principal

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

updateUserPermissions

put /permissions/{brand}/{principal}
https://localhost:9080/permissions/{brand}/{principal}
path Parameters
brand
required
string

brand

principal
required
string

principal

Request Body schema: application/json

permissions

Array
operation
string
resource
string

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

ad-user-group-resource

Ad User Group Resource

getAllUserGroups

get /ad-user-groups/{brand}
https://localhost:9080/ad-user-groups/{brand}
path Parameters
brand
required
string

brand

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

createUserGroup

post /ad-user-groups/{brand}
https://localhost:9080/ad-user-groups/{brand}
path Parameters
brand
required
string

brand

Request Body schema: application/json

adUserGroupDto

contextId
required
string

The preview user context id

id
required
string

The package id

loginName
required
string

The preview username

loginPassword
required
string

The preview user password

name
required
string

The name of the group

userId
required
string

The preview user id

Responses

200

OK

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "contextId": "string",
  • "id": "string",
  • "loginName": "string",
  • "loginPassword": "string",
  • "name": "string",
  • "userId": "string"
}

getUserGroup

get /ad-user-groups/{brand}/{id}
https://localhost:9080/ad-user-groups/{brand}/{id}
path Parameters
brand
required
string

brand

id
required
string

id

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

updateUserGroup

put /ad-user-groups/{brand}/{id}
https://localhost:9080/ad-user-groups/{brand}/{id}
path Parameters
brand
required
string

brand

id
required
string

id

Request Body schema: application/json

adUserGroupDto

contextId
required
string

The preview user context id

id
required
string

The package id

loginName
required
string

The preview username

loginPassword
required
string

The preview user password

name
required
string

The name of the group

userId
required
string

The preview user id

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "contextId": "string",
  • "id": "string",
  • "loginName": "string",
  • "loginPassword": "string",
  • "name": "string",
  • "userId": "string"
}

deleteUserGroup

delete /ad-user-groups/{brand}/{id}
https://localhost:9080/ad-user-groups/{brand}/{id}
path Parameters
brand
required
string

brand

id
required
string

id

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

user-resource

User Resource

getAllUsers

get /users
https://localhost:9080/users

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

createUser

post /users
https://localhost:9080/users
Request Body schema: application/json

newUser

displayName
string

The name of the user

email
string

The email address of the user

preferredLanguage
string

The preferred language of the user

status
string
Enum: "ACTIVE" "INACTIVE"

The user account status

uid
string

The user unique identifier

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "displayName": "string",
  • "email": "string",
  • "preferredLanguage": "string",
  • "status": "ACTIVE",
  • "uid": "string"
}

getCurrentUser

get /users/current
https://localhost:9080/users/current

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

updateLanguage

put /users/current/language
https://localhost:9080/users/current/language
Request Body schema: application/json

languageDto

preferredLanguage
string

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "preferredLanguage": "string"
}

getUser

get /users/{uid}
https://localhost:9080/users/{uid}
path Parameters
uid
required
string

uid

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

updateUser

put /users/{uid}
https://localhost:9080/users/{uid}
path Parameters
uid
required
string

uid

Request Body schema: application/json

user

displayName
string

The name of the user

email
string

The email address of the user

preferredLanguage
string

The preferred language of the user

status
string
Enum: "ACTIVE" "INACTIVE"

The user account status

uid
string

The user unique identifier

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "displayName": "string",
  • "email": "string",
  • "preferredLanguage": "string",
  • "status": "ACTIVE",
  • "uid": "string"
}

deleteUser

delete /users/{uid}
https://localhost:9080/users/{uid}
path Parameters
uid
required
string

uid

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

mailbox-resource

Mailbox Resource

getMailboxByUsername

get /mailboxes
https://localhost:9080/mailboxes
query Parameters
username
required
string

username

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

getMailboxAliases

get /mailboxes/{userId}/aliases
https://localhost:9080/mailboxes/{userId}/aliases
path Parameters
userId
required
string

userId

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

createMailboxAliases

post /mailboxes/{userId}/aliases
https://localhost:9080/mailboxes/{userId}/aliases
path Parameters
userId
required
string

userId

Request Body schema: application/json

alias

string

Responses

200

OK

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
"string"

getMailboxAliasesAvailable

get /mailboxes/{userId}/aliases/available/{aliasAddress}
https://localhost:9080/mailboxes/{userId}/aliases/available/{aliasAddress}
path Parameters
userId
required
string

userId

aliasAddress
required
string

aliasAddress

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

deleteMailboxAliases

delete /mailboxes/{userId}/aliases/{alias}
https://localhost:9080/mailboxes/{userId}/aliases/{alias}
path Parameters
userId
required
string

userId

alias
required
string

alias

Responses

202

Accepted

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

getAntispamBlacklist

get /mailboxes/{userId}/antispam/blacklist
https://localhost:9080/mailboxes/{userId}/antispam/blacklist
path Parameters
userId
required
string

userId

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

deleteAntispamBlacklistEntry

delete /mailboxes/{userId}/antispam/blacklist/{entry}
https://localhost:9080/mailboxes/{userId}/antispam/blacklist/{entry}
path Parameters
userId
required
string

userId

entry
required
string

entry

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

getAntispamWhitelist

get /mailboxes/{userId}/antispam/whitelist
https://localhost:9080/mailboxes/{userId}/antispam/whitelist
path Parameters
userId
required
string

userId

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

deleteAntispamWhitelistEntry

delete /mailboxes/{userId}/antispam/whitelist/{entry}
https://localhost:9080/mailboxes/{userId}/antispam/whitelist/{entry}
path Parameters
userId
required
string

userId

entry
required
string

entry

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

getFilters

get /mailboxes/{userId}/filters
https://localhost:9080/mailboxes/{userId}/filters
path Parameters
userId
required
string

userId

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

getMailboxLogins

get /mailboxes/{userId}/logins
https://localhost:9080/mailboxes/{userId}/logins
path Parameters
userId
required
string

userId

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

getMailboxPermissions

get /mailboxes/{userId}/permissions
https://localhost:9080/mailboxes/{userId}/permissions
path Parameters
userId
required
string

userId

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

updateMailboxPermissions

put /mailboxes/{userId}/permissions
https://localhost:9080/mailboxes/{userId}/permissions
path Parameters
userId
required
string

userId

Request Body schema: application/json

permissions

Responses

200

OK

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{ }

getMailboxQuota

get /mailboxes/{userId}/quota
https://localhost:9080/mailboxes/{userId}/quota
path Parameters
userId
required
string

userId

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

getMailboxSender

get /mailboxes/{userId}/sender
https://localhost:9080/mailboxes/{userId}/sender
path Parameters
userId
required
string

userId

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

session-resource

Session Resource

setNewPassword

post /session/password
https://localhost:9080/session/password
Request Body schema: application/json

passwordDto

current
string
first
string
second
string

Responses

201

Created

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "current": "string",
  • "first": "string",
  • "second": "string"
}

updatePassword

put /session/password
https://localhost:9080/session/password
Request Body schema: application/json

passwordDto

current
string
first
string
second
string

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "current": "string",
  • "first": "string",
  • "second": "string"
}

user

get /session/principal
https://localhost:9080/session/principal

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

processUserToken

get /session/sudo/{brand}
https://localhost:9080/session/sudo/{brand}
path Parameters
brand
required
string

brand

Responses

200

OK

301

Moved Permanently

401

Unauthorized

403

Forbidden

404

Not Found

processSupporterToken

get /session/support/{brand}
https://localhost:9080/session/support/{brand}
path Parameters
brand
required
string

brand

Responses

200

OK

301

Moved Permanently

401

Unauthorized

403

Forbidden

404

Not Found

processUserToken

get /session/tokens/{tokenId}
https://localhost:9080/session/tokens/{tokenId}
path Parameters
tokenId
required
string

tokenId

Responses

200

OK

301

Moved Permanently

401

Unauthorized

403

Forbidden

404

Not Found

brand-resource

Brand Resource

getBrands

get /brands
https://localhost:9080/brands

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

createBrand

post /brands
https://localhost:9080/brands
Request Body schema: application/json

brandDto

appSuiteUrl
required
string

A link to the OX app suite

defaultLanguage
required
string

The brand's default language

externalHost
required
string

The external hostname (FQDN) of the brand

helpUrl
string

A link to a support page

host
required
string

The hostname which maps to the brand

name
required
string

The name of the brand

rememberMe
boolean

Enable rememberMe feature

rememberMeTokenValidity
integer <int32>
smtpHost
required
string

The mail server host

smtpPassword
string

The mail server password

smtpPort
required
integer <int32>

The mail server port

smtpSenderAddress
required
string

The sender e-mail address

smtpSenderName
required
string

The name of the sender

smtpUsername
string

The mail server username

title
required
string

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

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "appSuiteUrl": "string",
  • "defaultLanguage": "string",
  • "externalHost": "string",
  • "helpUrl": "string",
  • "host": "string",
  • "name": "string",
  • "rememberMe": false,
  • "rememberMeTokenValidity": 0,
  • "smtpHost": "string",
  • "smtpPassword": "string",
  • "smtpPort": 0,
  • "smtpSenderAddress": "string",
  • "smtpSenderName": "string",
  • "smtpUsername": "string",
  • "title": "string"
}

getCurrentBrand

get /brands/current
https://localhost:9080/brands/current

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

getCurrentBrandStyle

get /brands/current/css
https://localhost:9080/brands/current/css

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

getCurrentBrandLogo

get /brands/current/logo
https://localhost:9080/brands/current/logo

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

getBrand

get /brands/{brand}
https://localhost:9080/brands/{brand}
path Parameters
brand
required
string

brand

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

updateBrand

put /brands/{brand}
https://localhost:9080/brands/{brand}
path Parameters
brand
required
string

brand

Request Body schema: application/json

brandDto

appSuiteUrl
required
string

A link to the OX app suite

defaultLanguage
required
string

The brand's default language

externalHost
required
string

The external hostname (FQDN) of the brand

helpUrl
string

A link to a support page

host
required
string

The hostname which maps to the brand

name
required
string

The name of the brand

rememberMe
boolean

Enable rememberMe feature

rememberMeTokenValidity
integer <int32>
smtpHost
required
string

The mail server host

smtpPassword
string

The mail server password

smtpPort
required
integer <int32>

The mail server port

smtpSenderAddress
required
string

The sender e-mail address

smtpSenderName
required
string

The name of the sender

smtpUsername
string

The mail server username

title
required
string

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

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "appSuiteUrl": "string",
  • "defaultLanguage": "string",
  • "externalHost": "string",
  • "helpUrl": "string",
  • "host": "string",
  • "name": "string",
  • "rememberMe": false,
  • "rememberMeTokenValidity": 0,
  • "smtpHost": "string",
  • "smtpPassword": "string",
  • "smtpPort": 0,
  • "smtpSenderAddress": "string",
  • "smtpSenderName": "string",
  • "smtpUsername": "string",
  • "title": "string"
}

deleteBrand

delete /brands/{brand}
https://localhost:9080/brands/{brand}
path Parameters
brand
required
string

brand

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

getBrandStyle

get /brands/{brand}/css
https://localhost:9080/brands/{brand}/css
path Parameters
brand
required
string

brand

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

updateBrandCss

put /brands/{brand}/css
https://localhost:9080/brands/{brand}/css
path Parameters
brand
required
string

brand

Request Body schema: multipart/form-data
file
required
string <binary>

file

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

getBrandLogo

get /brands/{brand}/logo
https://localhost:9080/brands/{brand}/logo
path Parameters
brand
required
string

brand

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found

updateBrandLogo

put /brands/{brand}/logo
https://localhost:9080/brands/{brand}/logo
path Parameters
brand
required
string

brand

Request Body schema: multipart/form-data
file
required
string <binary>

file

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

security-process-resource

Security Process Resource

resetPassword

put /security/reset-password
https://localhost:9080/security/reset-password
Request Body schema: application/json

requestData

payload
string

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "payload": "string"
}

revokePassword

put /security/revoke-password
https://localhost:9080/security/revoke-password
Request Body schema: application/json

requestData

payload
string

Responses

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "payload": "string"
}

login-logout-endpoints

login

post /session/login
https://localhost:9080/session/login

Login method

Request Body schema: application/x-www-form-urlencoded
username
required
string

login of the user

password
required
string

password of the user

remember-me
boolean

enable user session cookies (remember-me)

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

logout

get /session/logout
https://localhost:9080/session/logout

Logout method

Responses

200

OK

401

Unauthorized

403

Forbidden

404

Not Found