Skip to content

Latest commit

 

History

History
100 lines (89 loc) · 8.28 KB

README.md

File metadata and controls

100 lines (89 loc) · 8.28 KB

Documentation for BootstrAPI for Crowd

Documentation for API Endpoints

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

Class Method HTTP request Description
ApplicationApi createApplication POST /application Create an application
ApplicationApi deleteApplication DELETE /application/{id} Delete an application
ApplicationApi getApplication GET /application/{id} Get an application
ApplicationApi updateApplication PUT /application/{id} Update an application
ApplicationLinkApi createApplicationLink POST /application-link Create an application link
ApplicationLinkApi deleteApplicationLink DELETE /application-link/{uuid} Delete an application link
ApplicationLinkApi getApplicationLink GET /application-link/{uuid} Get an application link
ApplicationLinkApi updateApplicationLink PUT /application-link/{uuid} Update an application link
ApplicationLinksApi deleteApplicationLinks DELETE /application-links Delete all application links
ApplicationLinksApi getApplicationLinks GET /application-links Get all application links
ApplicationLinksApi setApplicationLinks PUT /application-links Set a list of application links
ApplicationsApi deleteApplications DELETE /applications Delete all applications
ApplicationsApi getApplications GET /applications Get all applications
ApplicationsApi setApplications PUT /applications Set a list of applications
DirectoriesApi deleteDirectories DELETE /directories Delete all user directories
DirectoriesApi getDirectories GET /directories Get all user directories
DirectoriesApi setDirectories PUT /directories Set a list of user directories
DirectoryApi createDirectory POST /directory Create a user directory
DirectoryApi deleteDirectory DELETE /directory/{id} Delete a user directory
DirectoryApi getDirectory GET /directory/{id} Get a user directory
DirectoryApi updateDirectory PUT /directory/{id} Update a user directory
GroupApi createGroup POST /group Create a group
GroupApi getGroup GET /group Get a group
GroupApi updateGroup PUT /group Update a group
GroupsApi setGroups PATCH /groups Set groups
LicensesApi addLicense POST /licenses Add a license
LicensesApi getLicenses GET /licenses Get all licenses information
MailServerApi getMailServerSmtp GET /mail-server/smtp Get the default SMTP mail server
MailServerApi setMailServerSmtp PUT /mail-server/smtp Set the default SMTP mail server
MailTemplatesApi getMailTemplates GET /mail-templates Get the mail templates
MailTemplatesApi setMailTemplates PUT /mail-templates Set the mail templates
PingApi getPing GET /ping Ping method for probing the REST API.
SessionConfigApi getSessionConfig GET /session-config Get the session config
SessionConfigApi setSessionConfig PUT /session-config Set the session config
SettingsApi getLoginPage GET /settings/branding/login-page Get the login-page settings
SettingsApi getSettings GET /settings Get the general settings
SettingsApi setLoginPage PUT /settings/branding/login-page Set the login-page settings
SettingsApi setLogo PUT /settings/branding/logo Set the logo
SettingsApi setSettings PUT /settings Set the general settings
TrustedProxiesApi addTrustedProxy POST /trusted-proxies Add a trusted proxy
TrustedProxiesApi getTrustedProxies GET /trusted-proxies Get the trusted proxies
TrustedProxiesApi removeTrustedProxy DELETE /trusted-proxies Remove a trusted proxy
TrustedProxiesApi setTrustedProxies PUT /trusted-proxies Set the trusted proxies
UserApi getUser GET /user Get a user
UserApi setUser PUT /user Update an user
UserApi setUserPassword PUT /user/password Update a user password

Documentation for Models

Documentation for Authorization

basicAuth

  • Type: HTTP basic authentication