コンテンツにスキップ

Create an organization domain mapping.

POST
/api/admin/org-domain-mappings
Code sample: Shell / cURL
curl --request POST \
--url https://auth.example.com/api/admin/org-domain-mappings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "domain": "example.com", "org_id": "org_acme", "auto_join_enabled": true, "membership_type": "member", "auto_assign_role_id": null, "priority": 10, "is_active": true }'

Creates a tenant-scoped email-domain mapping for an organization. The raw domain is validated and hashed for storage; the response echoes the lowercase domain for operator reference.

Media type application/json
object
domain
required

Raw email domain. The server hashes this value before storage.

string
<= 253 characters
org_id
required
string
auto_join_enabled
boolean
default: true
membership_type
string
default: member
Allowed values: member admin owner
auto_assign_role_id
string | null
priority
integer
0 <= 1000
is_active
boolean
default: true
key
additional properties
Example
{
"domain": "example.com",
"org_id": "org_acme",
"auto_join_enabled": true,
"membership_type": "member",
"auto_assign_role_id": null,
"priority": 10,
"is_active": true
}

Organization domain mapping create response.

Media type application/json
object
domain

Raw domain echoed from the create request.

string
id
required
string
tenant_id
required
string
domain_hash
required
string
domain_hash_version
required
integer
org_id
required
string
auto_join_enabled
required
boolean
membership_type
required
string
Allowed values: member admin owner
auto_assign_role_id
string
verified
required
boolean
priority
required
integer
is_active
required
boolean
created_at
required
integer format: int64
updated_at
required
integer format: int64
Example
{
"membership_type": "member"
}

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"
}

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"
}

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"
}

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"
}

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"
}

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"
}