POST realm

This web method replaces the existing realm definition with a new definition.

Modification Lock

Behavior depends on state of the modification lock.

  • If the lock is not held by any user, you can use this request. Forcing is not needed.
  • If you hold the lock, this request is allowed. It releases the modification lock, deletes your workspace, and updates the realm definition.
  • If another user holds the lock, this request is not allowed.

    However, you can force this request. Forcing breaks the modification lock, deletes the other user's workspace, and updates the realm definition.

Input Data

Supply a JSON representation of the definition in the message body.

HTTP Parameters

Syntax Description
force=<boolean> Optional.

When true, force an update to the new realm definition, breaking the modification lock.

Example Requests

curl -X POST http://<host>:<port>/api/v1/realm -d <json_defn>
curl -X POST http://<host>:<port>/api/v1/realm?force=true -d <json_defn>