Atlassian · Schema

Domain

Represents a verified domain associated with an organization.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
id string The unique identifier of the domain.
type string The resource type.
attributes object The attributes of the domain.
View JSON Schema on GitHub

JSON Schema

atlassian-domain-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Domain",
  "title": "Domain",
  "type": "object",
  "description": "Represents a verified domain associated with an organization.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the domain.",
      "example": "abc123"
    },
    "type": {
      "type": "string",
      "description": "The resource type.",
      "enum": [
        "domain"
      ],
      "example": "domain"
    },
    "attributes": {
      "type": "object",
      "description": "The attributes of the domain.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The domain name."
        },
        "claim": {
          "type": "object",
          "description": "The claim details for the domain.",
          "properties": {
            "type": {
              "type": "string",
              "description": "The type of domain claim.",
              "enum": [
                "http",
                "dns",
                "verified"
              ]
            },
            "status": {
              "type": "string",
              "description": "The verification status.",
              "enum": [
                "verified",
                "pending"
              ]
            }
          }
        }
      },
      "example": "example_value"
    }
  }
}