---
title: "Register a user"
method: POST
path: "/api/v1/users"
tags: ["Users"]
---

# Register a user

`POST /api/v1/users`

## Request body

- object
  - `user_name` string, required — Full user name
  - `first_name` string
  - `last_name` string
  - `email_address` string, required — E-mail address (also the login)
  - `registered_account_id` integer — Subcatalog to associate (defaults to the API key root account)
  - `custom_fields` object — Custom field values

## Response `200`

user registered

- object
  - `user` object, required
    - `id` integer, required — Catalog user id
    - `root_account_id` integer, required — Root account id
    - `canvas_user_id` integer, required — Canvas user id
    - `registered_account_id` integer — Account where the user was registered
    - `canvas_root_account_uuid` string — Canvas root account UUID
    - `canvas_user_uuid` string — Canvas user UUID
    - `user_name` string — Full name
    - `first_name` string — First name
    - `last_name` string — Last name
    - `email_address` string — E-mail address
    - `custom_fields` object, required — Custom field values, e.g. { "phone": "(999) 123-4567" }
    - `created_at` string, required — Date/time of creation
    - `updated_at` string, required — Date/time of last update
    - `confirmation_url` string — User confirmation URL
    - `terms_of_use` boolean — Terms-of-use flag
    - `locale` string — User locale based on registered account

---

[API](https://skmtc.net/instructure/apis/canvas-catalog-api.md) · [All operations](https://skmtc.net/instructure/apis/canvas-catalog-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/instructure/canvas-catalog-api/revisions/78578cd3e37a/schema)