POST /api/user/registration/{userId}

Registers a user for an application. If you provide the User and the UserRegistration object on this request, it will create the user as well as register them for the application. This is called a Full Registration. However, if you only provide the UserRegistration object, then the user must already exist and they will be registered for the application. The user Id can also be provided and it will either be used to look up an existing user or it will be used for the newly created User.

post/api/user/registration/{userId}

Request

Base URL: http://localhost:9011
URL: http://localhost:9011/api/user/registration/{userId}
Auth: API key in header Authorization

Path parameters

userIdstring required

The Id of the user being registered for the application and optionally created.

Headers

X-FusionAuth-TenantIdstring UUID

The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped.

Request body

disableDomainBlockboolean

generateAuthenticationTokenboolean

sendSetPasswordEmailboolean

sendSetPasswordIdentityType'email' | 'phone' | 'doNotSend'

Used to indicate which identity type a password "request" might go to. It could be used for send set passwords or send password resets.

skipRegistrationVerificationboolean

skipVerificationboolean

verificationIdsstring[]

Example request

{
  "registration": {
    "preferredLanguages": [
      "en_US"
    ],
    "timezone": "America/Denver"
  },
  "user": {
    "preferredLanguages": [
      "en_US"
    ],
    "birthDate": "2007-12-03",
    "timezone": "America/Denver",
    "registrations": [
      {
        "preferredLanguages": [
          "en_US"
        ],
        "timezone": "America/Denver"
      }
    ]
  }
}

Response

Success

refreshTokenstring

refreshTokenIdstring uuid

registrationVerificationIdstring

registrationVerificationOneTimeCodestring

tokenstring

tokenExpirationInstantinteger

The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.

Example response

{
  "registration": {
    "preferredLanguages": [
      "en_US"
    ],
    "timezone": "America/Denver"
  },
  "user": {
    "preferredLanguages": [
      "en_US"
    ],
    "birthDate": "2007-12-03",
    "timezone": "America/Denver",
    "registrations": [
      {
        "preferredLanguages": [
          "en_US"
        ],
        "timezone": "America/Denver"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.