Confluence Administration Routines

Confluence Administration Routines

Set permissions for your spaces and pages in Confluence.

You need to have administrator rights to run them and you need to take care when updating your spaces.

Routines Summary

  • admActivateUserActivates a user, setting its active flag to 'true', if the update is allowed.
  • admAddSpaceCategoryAdds a category in the space.
  • admArchiveSpaceArchives a space (takes a space key as a parameter).
  • admClearCacheClears the internal cache.
  • admCloneSpaceClones space with pages, labels, categories, attachments, permissions and look and feel.
  • admCreateGroupCreate a single group to a project role if the group does not already exist.
  • admCreateSpaceCreates a new space, optionally offering support for the category of the space.
  • admCreateUserCreates a new user.
  • admDeactivateUserDe-activates a user (sets its active flag to 'false' or removes it from all groups associated to global login permissions).
  • admDeleteSpacePermanently deletes a space from Confluence.
  • admDeleteSpaceCategoryDeletes a category from the space.
  • admGetSpaceReturns an instance of CSpace struct, takes a space key as a parameter.
  • admGetSpaceCategoriesReturns the space categories (all).
  • admGetSpaceCategoryReturns a space category by name (takes a space key and space category as parameters).
  • admGetSpaceLayoutReturns a layout - a list of custom decorators defined for a specific space only (does not retrieve global decorators).
  • admGetSpacesTakes a category name and returns an array of spaces (CSpace structs) in that category.
  • admGetSpaceStylesheetReturns the custom stylesheet that has been stored against a space.
  • admSetSpaceLayoutCreates a decorator for the given spaceKey with the given name, and saves it.
  • admSetSpaceStylesheetAdds a space stylesheet to customize the look and feel of a single space within Confluence.
  • admSpaceExistsReturns 'true' if space with provided key exists and 'false' otherwise.
  • admUnarchiveSpaceUnarchives a space (takes a space key as a parameter).
  • admUpdateSpaceUpdates the space properties (takes space key and an instance of CSpace struct as parameters).
  • updateUsernameChange the username for a user.
  • admGetUserLoginRetrieves user login info.
  • admReindexThe routine make reindex.
  • admGetSpaceHomePageThe routine receives the key of a space as parameter.
  • admDeleteMultipleSpacesThe routine deletes multiple spaces, separated by comma admDeleteMultipleSpaces("ABC,DFG")



Peacock

Need support? Create a request with our support team.

Copyright © 2005 - 2025 Appfire | All rights reserved.

OSZAR »