---
title: UserRegistration
description: Self Service endpoint for registering a new user
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-userregistration
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-userregistration.html
section_ids:
  sec-amster-entity-userregistration-realm-ops: Realm Operations
  sec-amster-entity-userregistration-realm-ops-read: read
  sec-amster-entity-userregistration-realm-ops-submitrequirements: submitRequirements
---

# UserRegistration

## Realm Operations

Self Service endpoint for registering a new user

Resource path:

```
/selfservice/userRegistration
```

Resource version: `1.0`

### read

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

**Usage**

```
am> read UserRegistration --realm Realm
```

### submitRequirements

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.

**Usage**

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

**Parameters**

* *\--body*

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

  ```json
  {
    "$schema" : "http://json-schema.org/draft-04/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" ]
  }
  ```