---
title: "Register a new user"
method: POST
path: "/sso/v1/user"
tags: ["sso"]
---

# Register a new user

`POST /sso/v1/user`

## Request

- Base URL: `https://www.spot.im/api`
- URL: `https://www.spot.im/api/sso/v1/user`
- Auth: none declared. Required headers: `x-spotim-sso-access-token`

Registers a new user

## Query parameters

- `primary_key` string, required
- `spot_id` string, required
- `user_name` string, required
- `display_name` string
- `email` string
- `email_verified` boolean
- `image_url` string
- `location` string
- `private_profile` boolean
- `user_metadata` string

## Headers

- `x-spotim-sso-access-token` string, required

## Request body

- object
  - `bio` string: User bio When configuring a user bio, the bio cannot exceed 200 characters. This property can be passed with or without the `role` or `settings` object.
  - `role` 'admin' | 'community-moderator' | 'journalist' | 'moderator' | 'registered' | 'viewer': Permission level of the user **Possible values** - `admin`: Access to all sections of the system - `community-moderator`: Ability to moderate comments within a Conversation, but no Admin Panel access - `journalist`: Ability to select top comments, but no Admin Panel access - `moderator`: Access only to the moderation section - `registered`: Regular user with no assigned role (This is the default permission that is set when no role is specified.) - `viewer`: View-only access to the moderation section This property can be passed with or without the `bio` or `settings` object.
  - `settings` Settings: Email and in-app notification settings
    - `notifications` object: Notifications
      - `email` object
        - `liked_your_message` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `message_approved` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `message_rejected` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `replied_to_message` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `user_mentioned` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
      - `in_app` object
        - `liked_your_message` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `message_approved` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `message_rejected` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `replied_to_message` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent
        - `user_mentioned` 'immediately' | 'never': When notifications are sent **Possible Values**: - `immediately`: Notifications are sent instantly - `never`: Notifications are not sent

## Response `200`

OK

---

[API](https://skmtc.dev/openweb/apis/single-sign-on-api.md) - [All operations](https://skmtc.dev/openweb/apis/single-sign-on-api/llms.txt) - [OpenAPI document](https://skmtc.dev/openweb/apis/single-sign-on-api/revisions/a6965fc745e8?raw)