List org domains

Returns all trusted domains for an organization, which are used to allow users to sign up with a specific email domain without invitation. The domain ownership must be verified before it can be used as a trusted domain. Use the verified filter to get only the verified domains.

Path Parameters

orgId string required

unique id of the organization for which whitelisted domains are to be listed

Query Parameters

verified boolean

filter to list only verified domains. If not provided, all domains for an org will be listed

Responses

• 200
• 400
• 401
• 403
• 404
• 500
• default

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

domains object[]
Array [
id string
The domain id
name string
The domain name
orgId string
The organization id
token string
The dns TXT record token to verify the domain
verified boolean
true if the domain is verified, false otherwise
createdAt date-time
The time the domain whitelist request was created
verifiedAt date-time
The time the org domain was verified
]

{
  "domains": [
    {
      "id": "943e4567-e89b-12d3-a456-426655440000",
      "name": "raystack.org",
      "orgId": "123e4567-e89b-12d3-a456-426655440000",
      "token": "_frontier-challenge:1234567890123456",
      "verified": true,
      "createdAt": "2023-06-07T05:39:56.961Z",
      "verifiedAt": "2023-06-07T05:39:56.961Z"
    }
  ]
}

Bad Request - The request was malformed or contained invalid parameters.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Unauthorized - Authentication is required

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Forbidden - User does not have permission to access the resource

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Not Found - The requested resource was not found

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Internal Server Error. Returned when theres is something wrong with Frontier server.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

Schema

Example (from schema)

---

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...