Endpoint

/v1/ad/settings

GET

Gets advanced Active Directory settings.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "ad_settings",
  "type": "object",
  "properties": {
    "signing": {
      "type": "string",
      "enum": [
        "NO_SIGNING",
        "WANT_SIGNING",
        "REQUIRE_SIGNING"
      ],
      "description": "Setting for DCERPC signing; only use if sealing is not negotiated:\n * `NO_SIGNING` - Do not use DCERPC signing.,\n * `REQUIRE_SIGNING` - Require the use of DCERPC signing.,\n * `WANT_SIGNING` - Prefer to use DCERPC signing; allow server to decide."
    },
    "sealing": {
      "type": "string",
      "enum": [
        "NO_SEALING",
        "WANT_SEALING",
        "REQUIRE_SEALING"
      ],
      "description": "Setting for DCERPC sealing.:\n * `NO_SEALING` - Do not use sealing.,\n * `REQUIRE_SEALING` - Require the use of sealing.,\n * `WANT_SEALING` - Prefer to use sealing; allow server to decide."
    },
    "crypto": {
      "type": "string",
      "enum": [
        "NO_AES",
        "WANT_AES",
        "REQUIRE_AES"
      ],
      "description": "Setting for authenticator and sealing crypto.:\n * `NO_AES` - Do not use AES.,\n * `REQUIRE_AES` - Require the use of AES.,\n * `WANT_AES` - Prefer use of AES; allow server to decide."
    }
  }
}

PUT

Sets advanced Active Directory settings.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "description": "ad_settings",
  "type": "object",
  "properties": {
    "signing": {
      "type": "string",
      "enum": [
        "NO_SIGNING",
        "WANT_SIGNING",
        "REQUIRE_SIGNING"
      ],
      "description": "Setting for DCERPC signing; only use if sealing is not negotiated:\n * `NO_SIGNING` - Do not use DCERPC signing.,\n * `REQUIRE_SIGNING` - Require the use of DCERPC signing.,\n * `WANT_SIGNING` - Prefer to use DCERPC signing; allow server to decide."
    },
    "sealing": {
      "type": "string",
      "enum": [
        "NO_SEALING",
        "WANT_SEALING",
        "REQUIRE_SEALING"
      ],
      "description": "Setting for DCERPC sealing.:\n * `NO_SEALING` - Do not use sealing.,\n * `REQUIRE_SEALING` - Require the use of sealing.,\n * `WANT_SEALING` - Prefer to use sealing; allow server to decide."
    },
    "crypto": {
      "type": "string",
      "enum": [
        "NO_AES",
        "WANT_AES",
        "REQUIRE_AES"
      ],
      "description": "Setting for authenticator and sealing crypto.:\n * `NO_AES` - Do not use AES.,\n * `REQUIRE_AES` - Require the use of AES.,\n * `WANT_AES` - Prefer use of AES; allow server to decide."
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "ad_settings",
  "type": "object",
  "properties": {
    "signing": {
      "type": "string",
      "enum": [
        "NO_SIGNING",
        "WANT_SIGNING",
        "REQUIRE_SIGNING"
      ],
      "description": "Setting for DCERPC signing; only use if sealing is not negotiated:\n * `NO_SIGNING` - Do not use DCERPC signing.,\n * `REQUIRE_SIGNING` - Require the use of DCERPC signing.,\n * `WANT_SIGNING` - Prefer to use DCERPC signing; allow server to decide."
    },
    "sealing": {
      "type": "string",
      "enum": [
        "NO_SEALING",
        "WANT_SEALING",
        "REQUIRE_SEALING"
      ],
      "description": "Setting for DCERPC sealing.:\n * `NO_SEALING` - Do not use sealing.,\n * `REQUIRE_SEALING` - Require the use of sealing.,\n * `WANT_SEALING` - Prefer to use sealing; allow server to decide."
    },
    "crypto": {
      "type": "string",
      "enum": [
        "NO_AES",
        "WANT_AES",
        "REQUIRE_AES"
      ],
      "description": "Setting for authenticator and sealing crypto.:\n * `NO_AES` - Do not use AES.,\n * `REQUIRE_AES` - Require the use of AES.,\n * `WANT_AES` - Prefer use of AES; allow server to decide."
    }
  }
}