Add org domain
Add a domain to an organization which if verified allows all users of the same domain to be signed up to the organization without invitation. This API generates a verification token for a domain which must be added to your domain's DNS provider as a TXT record should be verified with Frontier VerifyOrgDomain API before it can be used as an Organization's trusted domain to sign up users.
Path Parameters
unique id of the organization for which whitelisted domains are to be added
Request Body required
domain name to be added to the trusted domain list
- 200
- 400
- 401
- 403
- 404
- 500
- default
A successful response.
Schema
domain object
The domain id
The domain name
The organization id
The dns TXT record token to verify the domain
true if the domain is verified, false otherwise
The time the domain whitelist request was created
The time the org domain was verified
{
"domain": {
"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.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Unauthorized - Authentication is required
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Forbidden - User does not have permission to access the resource
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Not Found - The requested resource was not found
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Internal Server Error. Returned when theres is something wrong with Frontier server.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}