Get org domain

Get a domain from the list of an organization's whitelisted domains. Returns both verified and unverified domains by their ID

Path Parameters

org_id string required

unique id of the organization for which whitelisted domain is to be retrieved

id string required

unique id of the domain to be retrieved

Responses

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

---

A successful response.

application/json

Schema

Example (from schema)

---

Schema

domain object

id string

The domain id

name string

The domain name

org_id string

The organization id

token string

The dns TXT record token to verify the domain

state string

The domain state either pending or verified

created_at date-time

The time the domain whitelist request was created

updated_at date-time

The time the org domain was updated

{
  "domain": {
    "id": "943e4567-e89b-12d3-a456-426655440000",
    "name": "raystack.org",
    "org_id": "123e4567-e89b-12d3-a456-426655440000",
    "token": "_frontier-domain-verification=LB6U2lSQgGS55HOy6kpWFqkngRC8TMEjyrakfmYC2D0s+nfy/WkFSg==",
    "state": "pending",
    "created_at": "2023-06-07T05:39:56.961Z",
    "updated_at": "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"
    }
  ]
}

GET /v1beta1/organizations/:org_id/domains/:id

Authorization

name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic

Request

Base URL

http://127.0.0.1:7400

Security Scheme

BasicBearer

Username

Password

org_id — path required

id — path required

curl / cURL

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/domains/:id' \
-H 'Accept: application/json'

python / requests

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/domains/:id' \
-H 'Accept: application/json'

go / native

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/domains/:id' \
-H 'Accept: application/json'

nodejs / axios

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/domains/:id' \
-H 'Accept: application/json'

ruby / Net::HTTP

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/domains/:id' \
-H 'Accept: application/json'

csharp / RestSharp

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/domains/:id' \
-H 'Accept: application/json'

php / cURL

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/domains/:id' \
-H 'Accept: application/json'

java / OkHttp

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/domains/:id' \
-H 'Accept: application/json'

powershell / RestMethod

curl -L -X GET 'http://127.0.0.1:7400/v1beta1/organizations/:org_id/domains/:id' \
-H 'Accept: application/json'