> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.royalti.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Add User to Tenant

> **/user/{userId}/aut**

<Note>
  This endpoint requires authentication. Include your Bearer token in the Authorization header.
</Note>

## Description

**/user/{userId}/aut**

**Description:**
The `/user/{userId}/aut` endpoint allows users to add a specific user to a tenant identified by their unique userId.

**Method:**
PUT

**Path Parameter:**

| Parameter | Type   | Description                        |
| --------- | ------ | ---------------------------------- |
| userId    | string | The unique identifier of the user. |

**Request Body (Optional):**

| Parameter     | Type    | Description                                                 |
| ------------- | ------- | ----------------------------------------------------------- |
| redirect\_url | string  | The URL to redirect the user to after adding to tenant      |
| sendEmail     | boolean | Whether to send an invite email to the user (default: true) |

## Code Examples

<CodeGroup>
  ```javascript Node.js theme={null}
  const response = await fetch('https://api.royalti.io/user/example-id/aut', {
    method: 'PUT',
    headers: {
      'Authorization': `Bearer ${token}`,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      "redirect_url": "https://app.royalti.io/welcome",
      "sendEmail": true
    })
  });

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
    'https://api.royalti.io/user/example-id/aut',
    headers={
      'Authorization': f'Bearer {token}'
    },
    json={"redirect_url":"https://app.royalti.io/welcome","sendEmail":true}
  )

  data = response.json()
  print(data)
  ```

  ```bash cURL theme={null}
  curl -X PUT https://api.royalti.io/user/example-id/aut \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"redirect_url":"https://app.royalti.io/welcome","sendEmail":true}'

  ```
</CodeGroup>


## OpenAPI

````yaml put /user/{id}/aut
openapi: 3.0.0
info:
  title: Royalti.io API
  description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
  version: 2.6.0
  contact:
    name: Royalti.io Support
    email: support@royalti.io
    url: https://royalti.io
  license:
    name: Proprietary
    url: https://royalti.io/terms
servers:
  - url: https://api.royalti.io
    description: Production server
  - url: https://api-dev.royalti.io
    description: Development server
  - url: http://localhost:8084
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Accounting
    description: Accounting and financial transaction operations
  - name: DDEX
    description: DDEX operations (ERN/MEAD, messages, delivery, providers)
  - name: Label
    description: Label management operations
  - name: Internal Webhooks
    description: Internal system webhooks for royalty processing and downloads
  - name: Payment Webhooks
    description: Payment processor webhook endpoints
  - name: Billing Webhooks
    description: Stripe billing and subscription webhooks
  - name: Infrastructure Webhooks
    description: Cloudflare domain and SSL webhooks
  - name: Distribution Webhooks
    description: Digital distribution platform webhooks (FUGA)
paths:
  /user/{id}/aut:
    put:
      tags:
        - User
      summary: Add User to Tenant
      description: >-
        **/user/{userId}/aut**


        **Description:**

        The `/user/{userId}/aut` endpoint allows users to add a specific user to
        a tenant identified by their unique userId.


        **Method:**

        PUT


        **Path Parameter:**


        | Parameter | Type | Description |

        | --- | --- | --- |

        | userId | string | The unique identifier of the user. |


        **Request Body (Optional):**


        | Parameter | Type | Description |

        | --- | --- | --- |

        | redirect_url | string | The URL to redirect the user to after adding
        to tenant |

        | sendEmail | boolean | Whether to send an invite email to the user
        (default: true) |
      parameters:
        - name: id
          in: path
          required: true
          description: User ID (TenantUser ID)
          schema:
            type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                redirect_url:
                  type: string
                  description: The URL to redirect the user to after adding to tenant
                  example: https://app.royalti.io/welcome
                sendEmail:
                  type: boolean
                  description: Whether to send an invite email to the user
                  default: true
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: array
              items:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Authorization header using the Bearer scheme. Format: "Bearer
        {token}"

````