index.adoc

ConfAPI for Fisheye / Crucible

Table of Contents

• 1. Access
• 2. Endpoints
  • 2.1. ApplicationLinks
    • 2.1.1. addApplicationLink
    • 2.1.2. deleteApplicationLink
    • 2.1.3. deleteApplicationLinks
    • 2.1.4. getApplicationLink
    • 2.1.5. getApplicationLinks
    • 2.1.6. setApplicationLink
    • 2.1.7. setApplicationLinks
  • 2.2. Directories
    • 2.2.1. addDirectory
    • 2.2.2. deleteDirectories
    • 2.2.3. deleteDirectory
    • 2.2.4. getDirectories
    • 2.2.5. getDirectory
    • 2.2.6. setDirectories
    • 2.2.7. setDirectory
  • 2.3. Licenses
    • 2.3.1. addLicense
    • 2.3.2. getLicenses
  • 2.4. MailServer
    • 2.4.1. getMailServerSmtp
    • 2.4.2. setMailServerSmtp
  • 2.5. Ping
    • 2.5.1. getPing
  • 2.6. Settings
    • 2.6.1. getSettings
    • 2.6.2. setSettings
  • 2.7. Users
    • 2.7.1. getUser
    • 2.7.2. setUser
    • 2.7.3. setUserPassword
• 3. Models
  • 3.1. AbstractDirectoryBean
  • 3.2. ApplicationLinkBean
  • 3.3. ApplicationLinksBean
  • 3.4. DirectoriesBean
  • 3.5. DirectoryCrowdAdvanced
  • 3.6. DirectoryCrowdBean
  • 3.7. DirectoryCrowdPermissions
  • 3.8. DirectoryCrowdServer
  • 3.9. DirectoryCrowdServerProxy
  • 3.10. DirectoryGenericBean
  • 3.11. DirectoryInternalAdvanced
  • 3.12. DirectoryInternalBean
  • 3.13. DirectoryInternalCredentialPolicy
  • 3.14. DirectoryInternalPermissions
  • 3.15. DirectoryLdapBean
  • 3.16. DirectoryLdapPermissions
  • 3.17. DirectoryLdapSchema
  • 3.18. DirectoryLdapServer
  • 3.19. ErrorCollection
  • 3.20. LicenseBean
  • 3.21. LicensesBean
  • 3.22. MailServerSmtpBean
  • 3.23. SettingsHttpBean
  • 3.24. UserBean

Abstract

This plugin provides methods for accessing configuration for Fisheye / Crucible.

1. Access

• HTTP Basic Authentication basicAuth

2. Endpoints

2.1. ApplicationLinks

2.1.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 1. http response codes

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

Samples

2.1.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 2. http response codes

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

Samples

2.1.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 3. http response codes

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

Samples

2.1.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 4. http response codes

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

Samples

2.1.5. getApplicationLinks

GET /application-links

Get all application links

Description

Parameters

Return Type

ApplicationLinksBean

Content Type

• application/json

Responses

Table 5. http response codes

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

Samples

2.1.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 6. http response codes

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

Samples

2.1.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 7. http response codes

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

Samples

2.2. Directories

2.2.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 8. http response codes

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

Samples

2.2.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 9. http response codes

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

Samples

2.2.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 10. http response codes

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

Samples

2.2.4. getDirectories

GET /directories

Get all user directories

Description

Parameters

Return Type

DirectoriesBean

Content Type

• application/json

Responses

Table 11. http response codes

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

Samples

2.2.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 12. http response codes

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

Samples

2.2.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 13. http response codes

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

Samples

2.2.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 14. http response codes

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

Samples

2.3. Licenses

2.3.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 15. http response codes

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

Samples

2.3.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 16. 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.4. MailServer

2.4.1. getMailServerSmtp

GET /mail-server/smtp

Get the default SMTP mail server

Description

Parameters

Return Type

MailServerSmtpBean

Content Type

• application/json

Responses

Table 17. 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.4.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 18. 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.5. Ping

2.5.1. getPing

GET /ping

Ping method for probing the REST API.

Description

Parameters

Return Type

-

Responses

Table 19. http response codes

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

Samples

2.6. Settings

2.6.1. getSettings

GET /settings/http

Get the http server settings

Description

Parameters

Return Type

SettingsHttpBean

Content Type

• application/json

Responses

Table 20. http response codes

Code	Message	Datatype
200	Returns the server settings	SettingsHttpBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.6.2. setSettings

PUT /settings/http

Set the http server settings

Description

Parameters

Body Parameter

Name	Description	Required	Default	Pattern
SettingsHttpBean	SettingsHttpBean	X

Return Type

SettingsHttpBean

Content Type

• application/json

Responses

Table 21. http response codes

Code	Message	Datatype
200	Returns the server settings	SettingsHttpBean
0	Returns a list of error messages.	ErrorCollection

Samples

2.7. Users

2.7.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 22. http response codes

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

Samples

2.7.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 23. http response codes

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

Samples

2.7.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 24. 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
credentialPolicy		DirectoryInternalCredentialPolicy
schema		DirectoryLdapSchema

3.2. 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.3. ApplicationLinksBean

Field Name	Required	Type	Description	Format
applicationLinks		List of ApplicationLinkBean

3.4. DirectoriesBean

Field Name	Required	Type	Description	Format
directories		List of AbstractDirectoryBean

3.5. DirectoryCrowdAdvanced

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

3.6. 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.7. DirectoryCrowdPermissions

Field Name	Required	Type	Description	Format
readOnly		Boolean
fullAccess		Boolean

3.8. 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.9. DirectoryCrowdServerProxy

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

3.10. 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.11. DirectoryInternalAdvanced

Field Name	Required	Type	Description	Format
enableNestedGroups		Boolean

3.12. 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		DirectoryInternalPermissions

3.13. 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.14. DirectoryInternalPermissions

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

3.15. 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.16. DirectoryLdapPermissions

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

3.17. DirectoryLdapSchema

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

3.18. DirectoryLdapServer

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

3.19. ErrorCollection

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

3.20. 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.21. LicensesBean

Field Name	Required	Type	Description	Format
licenses		List of LicenseBean

3.22. 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.23. SettingsHttpBean

Field Name	Required	Type	Description	Format
webContext		String
bindAddress		String
proxyScheme		String
proxyHost		String
proxyPort		Integer		int32

3.24. UserBean

Field Name	Required	Type	Description	Format
username		String
fullName		String
email		String
password		String