Workspace

Life Cycle

Each workspace begins as a working copy of the realm definition. An administrator can modify the realm definition in the workspace without affecting realm operations.

When modifications to the workspace are complete, the administrator can deploy the workspace definition, using the deploy transaction. See POST realm/deployments.

For more information, see these topics:

Tasks and Methods

Task Method
Get the user name of the administrator who has locked the workspace. GET realm/workspace
Get validation results for the workspace. GET realm/workspace/validation
Request the modification lock, and create a workspace for editing. POST realm/workspace
Delete the workspace and release the modification lock. DELETE realm/workspace

JSON Attributes

GET requests return JSON data.

Attribute Description
user The value of this attribute is the user name of the administrator.

When user authentication is disabled, the special user name anyone represents any user.

results The value of this attribute is a collection of strings. Each string describes a validation error in the workspace.