# Signup user

Sign up a new user and create a new account (tenant).

This endpoint registers a user with authentication details such as email, password, and the provider used for authentication (e.g., local, saml, google, github). Refer to the documentation or dropdown menu for the full list of supported provider values.

Additional optional fields such as user metadata may also be included. If not needed, metadata can be passed as an empty object (e.g., {}).

This endpoint is typically used during account (tenant) onboarding or self-sign-up flows.

Endpoint: POST /resources/users/v1/signUp
Security: bearer

## Header parameters:

  - `frontegg-vendor-host` (string, required)

  - `frontegg-application-id` (string, required)
    The application id

## Request fields (application/json):

  - `provider` (string, required)
    Enum: "local", "saml", "google", "github", "facebook", "microsoft", "scim2", "slack", "apple"

  - `metadata` (string)
    Stringified JSON object. Use the JSON.stringify() method.

  - `email` (string, required)

  - `username` (string)

  - `name` (string)

  - `profilePictureUrl` (string)

  - `password` (string)

  - `skipInviteEmail` (boolean)

  - `roleIds` (array)

  - `emailMetadata` (object)

  - `companyName` (string, required)

  - `recaptchaToken` (string)

  - `invitationToken` (string)

  - `phoneNumber` (string)

## Response 201 fields (application/json):

  - `provider` (string, required)
    Enum: "local", "saml", "google", "github", "facebook", "microsoft", "scim2", "slack", "apple"

  - `metadata` (string)
    Stringified JSON object. Use the JSON.stringify() method.

  - `email` (string, required)

  - `username` (string)

  - `name` (string)

  - `profilePictureUrl` (string)

  - `password` (string)

  - `skipInviteEmail` (boolean)

  - `roleIds` (array)

  - `emailMetadata` (object)

  - `companyName` (string, required)

  - `recaptchaToken` (string)

  - `invitationToken` (string)

  - `phoneNumber` (string)


## Response 200 fields