> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.getunleash.io/api/add-public-signup-token-user/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getunleash.io/_mcp/server. # Add a user via a signup token POST https://app.unleash-instance.example.com/invite/{token}/signup Content-Type: application/json Create a user with the viewer root role and link them to the provided signup token Reference: https://docs.getunleash.io/api/add-public-signup-token-user ## Authentication - `Authorization` header (required) — API key needed to access this API - `Authorization` header (bearer token, required) — API key needed to access this API, in Bearer token format ## Request ### Path parameters - `token` (string, required) ### Body (application/json) This endpoint expects a createInvitedUserSchema. - `email` (string, required) — The invited user's email address - `name` (string, required) — The user's name - `password` (string, required) — The user's password - `username` (string, optional) — The user's username. Must be unique if provided. ## Response ### 200 userSchema - `id` (integer, required) — The user id - `name` (string, optional, nullable) — Name of the user - `email` (string, optional) — Email of the user - `username` (string, optional, nullable) — A unique username for the user - `imageUrl` (string, optional) — URL used for the user profile image - `inviteLink` (string, optional) — If the user is actively inviting other users, this is the link that can be shared with other users - `loginAttempts` (integer, optional) — How many unsuccessful attempts at logging in has the user made - `emailSent` (boolean, optional) — Is the welcome email sent to the user or not - `rootRole` (integer, optional) — Which [root role](https://docs.getunleash.io/concepts/rbac#predefined-roles) this user is assigned - `seenAt` (string, optional, nullable) — The last time this user logged in - `createdAt` (string, optional) — The user was created at this time - `accountType` (enum, optional) — A user is either an actual User or a Service Account - Allowed values: `User`, `Service Account` - `permissions` (list of string, optional) — Deprecated - `scimId` (string, optional, nullable) — The SCIM ID of the user, only present if managed by SCIM - `seatType` (string, optional, nullable) — The seat type of this user - `companyRole` (string, optional, nullable) — The role of the user within the company. - `productUpdatesEmailConsent` (boolean, optional, nullable) — Whether the user has consented to receive product update emails. - `activeSessions` (integer, optional, nullable) — Count of active browser sessions for this user - `deletedSessions` (double, optional) — Experimental. The number of deleted browser sessions after last login ## Errors ### 400 Bad Request Error The request data does not match what we expect. - `id` (string, optional) — The ID of the error instance - `name` (string, optional) — The name of the error kind - `message` (string, optional) — A description of what went wrong. ### 409 Conflict Error The provided resource can not be created or updated because it would conflict with the current state of the resource or with an already existing resource, respectively. - `id` (string, optional) — The ID of the error instance - `name` (string, optional) — The name of the error kind - `message` (string, optional) — A description of what went wrong. ## Examples **Request** ```json { "email": "hunter@example.com", "name": "Hunter Burgan", "password": "hunter2" } ``` **Response** ```json { "id": 123, "name": "User", "email": "user@example.com", "username": "hunter", "imageUrl": "https://example.com/242x200.png", "inviteLink": "http://localhost:4242/invite-link/some-secret", "loginAttempts": 3, "emailSent": false, "rootRole": 1, "seenAt": "2023-06-30T11:42:00.345Z", "createdAt": "2023-06-30T11:41:00.123Z", "accountType": "User", "permissions": [ "string" ], "scimId": "01HTMEXAMPLESCIMID7SWWGHN6", "seatType": "Regular", "companyRole": "Developer", "productUpdatesEmailConsent": false, "activeSessions": 2, "deletedSessions": 1 } ``` **SDK Code** ```python import requests url = "https://app.unleash-instance.example.com/invite/token/signup" payload = { "email": "hunter@example.com", "name": "Hunter Burgan", "password": "hunter2" } headers = { "Authorization": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://app.unleash-instance.example.com/invite/token/signup'; const options = { method: 'POST', headers: {Authorization: '', 'Content-Type': 'application/json'}, body: '{"email":"hunter@example.com","name":"Hunter Burgan","password":"hunter2"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://app.unleash-instance.example.com/invite/token/signup" payload := strings.NewReader("{\n \"email\": \"hunter@example.com\",\n \"name\": \"Hunter Burgan\",\n \"password\": \"hunter2\"\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://app.unleash-instance.example.com/invite/token/signup") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"email\": \"hunter@example.com\",\n \"name\": \"Hunter Burgan\",\n \"password\": \"hunter2\"\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://app.unleash-instance.example.com/invite/token/signup") .header("Authorization", "") .header("Content-Type", "application/json") .body("{\n \"email\": \"hunter@example.com\",\n \"name\": \"Hunter Burgan\",\n \"password\": \"hunter2\"\n}") .asString(); ``` ```php request('POST', 'https://app.unleash-instance.example.com/invite/token/signup', [ 'body' => '{ "email": "hunter@example.com", "name": "Hunter Burgan", "password": "hunter2" }', 'headers' => [ 'Authorization' => '', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://app.unleash-instance.example.com/invite/token/signup"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"email\": \"hunter@example.com\",\n \"name\": \"Hunter Burgan\",\n \"password\": \"hunter2\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "", "Content-Type": "application/json" ] let parameters = [ "email": "hunter@example.com", "name": "Hunter Burgan", "password": "hunter2" ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://app.unleash-instance.example.com/invite/token/signup")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```