Skip to content
Authrim

Update a platform tenant domain mapping.

PUT
/api/admin/platform/tenant-domain-mappings/{id}
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/platform/tenant-domain-mappings/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "priority": 20, "is_active": true }'

Update the priority or active state for an existing tenant domain mapping. The mapped email domain and domain hash cannot be changed and the domain hash is intentionally not returned.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Tenant domain mapping identifier.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
>= 1 properties
priority
integer
<= 1000
is_active
boolean
key
additional properties
Example 
{
  "priority": 20,
  "is_active": true
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Tenant domain mapping response.

Media type application/json
object
id
required
string
tenant_id
required
string
hash_version
required
integer
priority
required
integer
is_active
required
boolean
verified
required
boolean
verification_expires_at
required
integer | null format: int64
created_by
required
string | null
created_at
required
integer format: int64
updated_at
required
integer format: int64
key
additional properties
Example 
{
  "id": "mapping_123",
  "tenant_id": "default",
  "hash_version": 1,
  "priority": 10,
  "is_active": true,
  "verified": false,
  "verification_expires_at": null,
  "created_by": "admin_123",
  "created_at": 1770000000,
  "updated_at": 1770000000
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}