Resource URL: /platform/<<version=1>>/auth/settings/krb5/realms

    Overview: This resource contains krb5 authentication settings.

     Methods: GET, POST

********************************************************************************

Method GET: Retrieve the krb5 settings for realms.

       URL: GET /platform/<<version=1>>/auth/settings/krb5/realms

There are no query arguments for this method.

GET response body schema:
{
  "type": "object", 
  "properties": {
    "realm": {
      "items": {
        "type": "object", 
        "description": "Specifies the Kerberos settings for realm access.", 
        "properties": {
          "is_default_realm": {
            "type": [
              {
                "type": "boolean", 
                "description": "If true, indicates that the realm is the default."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "realm": {
            "type": [
              {
                "type": "string", 
                "description": "Specifies the name of the realm."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "admin_server": {
            "type": [
              {
                "type": "string", 
                "description": "Specifies the administrative server hostname."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "kdc": {
            "type": [
              {
                "items": {
                  "type": "string"
                }, 
                "type": "array", 
                "description": "Specifies the list of KDC hostnames."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "default_domain": {
            "type": [
              {
                "type": "string", 
                "description": "Specifies the default domain mapped to the realm."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "is_joined": {
            "type": [
              {
                "type": "boolean", 
                "description": "If true, indicates that the realm is joined."
              }, 
              {
                "type": "null"
              }
            ]
          }, 
          "id": {
            "type": [
              {
                "type": "string", 
                "description": "ID of realm"
              }, 
              {
                "type": "null"
              }
            ]
          }
        }
      }, 
      "type": "array"
    }
  }
}

********************************************************************************

Method POST: Create a new krb5 realm.

        URL: POST /platform/<<version=1>>/auth/settings/krb5/realms

There are no query arguments for this method.

Required POST request body fields:
realm

POST request body schema:
{
  "type": "object", 
  "description": "Specifies the Kerberos settings for realm access.", 
  "properties": {
    "default_domain": {
      "type": "string", 
      "description": "Specifies the default domain mapped to the realm."
    }, 
    "is_default_realm": {
      "type": "boolean", 
      "description": "If true, indicates that the realm is the default."
    }, 
    "realm": {
      "required": true, 
      "type": "string", 
      "description": "Specifies the name of the realm."
    }, 
    "admin_server": {
      "type": "string", 
      "description": "Specifies the administrative server hostname."
    }, 
    "kdc": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "Specifies the list of KDC hostnames."
    }
  }
}

POST response body schema:
{
  "type": "object", 
  "properties": {
    "id": {
      "required": true, 
      "type": "string", 
      "description": "ID of created item that can be used to refer to item in the collection-item resource path."
    }
  }
}
