- 1. Access
- 2. Endpoints
- 2.1. ApplicationLinks
- 2.2. Authentication
- 2.3. Cache
- 2.4. Directories
- 2.5. Gadgets
- 2.6. Licenses
- 2.7. MailServer
- 2.8. Permissions
- 2.9. Ping
- 2.10. Settings
- 2.11. Users
- 3. Models
- 3.1. AbstractDirectoryBean
- 3.2. ApplicationLinkBean
- 3.3. ApplicationLinksBean
- 3.4. AuthenticationIdpOidcBean
- 3.5. AuthenticationIdpsBean
- 3.6. AuthenticationSsoBean
- 3.7. CacheBean
- 3.8. CachesBean
- 3.9. DirectoriesBean
- 3.10. DirectoryCrowdAdvanced
- 3.11. DirectoryCrowdBean
- 3.12. DirectoryCrowdPermissions
- 3.13. DirectoryCrowdServer
- 3.14. DirectoryCrowdServerProxy
- 3.15. DirectoryDelegatingBean
- 3.16. DirectoryDelegatingConfiguration
- 3.17. DirectoryDelegatingConnector
- 3.18. DirectoryGenericBean
- 3.19. DirectoryInternalAdvanced
- 3.20. DirectoryInternalBean
- 3.21. DirectoryInternalCredentialPolicy
- 3.22. DirectoryLdapBean
- 3.23. DirectoryLdapPermissions
- 3.24. DirectoryLdapSchema
- 3.25. DirectoryLdapServer
- 3.26. DirectoryPermissions
- 3.27. ErrorCollection
- 3.28. GadgetBean
- 3.29. GadgetsBean
- 3.30. GroupBean
- 3.31. LicenseBean
- 3.32. LicensesBean
- 3.33. MailServerPopBean
- 3.34. MailServerSmtpBean
- 3.35. PermissionAnonymousAccessBean
- 3.36. SettingsBean
- 3.37. SettingsBrandingColorSchemeBean
- 3.38. UserBean
This plugin provides methods for accessing configuration for Confluence.
POST /application-links
Add an application link
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
ApplicationLinkBean |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the added application link. |
|
0 |
Returns a list of error messages. |
DELETE /application-links/{uuid}
Delete an application link
| Code | Message | Datatype |
|---|---|---|
200 |
Returns an empty body. |
<<>> |
0 |
Returns a list of error messages. |
DELETE /application-links
Delete all application links
| Code | Message | Datatype |
|---|---|---|
200 |
Returns an empty body. |
<<>> |
0 |
Returns a list of error messages. |
GET /application-links/{uuid}
Get an application link
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the requested application link. |
|
0 |
Returns a list of error messages. |
GET /application-links
Get all application links
| Code | Message | Datatype |
|---|---|---|
200 |
Returns all application links. |
|
0 |
Returns a list of error messages. |
PUT /application-links/{uuid}
Update an application link
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
ApplicationLinkBean |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the updated application link. |
|
0 |
Returns a list of error messages. |
PUT /application-links
Set or update a list of application links
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
ApplicationLinksBean |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns all application links. |
|
0 |
Returns a list of error messages. |
GET /authentication/idps
Get all authentication identity providers
| Code | Message | Datatype |
|---|---|---|
200 |
Returns all authentication identity providers. |
|
0 |
Returns a list of error messages. |
GET /authentication/sso
Get authentication SSO configuration
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the authentication SSO configuration. |
|
0 |
Returns a list of error messages. |
PATCH /authentication/idps
Set all authentication identity providers
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
AuthenticationIdpsBean |
- |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the set authentication identity providers. |
|
0 |
Returns a list of error messages. |
PATCH /authentication/sso
Set authentication SSO configuration
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
AuthenticationSsoBean |
- |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the set authentication SSO configuration. |
|
0 |
Returns a list of error messages. |
POST /caches/{name}/flush
Flushes a cache
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the emptied Cache. |
|
0 |
Returns a list of error messages. |
GET /caches/{name}
Read cache information for a specified cache
| Code | Message | Datatype |
|---|---|---|
200 |
Returns configuration for a given cache. |
|
0 |
Returns a list of error messages. |
GET /caches
Read all cache informations
| Code | Message | Datatype |
|---|---|---|
200 |
Returns all information for current cache configuration. |
|
0 |
Returns a list of error messages. |
PUT /caches/{name}
Update an existing cache-size. Only Setting maxObjectCount is supported.
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
CacheBean |
- |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the modified Cache. |
|
0 |
Returns a list of error messages. |
POST /directories
Add a user directory
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
AbstractDirectoryBean |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the added directory. |
|
0 |
Returns a list of error messages. |
DELETE /directories
Delete all user directories
| Code | Message | Datatype |
|---|---|---|
200 |
Returns an empty body. |
<<>> |
0 |
Returns a list of error messages. |
DELETE /directories/{id}
Delete a user directory
| Code | Message | Datatype |
|---|---|---|
200 |
Returns an empty body. |
<<>> |
0 |
Returns a list of error messages. |
GET /directories
Get all user directories
| Code | Message | Datatype |
|---|---|---|
200 |
Returns all directories. |
|
0 |
Returns a list of error messages. |
GET /directories/{id}
Get a user directory
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the requested directory. |
|
0 |
Returns a list of error messages. |
PUT /directories
Set or update a list of user directories
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
DirectoriesBean |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns all directories. |
|
0 |
Returns a list of error messages. |
PUT /directories/{id}
Update a user directory
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
AbstractDirectoryBean |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the updated directory. |
|
0 |
Returns a list of error messages. |
POST /gadgets
Add a gadget
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
GadgetBean |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the added gadget. |
|
0 |
Returns a list of error messages. |
DELETE /gadgets/{id}
Delete a gadget
| Code | Message | Datatype |
|---|---|---|
200 |
Returns an empty body. |
<<>> |
0 |
Returns a list of error messages. |
DELETE /gadgets
Delete all gadgets
| Code | Message | Datatype |
|---|---|---|
200 |
Returns an empty body. |
<<>> |
0 |
Returns a list of error messages. |
GET /gadgets/{id}
Get a gadget
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the requested gadget. |
|
0 |
Returns a list of error messages. |
GET /gadgets
Get all gadgets
| Code | Message | Datatype |
|---|---|---|
200 |
Returns all gadgets. |
|
0 |
Returns a list of error messages. |
PUT /gadgets/{id}
Update a gadget
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
GadgetBean |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the updated gadget. |
|
0 |
Returns a list of error messages. |
PUT /gadgets
Set or update a list of gadgets
|
Note
|
This will only create gadgets that does not exist yet as there is no real 'update'. |
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
GadgetsBean |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns all gadgets. |
|
0 |
Returns a list of error messages. |
POST /licenses
Add a license
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
LicenseBean |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the added license details |
|
0 |
Returns a list of error messages. |
GET /licenses
Get all licenses information
Upon successful request, returns a LicensesBean object containing license details. Be aware that products collection of the LicenseBean contains the product display names, not the product key names
| Code | Message | Datatype |
|---|---|---|
200 |
Returns a list of all licenses (NOTE: for all applications except Jira this will return a single license) |
|
0 |
Returns a list of error messages. |
GET /mail-server/pop
Get the default POP mail server
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the default POP mail server's details. |
|
204 |
Returns an error message explaining that no default POP mail server is configured. |
|
0 |
Returns a list of error messages. |
GET /mail-server/smtp
Get the default SMTP mail server
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the default SMTP mail server's details. |
|
204 |
Returns an error message explaining that no default SMTP mail server is configured. |
|
0 |
Returns a list of error messages. |
PUT /mail-server/pop
Set the default POP mail server
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
MailServerPopBean |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the default POP mail server's details. |
|
0 |
Returns a list of error messages. |
PUT /mail-server/smtp
Set the default SMTP mail server
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
MailServerSmtpBean |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the default SMTP mail server's details. |
|
0 |
Returns a list of error messages. |
GET /permissions/anonymous-access
Retrieve current anonymous access configuration
Gets the current global permissions for anonymous access to public pages and user profiles
| Code | Message | Datatype |
|---|---|---|
200 |
||
400 |
PUT /permissions/anonymous-access
Set anonymous access configuration
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
PermissionAnonymousAccessBean |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
||
400 |
GET /settings/branding/color-scheme
Get the color scheme
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the color scheme |
|
0 |
Returns a list of error messages. |
GET /settings/branding/favicon
Get the favicon
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the favicon binary |
|
0 |
Returns a list of error messages. |
GET /settings/branding/logo
Get the logo
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the logo binary |
|
0 |
Returns a list of error messages. |
GET /settings
Get the application settings
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the application settings |
|
0 |
Returns a list of error messages. |
PUT /settings/branding/color-scheme
Set the color scheme
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
SettingsBrandingColorSchemeBean |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the updated color scheme |
|
0 |
Returns a list of error messages. |
PUT /settings/branding/favicon
Set the favicon
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
favicon successfully set |
<<>> |
0 |
Returns a list of error messages. |
PUT /settings/branding/logo
Set the logo
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
logo successfully set |
<<>> |
0 |
Returns a list of error messages. |
PUT /settings
Set the application settings
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
SettingsBean |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the application settings |
|
0 |
Returns a list of error messages. |
GET /users
Get a user
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the requested user details |
|
0 |
Returns a list of error messages. |
PUT /users
Update an user
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
UserBean |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the updated user details |
|
0 |
Returns a list of error messages. |
PUT /users/password
Update a user password
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
X |
| Code | Message | Datatype |
|---|---|---|
200 |
Returns the user details |
|
0 |
Returns a list of error messages. |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Long |
int64 |
||
name |
X |
String |
||
description |
String |
|||
active |
Boolean |
|||
createdDate |
Date |
date-time |
||
updatedDate |
Date |
date-time |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
uuid |
UUID |
uuid |
||
name |
X |
String |
||
type |
X |
String |
Enum: BAMBOO, JIRA, BITBUCKET, CONFLUENCE, FISHEYE, CROWD, |
|
displayUrl |
X |
URI |
uri |
|
rpcUrl |
X |
URI |
uri |
|
primary |
Boolean |
|||
status |
String |
Enum: AVAILABLE, UNAVAILABLE, CONFIGURATION_ERROR, |
||
username |
String |
|||
password |
String |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
applicationLinks |
List of ApplicationLinkBean |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Long |
int64 |
||
name |
String |
|||
enabled |
Boolean |
|||
url |
String |
|||
enableRememberMe |
Boolean |
|||
buttonText |
String |
|||
clientId |
String |
|||
clientSecret |
String |
|||
usernameClaim |
String |
|||
additionalScopes |
List of [string] |
|||
discoveryEnabled |
Boolean |
|||
authorizationEndpoint |
String |
|||
tokenEndpoint |
String |
|||
userInfoEndpoint |
String |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
authenticationIdpBeans |
List of AuthenticationIdpOidcBean |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
X |
String |
||
maxObjectCount |
Integer |
int32 |
||
currentHeapSizeInByte |
Long |
int64 |
||
effectivenessInPercent |
Double |
double |
||
utilisationInPercent |
Double |
double |
||
flushable |
Boolean |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
caches |
List of CacheBean |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
directories |
List of AbstractDirectoryBean |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
enableNestedGroups |
Boolean |
|||
enableIncrementalSync |
Boolean |
|||
updateGroupMembershipMethod |
String |
|||
updateSyncIntervalInMinutes |
Integer |
int32 |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Long |
int64 |
||
name |
X |
String |
||
description |
String |
|||
active |
Boolean |
|||
createdDate |
Date |
date-time |
||
updatedDate |
Date |
date-time |
||
server |
DirectoryCrowdServer |
|||
permissions |
DirectoryCrowdPermissions |
|||
advanced |
DirectoryCrowdAdvanced |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
readOnly |
Boolean |
|||
fullAccess |
Boolean |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
url |
X |
URI |
uri |
|
proxy |
DirectoryCrowdServerProxy |
|||
appUsername |
X |
String |
||
appPassword |
X |
String |
||
connectionTimeoutInMillis |
Long |
int64 |
||
maxConnections |
Integer |
int32 |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
host |
String |
|||
port |
Integer |
int32 |
||
username |
String |
|||
password |
String |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Long |
int64 |
||
name |
X |
String |
||
description |
String |
|||
active |
Boolean |
|||
createdDate |
Date |
date-time |
||
updatedDate |
Date |
date-time |
||
connector |
DirectoryDelegatingConnector |
|||
configuration |
DirectoryDelegatingConfiguration |
|||
permissions |
DirectoryPermissions |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
userDn |
String |
|||
userObjectClass |
String |
|||
userObjectFilter |
String |
|||
userNameAttribute |
String |
|||
userNameRdnAttribute |
String |
|||
userFirstNameAttribute |
String |
|||
userLastNameAttribute |
String |
|||
userDisplayNameAttribute |
String |
|||
userEmailAttribute |
String |
|||
userGroupAttribute |
String |
|||
userUniqueIdAttribute |
String |
|||
groupDn |
String |
|||
groupObjectClass |
String |
|||
groupObjectFilter |
String |
|||
groupNameAttribute |
String |
|||
groupDescriptionAttribute |
String |
|||
groupMembersAttribute |
String |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
type |
String |
Enum: MICROSOFT_ACTIVE_DIRECTORY, |
||
url |
String |
|||
ssl |
String |
Enum: NONE, LDAPS, START_TLS, |
||
useNodeReferrals |
Boolean |
|||
nestedGroupsDisabled |
Boolean |
|||
synchronizeUsers |
Boolean |
|||
synchronizeUserDetails |
Boolean |
|||
synchronizeGroupMemberships |
Boolean |
|||
useUserMembershipAttribute |
Boolean |
|||
usePagedResults |
Boolean |
|||
pagedResultsSize |
Long |
int64 |
||
readTimeoutInMillis |
Long |
int64 |
||
searchTimeoutInMillis |
Long |
int64 |
||
connectionTimeoutInMillis |
Long |
int64 |
||
baseDn |
String |
|||
username |
String |
|||
password |
String |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Long |
int64 |
||
name |
X |
String |
||
description |
String |
|||
active |
Boolean |
|||
createdDate |
Date |
date-time |
||
updatedDate |
Date |
date-time |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
enableNestedGroups |
Boolean |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Long |
int64 |
||
name |
X |
String |
||
description |
String |
|||
active |
Boolean |
|||
createdDate |
Date |
date-time |
||
updatedDate |
Date |
date-time |
||
credentialPolicy |
DirectoryInternalCredentialPolicy |
|||
advanced |
DirectoryInternalAdvanced |
|||
permissions |
DirectoryPermissions |
|||
groups |
List of GroupBean |
|||
users |
List of UserBean |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
passwordRegex |
String |
|||
passwordComplexityMessage |
String |
|||
passwordMaxAttempts |
Long |
int64 |
||
passwordHistoryCount |
Long |
int64 |
||
passwordMaxChangeTime |
Long |
int64 |
||
passwordExpiryNotificationDays |
List of [integer] |
int32 |
||
passwordEncryptionMethod |
String |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
id |
Long |
int64 |
||
name |
X |
String |
||
description |
String |
|||
active |
Boolean |
|||
createdDate |
Date |
date-time |
||
updatedDate |
Date |
date-time |
||
server |
DirectoryLdapServer |
|||
schema |
DirectoryLdapSchema |
|||
permissions |
DirectoryLdapPermissions |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
readOnly |
Boolean |
|||
readOnlyForLocalGroups |
Boolean |
|||
fullAccess |
Boolean |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
baseDn |
String |
|||
userDn |
String |
|||
groupDn |
String |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
host |
X |
String |
||
port |
Integer |
int32 |
||
useSsl |
Boolean |
|||
username |
String |
|||
password |
String |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
addGroup |
Boolean |
|||
addUser |
Boolean |
|||
modifyGroup |
Boolean |
|||
modifyUser |
Boolean |
|||
modifyGroupAttributes |
Boolean |
|||
modifyUserAttributes |
Boolean |
|||
removeGroup |
Boolean |
|||
removeUser |
Boolean |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
errorMessages |
List of [string] |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
gadgets |
List of GadgetBean |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
|||
description |
String |
|||
active |
Boolean |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
products |
List of [string] |
|||
type |
String |
|||
organization |
String |
|||
description |
String |
|||
expiryDate |
Date |
date-time |
||
maxUsers |
Integer |
int32 |
||
key |
String |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
licenses |
List of LicenseBean |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
|||
description |
String |
|||
host |
String |
|||
port |
Integer |
int32 |
||
protocol |
String |
|||
timeout |
Long |
int64 |
||
username |
String |
|||
password |
String |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
name |
String |
|||
description |
String |
|||
host |
String |
|||
port |
Integer |
int32 |
||
protocol |
String |
|||
timeout |
Long |
int64 |
||
username |
String |
|||
password |
String |
|||
adminContact |
String |
|||
from |
String |
|||
prefix |
String |
|||
useTls |
Boolean |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
allowForPages |
Boolean |
|||
allowForUserProfiles |
Boolean |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
baseUrl |
URI |
uri |
||
mode |
String |
|||
title |
String |
|||
contactMessage |
String |
|||
externalUserManagement |
Boolean |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
topBar |
String |
|||
topBarText |
String |
|||
headerButtonBackground |
String |
|||
headerButtonText |
String |
|||
topBarMenuSelectedBackground |
String |
|||
topBarMenuSelectedText |
String |
|||
topBarMenuItemText |
String |
|||
menuItemSelectedBackground |
String |
|||
menuItemSelectedText |
String |
|||
searchFieldBackground |
String |
|||
searchFieldText |
String |
|||
pageMenuSelectedBackground |
String |
|||
pageMenuItemText |
String |
|||
headingText |
String |
|||
links |
String |
|||
bordersAndDividers |
String |
| Field Name | Required | Type | Description | Format |
|---|---|---|---|---|
username |
String |
|||
firstName |
String |
|||
lastName |
String |
|||
fullName |
String |
|||
String |
||||
active |
Boolean |
|||
password |
String |
|||
groups |
List of GroupBean |