Skip to main content
PUT
/
user
/
{id}
/
aut
Add User to Tenant
curl --request PUT \
  --url https://api.royalti.io/user/{id}/aut \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "redirect_url": "https://app.royalti.io/welcome",
  "sendEmail": true
}
'
{}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

/user//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:
ParameterTypeDescription
userIdstringThe unique identifier of the user.
Request Body (Optional):
ParameterTypeDescription
redirect_urlstringThe URL to redirect the user to after adding to tenant
sendEmailbooleanWhether to send an invite email to the user (default: true)

​
Code Examples

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);

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Path Parameters

​
id
string
required

User ID (TenantUser ID)

Body

application/json
​
redirect_url
string

The URL to redirect the user to after adding to tenant

Example:

"https://app.royalti.io/welcome"

​
sendEmail
boolean
default:true

Whether to send an invite email to the user

Response

success

The response is of type object.