index.adoc

ConfAPI for Crowd

Table of Contents

• 1. Access
• 2. Endpoints
  • 2.1. All
    • 2.1.1. setAll
  • 2.2. ApplicationLinks
    • 2.2.1. addApplicationLink
    • 2.2.2. deleteApplicationLink
    • 2.2.3. deleteApplicationLinks
    • 2.2.4. getApplicationLink
    • 2.2.5. getApplicationLinks
    • 2.2.6. setApplicationLink
    • 2.2.7. setApplicationLinks
  • 2.3. Applications
    • 2.3.1. addApplication
    • 2.3.2. deleteApplication
    • 2.3.3. deleteApplications
    • 2.3.4. getApplication
    • 2.3.5. getApplications
    • 2.3.6. setApplication
    • 2.3.7. setApplications
  • 2.4. Directories
    • 2.4.1. addDirectory
    • 2.4.2. deleteDirectories
    • 2.4.3. deleteDirectory
    • 2.4.4. getDirectories
    • 2.4.5. getDirectory
    • 2.4.6. setDirectories
    • 2.4.7. setDirectory
  • 2.5. Groups
    • 2.5.1. createGroup
    • 2.5.2. getGroup
    • 2.5.3. setGroups
    • 2.5.4. updateGroup
  • 2.6. Licenses
    • 2.6.1. addLicense
    • 2.6.2. getLicenses
  • 2.7. MailServer
    • 2.7.1. getMailServerSmtp
    • 2.7.2. setMailServerSmtp
  • 2.8. MailTemplates
    • 2.8.1. getMailTemplates
    • 2.8.2. setMailTemplates
  • 2.9. Ping
    • 2.9.1. getPing
  • 2.10. SessionConfig
    • 2.10.1. getSessionConfig
    • 2.10.2. setSessionConfig
  • 2.11. Settings
    • 2.11.1. getLoginPage
    • 2.11.2. getSettings
    • 2.11.3. setLoginPage
    • 2.11.4. setLogo
    • 2.11.5. setSettings
  • 2.12. TrustedProxies
    • 2.12.1. addTrustedProxy
    • 2.12.2. getTrustedProxies
    • 2.12.3. removeTrustedProxy
    • 2.12.4. setTrustedProxies
  • 2.13. Users
    • 2.13.1. getUser
    • 2.13.2. setUser
    • 2.13.3. setUserPassword
• 3. Models
  • 3.1. AbstractDirectoryBean
  • 3.2. AllBean
  • 3.3. ApplicationBean
  • 3.4. ApplicationDirectoryMapping
  • 3.5. ApplicationLinkBean
  • 3.6. ApplicationLinksBean
  • 3.7. ApplicationsBean
  • 3.8. DirectoriesBean
  • 3.9. DirectoryCrowdAdvanced
  • 3.10. DirectoryCrowdBean
  • 3.11. DirectoryCrowdPermissions
  • 3.12. DirectoryCrowdServer
  • 3.13. DirectoryCrowdServerProxy
  • 3.14. DirectoryDelegatingBean
  • 3.15. DirectoryDelegatingConfiguration
  • 3.16. DirectoryDelegatingConnector
  • 3.17. DirectoryGenericBean
  • 3.18. DirectoryInternalAdvanced
  • 3.19. DirectoryInternalBean
  • 3.20. DirectoryInternalCredentialPolicy
  • 3.21. DirectoryLdapBean
  • 3.22. DirectoryLdapPermissions
  • 3.23. DirectoryLdapSchema
  • 3.24. DirectoryLdapServer
  • 3.25. DirectoryPermissions
  • 3.26. ErrorCollection
  • 3.27. GroupBean
  • 3.28. GroupsBean
  • 3.29. LicenseBean
  • 3.30. LicensesBean
  • 3.31. MailServerSmtpBean
  • 3.32. MailTemplatesBean
  • 3.33. SessionConfigBean
  • 3.34. SettingsBean
  • 3.35. SettingsBrandingLoginPageBean
  • 3.36. TrustedProxiesBean
  • 3.37. UserBean

Abstract

This plugin provides methods for accessing configuration for Crowd.

1. Access

• HTTP Basic Authentication basicAuth

2. Endpoints

2.1. All

2.1.1. setAll

PUT /all

Set the whole configuration

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
AllBean	AllBean	-

Return Type

-

Content Type

• /

Responses

Table 1. http response codes

Code	Message	Datatype
200	When setting whole configuration was successful.	<<>>
0	Returns a list of error messages.	ErrorCollection

Samples

2.2. ApplicationLinks

2.2.1. addApplicationLink

POST /application-links

Add an application link

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
ApplicationLinkBean	ApplicationLinkBean	X

Query Parameters

Name	Description	Required	Default	Pattern
ignore-setup-errors		-	false

Return Type

ApplicationLinkBean

Content Type

• application/json

Responses

Table 2. http response codes

Code	Message	Datatype
200	Returns the added application link.	ApplicationLinkBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.2.2. deleteApplicationLink

DELETE /application-links/{uuid}

Delete an application link

Description

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
uuid		X	null

Return Type

-

Content Type

• /

Responses

Table 3. http response codes

Code	Message	Datatype
200	Returns an empty body.	<<>>
0	Returns a list of error messages.	ErrorCollection

Samples

2.2.3. deleteApplicationLinks

DELETE /application-links

Delete all application links

Description

Note	The 'force' parameter must be set to 'true' in order to execute this request.

Parameters

Query Parameters

Name	Description	Required	Default	Pattern
force		-	null

Return Type

-

Content Type

• /

Responses

Table 4. http response codes

Code	Message	Datatype
200	Returns an empty body.	<<>>
0	Returns a list of error messages.	ErrorCollection

Samples

2.2.4. getApplicationLink

GET /application-links/{uuid}

Get an application link

Description

Upon successful request,

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
uuid		X	null

Return Type

ApplicationLinkBean

Content Type

• application/json

Responses

Table 5. http response codes

Code	Message	Datatype
200	Returns the requested application link.	ApplicationLinkBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.2.5. getApplicationLinks

GET /application-links

Get all application links

Description

Parameters

Return Type

ApplicationLinksBean

Content Type

• application/json

Responses

Table 6. http response codes

Code	Message	Datatype
200	Returns all application links.	ApplicationLinksBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.2.6. setApplicationLink

PUT /application-links/{uuid}

Update an application link

Description

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
uuid		X	null

Body Parameter

Name	Description	Required	Default	Pattern
ApplicationLinkBean	ApplicationLinkBean	X

Query Parameters

Name	Description	Required	Default	Pattern
ignore-setup-errors		-	false

Return Type

ApplicationLinkBean

Content Type

• application/json

Responses

Table 7. http response codes

Code	Message	Datatype
200	Returns the updated application link.	ApplicationLinkBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.2.7. setApplicationLinks

PUT /application-links

Set or update a list of application links

Description

Note	All existing application links with the same 'rpcUrl' attribute are updated.

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
ApplicationLinksBean	ApplicationLinksBean	X

Query Parameters

Name	Description	Required	Default	Pattern
ignore-setup-errors		-	false

Return Type

ApplicationLinksBean

Content Type

• application/json

Responses

Table 8. http response codes

Code	Message	Datatype
200	Returns all application links.	ApplicationLinksBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.3. Applications

2.3.1. addApplication

POST /applications

Add an application

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
ApplicationBean	ApplicationBean	-

Return Type

ApplicationBean

Content Type

• application/json

Responses

Table 9. http response codes

Code	Message	Datatype
200	Returns the added application.	ApplicationBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.3.2. deleteApplication

DELETE /applications/{id}

Delete an application

Description

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

Return Type

-

Content Type

• /

Responses

Table 10. http response codes

Code	Message	Datatype
200	Returns an empty body.	<<>>
0	Returns a list of error messages.	ErrorCollection

Samples

2.3.3. deleteApplications

DELETE /applications

Delete all applications

Description

Note	The 'force' parameter must be se to 'true' in order to execute this request.

Parameters

Query Parameters

Name	Description	Required	Default	Pattern
force		-	null

Return Type

-

Content Type

• /

Responses

Table 11. http response codes

Code	Message	Datatype
200	Returns an empty body.	<<>>
0	Returns a list of error messages.	ErrorCollection

Samples

2.3.4. getApplication

GET /applications/{id}

Get an application

Description

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

Return Type

ApplicationsBean

Content Type

• application/json

Responses

Table 12. http response codes

Code	Message	Datatype
200	Returns the requested application.	ApplicationsBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.3.5. getApplications

GET /applications

Get all applications

Description

Upon successful request, returns a ApplicationsBean object containing all applications

Parameters

Return Type

ApplicationsBean

Content Type

• application/json

Responses

Table 13. http response codes

Code	Message	Datatype
200	Returns all applications.	ApplicationsBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.3.6. setApplication

PUT /applications/{id}

Update an application

Description

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

Body Parameter

Name	Description	Required	Default	Pattern
ApplicationBean	ApplicationBean	-

Return Type

ApplicationBean

Content Type

• application/json

Responses

Table 14. http response codes

Code	Message	Datatype
200	Returns the updated application.	ApplicationBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.3.7. setApplications

PUT /applications

Set or update a list of applications

Description

Note	All existing applications with the same 'name' attribute are updated.

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
ApplicationsBean	ApplicationsBean	-

Return Type

ApplicationsBean

Content Type

• application/json

Responses

Table 15. http response codes

Code	Message	Datatype
200	Returns all applications.	ApplicationsBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.4. Directories

2.4.1. addDirectory

POST /directories

Add a user directory

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
AbstractDirectoryBean	AbstractDirectoryBean	X

Query Parameters

Name	Description	Required	Default	Pattern
test-connection		-	false

Return Type

AbstractDirectoryBean

Content Type

• application/json

Responses

Table 16. http response codes

Code	Message	Datatype
200	Returns the added directory.	AbstractDirectoryBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.4.2. deleteDirectories

DELETE /directories

Delete all user directories

Description

Note	The 'force' parameter must be set to 'true' in order to execute this request.

Parameters

Query Parameters

Name	Description	Required	Default	Pattern
force		-	null

Return Type

-

Content Type

• /

Responses

Table 17. http response codes

Code	Message	Datatype
200	Returns an empty body.	<<>>
0	Returns a list of error messages.	ErrorCollection

Samples

2.4.3. deleteDirectory

DELETE /directories/{id}

Delete a user directory

Description

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

Return Type

-

Content Type

• /

Responses

Table 18. http response codes

Code	Message	Datatype
200	Returns an empty body.	<<>>
0	Returns a list of error messages.	ErrorCollection

Samples

2.4.4. getDirectories

GET /directories

Get all user directories

Description

Parameters

Return Type

DirectoriesBean

Content Type

• application/json

Responses

Table 19. http response codes

Code	Message	Datatype
200	Returns all directories.	DirectoriesBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.4.5. getDirectory

GET /directories/{id}

Get a user directory

Description

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

Return Type

AbstractDirectoryBean

Content Type

• application/json

Responses

Table 20. http response codes

Code	Message	Datatype
200	Returns the requested directory.	AbstractDirectoryBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.4.6. setDirectories

PUT /directories

Set or update a list of user directories

Description

Note	All existing directories with the same 'name' attribute are updated.

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
DirectoriesBean	DirectoriesBean	X

Query Parameters

Name	Description	Required	Default	Pattern
test-connection		-	false

Return Type

DirectoriesBean

Content Type

• application/json

Responses

Table 21. http response codes

Code	Message	Datatype
200	Returns all directories.	DirectoriesBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.4.7. setDirectory

PUT /directories/{id}

Update a user directory

Description

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
id		X	null

Body Parameter

Name	Description	Required	Default	Pattern
AbstractDirectoryBean	AbstractDirectoryBean	X

Query Parameters

Name	Description	Required	Default	Pattern
test-connection		-	false

Return Type

AbstractDirectoryBean

Content Type

• application/json

Responses

Table 22. http response codes

Code	Message	Datatype
200	Returns the updated directory.	AbstractDirectoryBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.5. Groups

2.5.1. createGroup

POST /groups

Create a group

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
GroupBean	GroupBean	X

Query Parameters

Name	Description	Required	Default	Pattern
directoryId		X	null

Return Type

GroupBean

Content Type

• application/json

Responses

Table 23. http response codes

Code	Message	Datatype
200	Returns the updated group details	GroupBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.5.2. getGroup

GET /groups

Get a group

Description

Parameters

Query Parameters

Name	Description	Required	Default	Pattern
directoryId		X	null
name		X	null

Return Type

GroupBean

Content Type

• application/json

Responses

Table 24. http response codes

Code	Message	Datatype
200	Returns the requested group details	GroupBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.5.3. setGroups

PATCH /groups

Set groups

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
GroupsBean	GroupsBean	X

Query Parameters

Name	Description	Required	Default	Pattern
directoryId		X	null

Return Type

GroupBean

Content Type

• application/json

Responses

Table 25. http response codes

Code	Message	Datatype
200	Returns the updated groups details	GroupBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.5.4. updateGroup

PUT /groups

Update a group

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
GroupBean	GroupBean	X

Query Parameters

Name	Description	Required	Default	Pattern
directoryId		X	null
name		X	null

Return Type

GroupBean

Content Type

• application/json

Responses

Table 26. http response codes

Code	Message	Datatype
200	Returns the updated group details	GroupBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.6. Licenses

2.6.1. addLicense

POST /licenses

Add a license

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
LicenseBean	LicenseBean	X

Return Type

LicenseBean

Content Type

• application/json

Responses

Table 27. http response codes

Code	Message	Datatype
200	Returns the added license details	LicenseBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.6.2. getLicenses

GET /licenses

Get all licenses information

Description

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

Parameters

Return Type

LicensesBean

Content Type

• application/json

Responses

Table 28. http response codes

Code	Message	Datatype
200	Returns a list of all licenses (NOTE: for all applications except Jira this will return a single license)	LicensesBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.7. MailServer

2.7.1. getMailServerSmtp

GET /mail-server/smtp

Get the default SMTP mail server

Description

Parameters

Return Type

MailServerSmtpBean

Content Type

• application/json

Responses

Table 29. http response codes

Code	Message	Datatype
200	Returns the default SMTP mail server's details.	MailServerSmtpBean
204	Returns an error message explaining that no default SMTP mail server is configured.	ErrorCollection
0	Returns a list of error messages.	ErrorCollection

Samples

2.7.2. setMailServerSmtp

PUT /mail-server/smtp

Set the default SMTP mail server

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
MailServerSmtpBean	MailServerSmtpBean	X

Return Type

MailServerSmtpBean

Content Type

• application/json

Responses

Table 30. http response codes

Code	Message	Datatype
200	Returns the default SMTP mail server's details.	MailServerSmtpBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.8. MailTemplates

2.8.1. getMailTemplates

GET /mail-templates

Get the mail templates

Description

Parameters

Return Type

MailTemplatesBean

Content Type

• application/json

Responses

Table 31. http response codes

Code	Message	Datatype
200		MailTemplatesBean
0		ErrorCollection

Samples

2.8.2. setMailTemplates

PUT /mail-templates

Set the mail templates

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
MailTemplatesBean	MailTemplatesBean	-

Return Type

MailTemplatesBean

Content Type

• application/json

Responses

Table 32. http response codes

Code	Message	Datatype
200		MailTemplatesBean
0		ErrorCollection

Samples

2.9. Ping

2.9.1. getPing

GET /ping

Ping method for probing the REST API.

Description

Parameters

Return Type

-

Responses

Table 33. http response codes

Code	Message	Datatype
200	Returns 'pong'	<<>>

Samples

2.10. SessionConfig

2.10.1. getSessionConfig

GET /session-config

Get the session config

Description

Parameters

Return Type

SessionConfigBean

Content Type

• application/json

Responses

Table 34. http response codes

Code	Message	Datatype
200		SessionConfigBean
0		ErrorCollection

Samples

2.10.2. setSessionConfig

PUT /session-config

Set the session config

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
SessionConfigBean	SessionConfigBean	-

Return Type

SessionConfigBean

Content Type

• application/json

Responses

Table 35. http response codes

Code	Message	Datatype
200		SessionConfigBean
0		ErrorCollection

Samples

2.11. Settings

2.11.1. getLoginPage

GET /settings/branding/login-page

Get the login-page settings

Description

Parameters

Return Type

SettingsBrandingLoginPageBean

Content Type

• application/json

Responses

Table 36. http response codes

Code	Message	Datatype
200		SettingsBrandingLoginPageBean
0		ErrorCollection

Samples

2.11.2. getSettings

GET /settings

Get the application settings

Description

Parameters

Return Type

SettingsBean

Content Type

• application/json

Responses

Table 37. http response codes

Code	Message	Datatype
200	Returns the application settings	SettingsBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.11.3. setLoginPage

PUT /settings/branding/login-page

Set the login-page settings

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
SettingsBrandingLoginPageBean	SettingsBrandingLoginPageBean	-

Return Type

SettingsBrandingLoginPageBean

Content Type

• application/json

Responses

Table 38. http response codes

Code	Message	Datatype
200		SettingsBrandingLoginPageBean
0		ErrorCollection

Samples

2.11.4. setLogo

PUT /settings/branding/logo

Set the logo

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
body	[object]	-

Return Type

ErrorCollection

Content Type

• application/json

Responses

Table 39. http response codes

Code	Message	Datatype
0		ErrorCollection

Samples

2.11.5. setSettings

PUT /settings

Set the application settings

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
SettingsBean	SettingsBean	X

Return Type

SettingsBean

Content Type

• application/json

Responses

Table 40. http response codes

Code	Message	Datatype
200	Returns the application settings	SettingsBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.12. TrustedProxies

2.12.1. addTrustedProxy

POST /trusted-proxies

Add a trusted proxy

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
body	[string]	-

Return Type

TrustedProxiesBean

Content Type

• application/json

Responses

Table 41. http response codes

Code	Message	Datatype
200		TrustedProxiesBean
0		ErrorCollection

Samples

2.12.2. getTrustedProxies

GET /trusted-proxies

Get the trusted proxies

Description

Parameters

Return Type

TrustedProxiesBean

Content Type

• application/json

Responses

Table 42. http response codes

Code	Message	Datatype
200		TrustedProxiesBean
0		ErrorCollection

Samples

2.12.3. removeTrustedProxy

DELETE /trusted-proxies

Remove a trusted proxy

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
body	[string]	-

Return Type

TrustedProxiesBean

Content Type

• application/json

Responses

Table 43. http response codes

Code	Message	Datatype
200		TrustedProxiesBean
0		ErrorCollection

Samples

2.12.4. setTrustedProxies

PUT /trusted-proxies

Set the trusted proxies

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
TrustedProxiesBean	TrustedProxiesBean	-

Return Type

TrustedProxiesBean

Content Type

• application/json

Responses

Table 44. http response codes

Code	Message	Datatype
200		TrustedProxiesBean
0		ErrorCollection

Samples

2.13. Users

2.13.1. getUser

GET /users

Get a user

Description

Parameters

Query Parameters

Name	Description	Required	Default	Pattern
username		X	null

Return Type

UserBean

Content Type

• application/json

Responses

Table 45. http response codes

Code	Message	Datatype
200	Returns the requested user details	UserBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.13.2. setUser

PUT /users

Update an user

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
UserBean	UserBean	X

Query Parameters

Name	Description	Required	Default	Pattern
username		X	null

Return Type

UserBean

Content Type

• application/json

Responses

Table 46. http response codes

Code	Message	Datatype
200	Returns the updated user details	UserBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.13.3. setUserPassword

PUT /users/password

Update a user password

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
body	[string]	X

Query Parameters

Name	Description	Required	Default	Pattern
username		X	null

Return Type

UserBean

Content Type

• application/json

Responses

Table 47. http response codes

Code	Message	Datatype
200	Returns the user details	UserBean
0	Returns a list of error messages.	ErrorCollection

Samples

3. Models

3.1. AbstractDirectoryBean

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
permissions		DirectoryLdapPermissions
advanced		DirectoryInternalAdvanced
connector		DirectoryDelegatingConnector
configuration		DirectoryDelegatingConfiguration
credentialPolicy		DirectoryInternalCredentialPolicy
groups		List of GroupBean
users		List of UserBean
schema		DirectoryLdapSchema

3.2. AllBean

Field Name	Required	Type	Description	Format
settings		SettingsBean
applications		ApplicationsBean

3.3. ApplicationBean

Field Name	Required	Type	Description	Format
id		Long		int64
name		String
description		String
active		Boolean
type		String		Enum: GENERIC, PLUGIN, CROWD, JIRA, CONFLUENCE, BITBUCKET, FISHEYE, CRUCIBLE, BAMBOO,
password		String
cachedDirectoriesAuthenticationOrderOptimisationEnabled		Boolean
directoryMappings		List of ApplicationDirectoryMapping
accessBasedSynchronisation		String		Enum: NO_FILTERING, USER_ONLY_FILTERING, USER_AND_GROUP_FILTERING,
membershipAggregationEnabled		Boolean
remoteAddresses		List of [string]
aliasingEnabled		Boolean
lowercaseOutputEnabled		Boolean
authenticationWithoutPasswordEnabled		Boolean

3.4. ApplicationDirectoryMapping

Field Name	Required	Type	Description	Format
directoryName		String
authenticationAllowAll		Boolean
authenticationGroups		List of [string]
autoAssignmentGroups		List of [string]
allowedOperations		List of [string]		Enum:

3.5. ApplicationLinkBean

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

3.6. ApplicationLinksBean

Field Name	Required	Type	Description	Format
applicationLinks		List of ApplicationLinkBean

3.7. ApplicationsBean

Field Name	Required	Type	Description	Format
applications		List of ApplicationBean

3.8. DirectoriesBean

Field Name	Required	Type	Description	Format
directories		List of AbstractDirectoryBean

3.9. DirectoryCrowdAdvanced

Field Name	Required	Type	Description	Format
enableNestedGroups		Boolean
enableIncrementalSync		Boolean
updateGroupMembershipMethod		String
updateSyncIntervalInMinutes		Integer		int32

3.10. DirectoryCrowdBean

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

3.11. DirectoryCrowdPermissions

Field Name	Required	Type	Description	Format
readOnly		Boolean
fullAccess		Boolean

3.12. DirectoryCrowdServer

Field Name	Required	Type	Description	Format
url	X	URI		uri
proxy		DirectoryCrowdServerProxy
appUsername	X	String
appPassword	X	String
connectionTimeoutInMillis		Long		int64
maxConnections		Integer		int32

3.13. DirectoryCrowdServerProxy

Field Name	Required	Type	Description	Format
host		String
port		Integer		int32
username		String
password		String

3.14. DirectoryDelegatingBean

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

3.15. DirectoryDelegatingConfiguration

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

3.16. DirectoryDelegatingConnector

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

3.17. DirectoryGenericBean

Field Name	Required	Type	Description	Format
id		Long		int64
name	X	String
description		String
active		Boolean
createdDate		Date		date-time
updatedDate		Date		date-time

3.18. DirectoryInternalAdvanced

Field Name	Required	Type	Description	Format
enableNestedGroups		Boolean

3.19. DirectoryInternalBean

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

3.20. DirectoryInternalCredentialPolicy

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

3.21. DirectoryLdapBean

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

3.22. DirectoryLdapPermissions

Field Name	Required	Type	Description	Format
readOnly		Boolean
readOnlyForLocalGroups		Boolean
fullAccess		Boolean

3.23. DirectoryLdapSchema

Field Name	Required	Type	Description	Format
baseDn		String
userDn		String
groupDn		String

3.24. DirectoryLdapServer

Field Name	Required	Type	Description	Format
host	X	String
port		Integer		int32
useSsl		Boolean
username		String
password		String

3.25. DirectoryPermissions

Field Name	Required	Type	Description	Format
addGroup		Boolean
addUser		Boolean
modifyGroup		Boolean
modifyUser		Boolean
modifyGroupAttributes		Boolean
modifyUserAttributes		Boolean
removeGroup		Boolean
removeUser		Boolean

3.26. ErrorCollection

Field Name	Required	Type	Description	Format
errorMessages		List of [string]

3.27. GroupBean

Field Name	Required	Type	Description	Format
name		String
description		String
active		Boolean

3.28. GroupsBean

Field Name	Required	Type	Description	Format
groups		List of GroupBean

3.29. LicenseBean

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

3.30. LicensesBean

Field Name	Required	Type	Description	Format
licenses		List of LicenseBean

3.31. MailServerSmtpBean

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

3.32. MailTemplatesBean

Field Name	Required	Type	Description	Format
forgottenPassword		String
forgottenUsername		String
passwordExpirationReminder		String
emailChangeValidation		String
emailChangeInfo		String

3.33. SessionConfigBean

Field Name	Required	Type	Description	Format
sessionTimeoutInMinutes		Long		int64
requireConsistentClientIP		Boolean

3.34. SettingsBean

Field Name	Required	Type	Description	Format
baseUrl		URI		uri
mode		String
title		String
contactMessage		String
externalUserManagement		Boolean

3.35. SettingsBrandingLoginPageBean

Field Name	Required	Type	Description	Format
showLogo		Boolean
header		String
content		String
buttonColor		String

3.36. TrustedProxiesBean

Field Name	Required	Type	Description	Format
trustedProxies		List of [string]

3.37. UserBean

Field Name	Required	Type	Description	Format
username		String
firstName		String
lastName		String
fullName		String
email		String
active		Boolean
password		String
groups		List of GroupBean