---
title: "Signup user"
method: POST
path: "/resources/users/v1/signUp"
tags: ["User management"]
---

# Signup user

`POST /resources/users/v1/signUp`

## Request

- Base URL: `http://localhost:8181`
- URL: `http://localhost:8181/resources/users/v1/signUp`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/docs/resources/users/v1/signUp/post.ts> (a function with typed inputs; its response is checked against the schema)

This route is for signing up a new user and new tenant. Send the **`frontegg-vendor-host`** header. This is your domain name in the Frontegg Portal ➜ Workspace Settings ➜ Domains ➜ Domain Name. Send the user's information in the POST body. The user's email, provider, companyName, and metadata are required. The provider is the authentication provider, like local, saml, google, github. See the dropdown for available values. The metadata can be empty, like `{}`. You also can send in the POST body additional information as shown in the example. A vendor token is required for this route, it can be obtained from the vendor authentication route.

## Headers

- `frontegg-vendor-host` string, required
- `frontegg-application-id` string, required

## Request body

- SignUpUserDto
  - `provider` 'local' | 'saml' | 'google' | 'github' | 'facebook' | 'microsoft' | 'scim2' | 'slack' | 'apple', required
  - `metadata` string: Stringified JSON object. Use the JSON.stringify() method.
  - `email` string, required
  - `name` string
  - `profilePictureUrl` string
  - `password` string
  - `phoneNumber` string
  - `skipInviteEmail` boolean
  - `roleIds` string[]
  - `emailMetadata` object
  - `companyName` string, required
  - `recaptchaToken` string
  - `invitationToken` string

## Response `200`

## Other responses

- `201`

---

[API](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp.md) - [All operations](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/llms.txt) - [OpenAPI document](https://skmtc.dev/frontegg/apis/entitlements-agent-pdp/revisions/c496ae9e1c3e?raw)