Endpoint

/v1/auth/kerberos-keytab

GET

Get the entries from the current keytab configuration

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "kerberos_keytab",
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "description": "entries",
        "type": "object",
        "properties": {
          "principal": {
            "description": "principal",
            "type": "string"
          },
          "version": {
            "description": "version",
            "type": "number"
          },
          "enctype": {
            "type": "string",
            "enum": [
              "KERBEROS_ENCRYPTION_TYPE_NULL",
              "KERBEROS_ENCRYPTION_TYPE_DES_CBC_CRC",
              "KERBEROS_ENCRYPTION_TYPE_DES_CBC_MD4",
              "KERBEROS_ENCRYPTION_TYPE_DES_CBC_MD5",
              "KERBEROS_ENCRYPTION_TYPE_DES3_CBC_MD5",
              "KERBEROS_ENCRYPTION_TYPE_OLD_DES3_CBC_SHA1",
              "KERBEROS_ENCRYPTION_TYPE_SIGN_DSA_GENERATE",
              "KERBEROS_ENCRYPTION_TYPE_ENCRYPT_RSA_PRIV",
              "KERBEROS_ENCRYPTION_TYPE_ENCRYPT_RSA_PUB",
              "KERBEROS_ENCRYPTION_TYPE_DES3_CBC_SHA1",
              "KERBEROS_ENCRYPTION_TYPE_AES128_CTS_HMAC_SHA1_96",
              "KERBEROS_ENCRYPTION_TYPE_AES256_CTS_HMAC_SHA1_96",
              "KERBEROS_ENCRYPTION_TYPE_AES128_CTS_HMAC_SHA256_128",
              "KERBEROS_ENCRYPTION_TYPE_AES256_CTS_HMAC_SHA384_192",
              "KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_MD5",
              "KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_MD5_56",
              "KERBEROS_ENCRYPTION_TYPE_ENCTYPE_PK_CROSS",
              "KERBEROS_ENCRYPTION_TYPE_ARCFOUR_MD4",
              "KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_OLD",
              "KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_OLD_EXP",
              "KERBEROS_ENCRYPTION_TYPE_DES_CBC_NONE",
              "KERBEROS_ENCRYPTION_TYPE_DES3_CBC_NONE",
              "KERBEROS_ENCRYPTION_TYPE_DES_CFB64_NONE",
              "KERBEROS_ENCRYPTION_TYPE_DES_PCBC_NONE",
              "KERBEROS_ENCRYPTION_TYPE_DIGEST_MD5_NONE",
              "KERBEROS_ENCRYPTION_TYPE_CRAM_MD5_NONE"
            ],
            "description": "enctype:\n * `KERBEROS_ENCRYPTION_TYPE_AES128_CTS_HMAC_SHA1_96` - KERBEROS_ENCRYPTION_TYPE_AES128_CTS_HMAC_SHA1_96,\n * `KERBEROS_ENCRYPTION_TYPE_AES128_CTS_HMAC_SHA256_128` - KERBEROS_ENCRYPTION_TYPE_AES128_CTS_HMAC_SHA256_128,\n * `KERBEROS_ENCRYPTION_TYPE_AES256_CTS_HMAC_SHA1_96` - KERBEROS_ENCRYPTION_TYPE_AES256_CTS_HMAC_SHA1_96,\n * `KERBEROS_ENCRYPTION_TYPE_AES256_CTS_HMAC_SHA384_192` - KERBEROS_ENCRYPTION_TYPE_AES256_CTS_HMAC_SHA384_192,\n * `KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_MD5` - KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_MD5,\n * `KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_MD5_56` - KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_MD5_56,\n * `KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_OLD` - KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_OLD,\n * `KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_OLD_EXP` - KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_OLD_EXP,\n * `KERBEROS_ENCRYPTION_TYPE_ARCFOUR_MD4` - KERBEROS_ENCRYPTION_TYPE_ARCFOUR_MD4,\n * `KERBEROS_ENCRYPTION_TYPE_CRAM_MD5_NONE` - KERBEROS_ENCRYPTION_TYPE_CRAM_MD5_NONE,\n * `KERBEROS_ENCRYPTION_TYPE_DES3_CBC_MD5` - KERBEROS_ENCRYPTION_TYPE_DES3_CBC_MD5,\n * `KERBEROS_ENCRYPTION_TYPE_DES3_CBC_NONE` - KERBEROS_ENCRYPTION_TYPE_DES3_CBC_NONE,\n * `KERBEROS_ENCRYPTION_TYPE_DES3_CBC_SHA1` - KERBEROS_ENCRYPTION_TYPE_DES3_CBC_SHA1,\n * `KERBEROS_ENCRYPTION_TYPE_DES_CBC_CRC` - KERBEROS_ENCRYPTION_TYPE_DES_CBC_CRC,\n * `KERBEROS_ENCRYPTION_TYPE_DES_CBC_MD4` - KERBEROS_ENCRYPTION_TYPE_DES_CBC_MD4,\n * `KERBEROS_ENCRYPTION_TYPE_DES_CBC_MD5` - KERBEROS_ENCRYPTION_TYPE_DES_CBC_MD5,\n * `KERBEROS_ENCRYPTION_TYPE_DES_CBC_NONE` - KERBEROS_ENCRYPTION_TYPE_DES_CBC_NONE,\n * `KERBEROS_ENCRYPTION_TYPE_DES_CFB64_NONE` - KERBEROS_ENCRYPTION_TYPE_DES_CFB64_NONE,\n * `KERBEROS_ENCRYPTION_TYPE_DES_PCBC_NONE` - KERBEROS_ENCRYPTION_TYPE_DES_PCBC_NONE,\n * `KERBEROS_ENCRYPTION_TYPE_DIGEST_MD5_NONE` - KERBEROS_ENCRYPTION_TYPE_DIGEST_MD5_NONE,\n * `KERBEROS_ENCRYPTION_TYPE_ENCRYPT_RSA_PRIV` - KERBEROS_ENCRYPTION_TYPE_ENCRYPT_RSA_PRIV,\n * `KERBEROS_ENCRYPTION_TYPE_ENCRYPT_RSA_PUB` - KERBEROS_ENCRYPTION_TYPE_ENCRYPT_RSA_PUB,\n * `KERBEROS_ENCRYPTION_TYPE_ENCTYPE_PK_CROSS` - KERBEROS_ENCRYPTION_TYPE_ENCTYPE_PK_CROSS,\n * `KERBEROS_ENCRYPTION_TYPE_NULL` - KERBEROS_ENCRYPTION_TYPE_NULL,\n * `KERBEROS_ENCRYPTION_TYPE_OLD_DES3_CBC_SHA1` - KERBEROS_ENCRYPTION_TYPE_OLD_DES3_CBC_SHA1,\n * `KERBEROS_ENCRYPTION_TYPE_SIGN_DSA_GENERATE` - KERBEROS_ENCRYPTION_TYPE_SIGN_DSA_GENERATE"
          },
          "key": {
            "type": "array",
            "items": {
              "description": "key",
              "type": "number"
            }
          }
        }
      }
    }
  }
}

PUT

Set the Kerberos keytab from a generated keytab file. This API also accepts a kerberos keytab in the JSON form returned by the corresponding GET request.

Parameters

Name Description Required
If-Match ETag for expected version No

Request

Schema

{
  "type": "object"
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "kerberos_keytab",
  "type": "object",
  "properties": {
    "entries": {
      "type": "array",
      "items": {
        "description": "entries",
        "type": "object",
        "properties": {
          "principal": {
            "description": "principal",
            "type": "string"
          },
          "version": {
            "description": "version",
            "type": "number"
          },
          "enctype": {
            "type": "string",
            "enum": [
              "KERBEROS_ENCRYPTION_TYPE_NULL",
              "KERBEROS_ENCRYPTION_TYPE_DES_CBC_CRC",
              "KERBEROS_ENCRYPTION_TYPE_DES_CBC_MD4",
              "KERBEROS_ENCRYPTION_TYPE_DES_CBC_MD5",
              "KERBEROS_ENCRYPTION_TYPE_DES3_CBC_MD5",
              "KERBEROS_ENCRYPTION_TYPE_OLD_DES3_CBC_SHA1",
              "KERBEROS_ENCRYPTION_TYPE_SIGN_DSA_GENERATE",
              "KERBEROS_ENCRYPTION_TYPE_ENCRYPT_RSA_PRIV",
              "KERBEROS_ENCRYPTION_TYPE_ENCRYPT_RSA_PUB",
              "KERBEROS_ENCRYPTION_TYPE_DES3_CBC_SHA1",
              "KERBEROS_ENCRYPTION_TYPE_AES128_CTS_HMAC_SHA1_96",
              "KERBEROS_ENCRYPTION_TYPE_AES256_CTS_HMAC_SHA1_96",
              "KERBEROS_ENCRYPTION_TYPE_AES128_CTS_HMAC_SHA256_128",
              "KERBEROS_ENCRYPTION_TYPE_AES256_CTS_HMAC_SHA384_192",
              "KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_MD5",
              "KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_MD5_56",
              "KERBEROS_ENCRYPTION_TYPE_ENCTYPE_PK_CROSS",
              "KERBEROS_ENCRYPTION_TYPE_ARCFOUR_MD4",
              "KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_OLD",
              "KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_OLD_EXP",
              "KERBEROS_ENCRYPTION_TYPE_DES_CBC_NONE",
              "KERBEROS_ENCRYPTION_TYPE_DES3_CBC_NONE",
              "KERBEROS_ENCRYPTION_TYPE_DES_CFB64_NONE",
              "KERBEROS_ENCRYPTION_TYPE_DES_PCBC_NONE",
              "KERBEROS_ENCRYPTION_TYPE_DIGEST_MD5_NONE",
              "KERBEROS_ENCRYPTION_TYPE_CRAM_MD5_NONE"
            ],
            "description": "enctype:\n * `KERBEROS_ENCRYPTION_TYPE_AES128_CTS_HMAC_SHA1_96` - KERBEROS_ENCRYPTION_TYPE_AES128_CTS_HMAC_SHA1_96,\n * `KERBEROS_ENCRYPTION_TYPE_AES128_CTS_HMAC_SHA256_128` - KERBEROS_ENCRYPTION_TYPE_AES128_CTS_HMAC_SHA256_128,\n * `KERBEROS_ENCRYPTION_TYPE_AES256_CTS_HMAC_SHA1_96` - KERBEROS_ENCRYPTION_TYPE_AES256_CTS_HMAC_SHA1_96,\n * `KERBEROS_ENCRYPTION_TYPE_AES256_CTS_HMAC_SHA384_192` - KERBEROS_ENCRYPTION_TYPE_AES256_CTS_HMAC_SHA384_192,\n * `KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_MD5` - KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_MD5,\n * `KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_MD5_56` - KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_MD5_56,\n * `KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_OLD` - KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_OLD,\n * `KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_OLD_EXP` - KERBEROS_ENCRYPTION_TYPE_ARCFOUR_HMAC_OLD_EXP,\n * `KERBEROS_ENCRYPTION_TYPE_ARCFOUR_MD4` - KERBEROS_ENCRYPTION_TYPE_ARCFOUR_MD4,\n * `KERBEROS_ENCRYPTION_TYPE_CRAM_MD5_NONE` - KERBEROS_ENCRYPTION_TYPE_CRAM_MD5_NONE,\n * `KERBEROS_ENCRYPTION_TYPE_DES3_CBC_MD5` - KERBEROS_ENCRYPTION_TYPE_DES3_CBC_MD5,\n * `KERBEROS_ENCRYPTION_TYPE_DES3_CBC_NONE` - KERBEROS_ENCRYPTION_TYPE_DES3_CBC_NONE,\n * `KERBEROS_ENCRYPTION_TYPE_DES3_CBC_SHA1` - KERBEROS_ENCRYPTION_TYPE_DES3_CBC_SHA1,\n * `KERBEROS_ENCRYPTION_TYPE_DES_CBC_CRC` - KERBEROS_ENCRYPTION_TYPE_DES_CBC_CRC,\n * `KERBEROS_ENCRYPTION_TYPE_DES_CBC_MD4` - KERBEROS_ENCRYPTION_TYPE_DES_CBC_MD4,\n * `KERBEROS_ENCRYPTION_TYPE_DES_CBC_MD5` - KERBEROS_ENCRYPTION_TYPE_DES_CBC_MD5,\n * `KERBEROS_ENCRYPTION_TYPE_DES_CBC_NONE` - KERBEROS_ENCRYPTION_TYPE_DES_CBC_NONE,\n * `KERBEROS_ENCRYPTION_TYPE_DES_CFB64_NONE` - KERBEROS_ENCRYPTION_TYPE_DES_CFB64_NONE,\n * `KERBEROS_ENCRYPTION_TYPE_DES_PCBC_NONE` - KERBEROS_ENCRYPTION_TYPE_DES_PCBC_NONE,\n * `KERBEROS_ENCRYPTION_TYPE_DIGEST_MD5_NONE` - KERBEROS_ENCRYPTION_TYPE_DIGEST_MD5_NONE,\n * `KERBEROS_ENCRYPTION_TYPE_ENCRYPT_RSA_PRIV` - KERBEROS_ENCRYPTION_TYPE_ENCRYPT_RSA_PRIV,\n * `KERBEROS_ENCRYPTION_TYPE_ENCRYPT_RSA_PUB` - KERBEROS_ENCRYPTION_TYPE_ENCRYPT_RSA_PUB,\n * `KERBEROS_ENCRYPTION_TYPE_ENCTYPE_PK_CROSS` - KERBEROS_ENCRYPTION_TYPE_ENCTYPE_PK_CROSS,\n * `KERBEROS_ENCRYPTION_TYPE_NULL` - KERBEROS_ENCRYPTION_TYPE_NULL,\n * `KERBEROS_ENCRYPTION_TYPE_OLD_DES3_CBC_SHA1` - KERBEROS_ENCRYPTION_TYPE_OLD_DES3_CBC_SHA1,\n * `KERBEROS_ENCRYPTION_TYPE_SIGN_DSA_GENERATE` - KERBEROS_ENCRYPTION_TYPE_SIGN_DSA_GENERATE"
          },
          "key": {
            "type": "array",
            "items": {
              "description": "key",
              "type": "number"
            }
          }
        }
      }
    }
  }
}

DELETE

Delete the current Kerberos keytab configuration

Parameters

Name Description Required
If-Match ETag for expected version No

Response

Codes

Code Description
200 Return value on success