Skip to content
Authrim

List organization domain mappings.

GET
/api/admin/org-domain-mappings
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/org-domain-mappings?limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

Lists email-domain-to-organization mappings for the current tenant with optional organization, verified, active-state, limit, and offset filters.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
org_id
string

Filter mappings for one organization.

verified
boolean

Filter by verified status.

is_active
boolean

Filter by active status.

limit
integer
default: 50 >= 1 <= 100

Maximum mappings to return.

offset
integer
0

Offset for list pagination.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Organization domain mapping list response.

Media type application/json
object
mappings
required
Array<object>
object
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
key
additional properties
total
required
integer
limit
required
integer
>= 1 <= 100
offset
required
integer
key
additional properties
Example 
{
  "mappings": [
    {
      "membership_type": "member"
    }
  ]
}

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

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