---
title: "Create Invitation"
method: POST
path: "/api/v1/auth-management/user-invitations"
tags: ["userManagement"]
---

# Create Invitation

`POST /api/v1/auth-management/user-invitations`

Create a new user invitation.

This endpoint creates a new invitation for a user to join the organization.
The invitation will be sent to the specified email address.

## Headers

- `Authorization` string, required

## Request body

- CreateUserInvitationRequest — Request model for creating a new user invitation. This model is used to invite a new user to join an organization. The invitation will be sent to the specified email address and will include the roles that will be assigned to the user upon acceptance.
  - `name` string, required — Display name for the invited user
  - `email` string, required — Email address to send the invitation to
  - `roles` Role[] — List of roles to assign to the user
    - `role_id` string, required — Name of the role (e.g., 'admin', 'editor', 'viewer')
    - `resource` string, nullable — Optional resource type the role applies to (e.g., 'dataset')
    - `resource_instance` string, nullable — Optional resource instance ID the role applies to

## Response `201`

The created invitation details

- UserInvitation — Model representing a user invitation. This model contains the details of an invitation sent to a user, including the invitation ID, who sent it, who it was sent to, and the roles that will be assigned upon acceptance. The invitation URL is included for the user to accept the invitation.
  - `invitation_id` string, required — Unique identifier for the invitation
  - `inviter` Inviter, required — Model representing the user who sent the invitation. This model contains the details of the user who sent the invitation, including their display name.
    - `name` string, required — Display name of the inviter
  - `invitee` Invitee, required
    - `email` string, required — Email address of the invitee
    - `name` string, required — Display name of the invitee
    - `roles` Role[], required — List of roles to assign to the invitee
      - `role_id` string, required — Name of the role (e.g., 'admin', 'editor', 'viewer')
      - `resource` string, nullable — Optional resource type the role applies to (e.g., 'dataset')
      - `resource_instance` string, nullable — Optional resource instance ID the role applies to
  - `invitation_url` string, required — URL for the user to accept the invitation
  - `created_at` string, required — Timestamp when the invitation was created
  - `expires_at` string, required — Timestamp when the invitation expires
  - `roles` Role[], required — List of roles that will be assigned upon acceptance
    - `role_id` string, required — Name of the role (e.g., 'admin', 'editor', 'viewer')
    - `resource` string, nullable — Optional resource type the role applies to (e.g., 'dataset')
    - `resource_instance` string, nullable — Optional resource instance ID the role applies to

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/coactive/apis/api-reference.md) · [All operations](https://skmtc.dev/coactive/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/coactive/api-reference/revisions/1223758be9ba/schema)