Realm Operations

Self Service endpoint for registering a new user

Resource path:


Resource version: 1.0


Initialise the user registration process.A set of requirements will be returned that will need to be fulfilled and sent to the submitRequirements action.


am> read UserRegistration --realm Realm


Submit some fulfilled requirements. Returns either a completion status, or a token along with some more requirements. If requirements are returned, they should be submitted with the token as a fresh request to this action.


am> action UserRegistration --realm Realm --body body --actionName submitRequirements



The resource in JSON format, described by the following JSON schema:

  "$schema" : "",
  "description" : "The structure of a request to the submitRequirements action.",
  "type" : "object",
  "title" : "Submit requirements structure",
  "properties" : {
    "token" : {
      "type" : "string",
      "title" : "Token",
      "description" : "The token returned from the previous submitRequirements request."
    "input" : {
      "type" : "object",
      "title" : "Input",
      "description" : "The input as collected from the new user. This object must conform to the JSON Schema of the requirements property from the last response.",
      "patternProperties" : {
        ".*" : {
          "type" : "any",
          "title" : "Input Property",
          "description" : "Valid content according to the received JSON Schema."
  "required" : [ "input" ]
Copyright © 2010-2024 ForgeRock, all rights reserved.