Skip to content

Latest commit

 

History

History
115 lines (71 loc) · 2.9 KB

DirectoryApi.md

File metadata and controls

115 lines (71 loc) · 2.9 KB

DirectoryApi

All URIs are relative to https://<JIRA_URL>/rest/bootstrapi/1

Method HTTP request Description
createDirectory POST /directory Create a user directory
deleteDirectory DELETE /directory/{id} Delete a user directory
getDirectory GET /directory/{id} Get a user directory
updateDirectory PUT /directory/{id} Update a user directory

createDirectory

AbstractDirectoryBean createDirectory(AbstractDirectoryBean, test-connection)

Create a user directory

Parameters

Name Type Description Notes
AbstractDirectoryBean AbstractDirectoryBean
test-connection Boolean [optional] [default to false]

Return type

AbstractDirectoryBean

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteDirectory

deleteDirectory(id)

Delete a user directory

Parameters

Name Type Description Notes
id Long [default to null]

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

getDirectory

AbstractDirectoryBean getDirectory(id)

Get a user directory

Parameters

Name Type Description Notes
id Long [default to null]

Return type

AbstractDirectoryBean

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateDirectory

AbstractDirectoryBean updateDirectory(id, AbstractDirectoryBean, test-connection)

Update a user directory

Parameters

Name Type Description Notes
id Long [default to null]
AbstractDirectoryBean AbstractDirectoryBean
test-connection Boolean [optional] [default to false]

Return type

AbstractDirectoryBean

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json