> For the complete documentation index, see [llms.txt](https://fusionauth.io/docs/llms.txt) # Create a User Registration (for an existing user) API documentation for the FusionAuth Create a User Registration (for an existing user) API. # Create a User Registration (for an existing user) This API is used to create a new User Registration for an existing User. If the User has already created their global account but is now creating an account for an Application, this is the API you will use to create the new account. You must specify the User Id being registered on the URI. The Id of the Application the User is registering for is sent in the request body. ## Request [!API Key Authentication](https://fusionauth.io/docs/apis/authentication.md#api-key-authentication) Create a User Registration for an existing User POST/api/user/registration/{userId} OpenAPI Spec ### Request Parameters `userId`UUIDrequired The Id of the User that is registering for the Application. #### Request Headers `X-FusionAuth-TenantId`Stringoptional The unique Id of the tenant used to scope this API request. The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon the request parameters or it is otherwise not required. Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result. See [Making an API request using a Tenant Id](https://fusionauth.io/docs/apis/authentication.md#making-an-api-request-using-a-tenant-id) for additional information. #### Request Body `generateAuthenticationToken`BooleanoptionalDefaults to false Determines if FusionAuth should generate an Authentication Token for this registration. `registration.applicationId`UUIDrequired The Id of the Application that this registration is for. Beginning in version `1.25.0` this value, while still required may be provided on the request as a URL segment. If the `applicationId` is provided on the URL, it will take precedence over the value found in the request body. `registration.authenticationToken`Stringoptional The authentication token that may be used in place of the User's password when authenticating against this application represented by this registration. This parameter is ignored if **generateAuthenticationToken** is set to `true` and instead the value will be generated. `registration.data`Objectoptional An object that can hold any information about the User for this registration that should be persisted. Please review the [limits on data field types](https://fusionauth.io/docs/get-started/core-concepts/limitations.md#data-type-changes-in-data-fields) as you plan for and build your custom data schema. `registration.preferredLanguages`Arrayoptional An array of locale strings that give, in order, the User's preferred languages for this registration. These are important for email templates and other localizable text. See [Locales](https://fusionauth.io/docs/reference/data-types.md#locales). The maximum number of allowed preferred languages is `20`. `registration.id`UUIDoptionalDefaults to secure random UUID The Id of this registration. If not specified a secure random UUID will be generated. `registration.roles`Arrayoptional The list of roles that the User has for this registration. The string is the role's **Name** not the role's **Id**, e.g. `admin` or **user-role**. `registration.timezone`Stringoptional The User's preferred timezone for this Application registration. The string must be in an [IANA](https://www.iana.org/time-zones) time zone format. `registration.username`Stringoptional The username of the User for this Application. This username cannot be used to login. It is for display purposes only. The **user.username** field may be used to login. `skipRegistrationVerification`BooleanoptionalDefaults to false Indicates to FusionAuth that it should skip registration verification even if it is enabled for the Application. Setting this to `true` will set **registration.verified** to `true` as well. *Example Request JSON* ```json { "registration": { "applicationId": "10000000-0000-0002-0000-000000000001", "data": { "displayName": "Johnny", "favoriteSports": [ "Football", "Basketball" ] }, "id": "00000000-0000-0002-0000-000000000000", "preferredLanguages": [ "en", "fr" ], "roles": [ "user", "community_helper" ], "timezone": "America/Chicago", "username": "johnny123" } } ``` ## Response The response for this API contains the User Registration that was created. Security sensitive fields will not be returned in the response. *Response Codes* | Code | Description | | --- | --- | | 200 | The request was successful. The response will contain a JSON body. | | 400 | The request was invalid and/or malformed. The response will contain an [Errors](https://fusionauth.io/docs/apis/errors.md) JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. | | 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See [Authentication](https://fusionauth.io/docs/apis/authentication.md). | | 404 | The user specified by Id in the request parameter does not exist. The response will be empty. | | 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. | | 503 | The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body. | #### Response Body `refreshToken`StringAvailable since 1.17.0 The refresh token that can be used to obtain a new access token once the provided one has expired. A refresh token will be generated and returned if **application.loginConfiguration.generateRefreshTokens** is `true` for the corresponding application. `refreshTokenId`StringAvailable since 1.37.0 When the **refreshToken** is returned in the response, this field will also be returned. This unique Id is the persistent identifier for this refresh token, and will not change even when using one-time use refresh tokens. This value may optionally be used to revoke the token using the [Refresh Token API](https://fusionauth.io/docs/apis/jwt/revoke-refresh-tokens.md). `registration.applicationId`UUID The Id of the Application that this registration is for. `registration.authenticationToken`String The authentication token that may be used in place of the User's password when authenticating against this application represented by this registration. `registration.cleanSpeakId`UUID This Id is used by FusionAuth when the User's username for this registration is sent to CleanSpeak to be moderated (filtered and potentially sent to the approval queue). It is the **content Id** of the username inside CleanSpeak. `registration.data`Object An object that can hold any information about the User for this registration that should be persisted. `registration.id`UUID The Id of this registration. `registration.insertInstant`Long The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that this registration was created. `registration.lastLoginInstant`Long The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) that the User last logged into the Application for this registration. `registration.preferredLanguages`Array An array of locale strings that give, in order, the User's preferred languages for this registration. These are important for email templates and other localizable text. See [Locales](https://fusionauth.io/docs/reference/data-types.md#locales). `registration.roles`Array The list of roles that the User has for this registration. The string is the role's **Name** not the role's **Id**, e.g. `admin` or **user-role**. `registration.timezone`String The User's preferred timezone for this registration. The string will be in an [IANA](https://www.iana.org/time-zones) time zone format. `registration.tokens`MapDEPRECATED A map that contains tokens returned from identity providers. For example, if this user has authenticated using the Facebook Identity Provider, the Facebook access token will be available in this map, keyed by name `Facebook`. For an OpenID Connect Identity provider, or other generic providers, if a token is stored it will be keyed by the Identity Provider unique Id. Removed in 1.28.0 The token returned and stored from the Identity Provider is now stored in the IdP link and is retrievable using the Identity Provider [Link API](https://fusionauth.io/docs/apis/identity-providers/links.md). `registration.username`String The username of the User for this Application only. `registration.usernameStatus`String The current status of the username. This is used if you are moderating usernames via CleanSpeak. The possible values are: * `ACTIVE` - the username is active * `PENDING` - the username is pending approval/moderation * `REJECTED` - the username was rejected during moderation If a username has been rejected, it is still possible to allow the User to update it and have the new one moderated again. `registration.verified`Boolean This value indicates if this User's registration has been verified. `registrationVerificationId`StringAvailable since 1.27.0 When registration verification is enabled, this value will be returned if the registration has not yet been verified. When using `FormField` verification strategy, this is the first part of the pair of verification Ids, and the **registrationVerificationOneTimeCode** is the second part. When `ClickableLink` is the verification strategy, this value is sensitive in that this value by itself can be used to verify the registration. When `ClickableLink` is the verification strategy, this is the value that will have been emailed to the user in order to complete verification. If you have not configured SMTP, you may optionally use this value to use an out of band transport such as your own email service. Prior to version `1.49.0`, this value was only returned when using `FormField` verification strategy. Beginning in `1.49.0` the value is always returned when available. `registrationVerificationOneTimeCode`StringAvailable since 1.49.2 A registration one time code that will be paired with the **registrationVerificationId**. This value will only be present when when `FormField` is configured as the verification strategy. When present, this value will have been emailed to the user in order to complete verification. If you have not configured SMTP, you may optionally use this value to use an out of band transport such as your own email service. `token`StringAvailable since 1.16.0 The access token, this string is an encoded JSON Web Token (JWT). `tokenExpirationInstant`LongAvailable since 1.33.0 The [instant](https://fusionauth.io/docs/reference/data-types.md#instants) the **token** will expire. If the response does not contain a **token**, this field will also be omitted from the response. *Example Response JSON* ```json { "registration": { "applicationId": "10000000-0000-0002-0000-000000000001", "data": { "displayName": "Johnny", "favoriteSports": [ "Football", "Basketball" ] }, "id": "00000000-0000-0002-0000-000000000000", "insertInstant": 1446064706250, "lastLoginInstant": 1456064601291, "preferredLanguages": [ "en", "fr" ], "roles": [ "user", "community_helper" ], "timezone": "America/Chicago", "username": "johnny123", "usernameStatus": "ACTIVE", "verified": true, "verifiedInstant": 1698772159415 }, "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Ikg3Q3hSNldtMDRUcm1zYXd0SF9BVkEwZTVaLS1UR1lUIn0.eyJhdWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDEiLCJleHAiOjE1ODY4ODEzMzYsImlhdCI6MTU4Njg4MTI3NiwiaXNzIjoiZnVzaW9uYXV0aC5pbyIsInN1YiI6IjAwMDAwMDAwLTAwMDAtMDAwMS0wMDAwLTAwMDAwMDAwMDAwMSIsImF1dGhlbnRpY2F0aW9uVHlwZSI6IlJFR0lTVFJBVElPTiIsImVtYWlsIjoiZW1haWxAdGVzdC5jb20iLCJlbWFpbF92ZXJpZmllZCI6dHJ1ZSwicHJlZmVycmVkX3VzZXJuYW1lIjoidXNlcm5hbWUiLCJhcHBsaWNhdGlvbklkIjoiMDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAxIiwicm9sZXMiOlt7ImlkIjoiNjM1YzU3ZmMtNzMwZC00OWY2LWEzM2YtZGQ1YTlmZTRlMjc5IiwiaXNEZWZhdWx0IjpmYWxzZSwiaXNTdXBlclJvbGUiOmZhbHNlLCJuYW1lIjoicm9sZSAxIn1dfQ.9IuprQIe2SGYWPV6nL_XNBEpb4XaTSBBxiyLAWtg4pg" } ```