JoinDomainInput

JoinDomainInput

BackupFile StorageGatewayHybrid CloudStorage

Properties

Name Type Description
GatewayARN object
DomainName object
OrganizationalUnit object
DomainControllers object
TimeoutInSeconds object
UserName object
Password object
View JSON Schema on GitHub

JSON Schema

amazon-storage-gateway-join-domain-input-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-storage-gateway/refs/heads/main/json-schema/amazon-storage-gateway-join-domain-input-schema.json",
  "title": "JoinDomainInput",
  "description": "JoinDomainInput",
  "type": "object",
  "properties": {
    "GatewayARN": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GatewayARN"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the gateway. Use the <code>ListGateways</code> operation to return a list of gateways for your account and Amazon Web Services Region."
        }
      ]
    },
    "DomainName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DomainName"
        },
        {
          "description": "The name of the domain that you want the gateway to join."
        }
      ]
    },
    "OrganizationalUnit": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OrganizationalUnit"
        },
        {
          "description": "The organizational unit (OU) is a container in an Active Directory that can hold users, groups, computers, and other OUs and this parameter specifies the OU that the gateway will join within the AD domain."
        }
      ]
    },
    "DomainControllers": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Hosts"
        },
        {
          "description": "List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need to specify the port number include it after the colon (\u201c:\u201d). For example, <code>mydc.mydomain.com:389</code>."
        }
      ]
    },
    "TimeoutInSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimeoutInSeconds"
        },
        {
          "description": "Specifies the time in seconds, in which the <code>JoinDomain</code> operation must complete. The default is 20 seconds."
        }
      ]
    },
    "UserName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DomainUserName"
        },
        {
          "description": "Sets the user name of user who has permission to add the gateway to the Active Directory domain. The domain user account should be enabled to join computers to the domain. For example, you can use the domain administrator account or an account with delegated permissions to join computers to the domain."
        }
      ]
    },
    "Password": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DomainUserPassword"
        },
        {
          "description": "Sets the password of the user who has permission to add the gateway to the Active Directory domain."
        }
      ]
    }
  },
  "required": [
    "GatewayARN",
    "DomainName",
    "UserName",
    "Password"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/amazon-storage-gateway-join-domain-input"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.