Resource URL: /platform/<<version=3>>/auth/providers/summary

    Overview: This resource returns summary information for authentication
              providers.

     Methods: GET

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

Method GET: Retrieve the summary information.

       URL: GET /platform/<<version=3>>/auth/providers/summary

Query arguments:
groupnet=<string> Filter providers by groupnet.
    zone=<string> Filter providers by zone.

GET response body schema:
{
  "type": [
    {
      "additionalProperties": false, 
      "type": "object", 
      "description": "A list of errors that may be returned.", 
      "properties": {
        "errors": {
          "items": {
            "additionalProperties": false, 
            "type": "object", 
            "description": "An object describing a single error.", 
            "properties": {
              "field": {
                "type": "string", 
                "description": "The field with the error if applicable."
              }, 
              "message": {
                "type": "string", 
                "description": "The error message."
              }, 
              "code": {
                "type": "string", 
                "description": "The error code."
              }
            }
          }, 
          "type": "array"
        }
      }
    }, 
    {
      "additionalProperties": false, 
      "type": "object", 
      "properties": {
        "provider_instances": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Specifies the summary information for an authentication provider.", 
            "properties": {
              "status": {
                "enum": [
                  "offline", 
                  "active", 
                  "online", 
                  "initializing", 
                  "joining", 
                  "disabled"
                ], 
                "type": "string", 
                "description": "Indicates the status of the provider."
              }, 
              "dc_site": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "The DC Site."
              }, 
              "client_site": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "The Nodes Site."
              }, 
              "name": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the name of the provider.", 
                "maxLength": 255
              }, 
              "connections": {
                "minItems": 0, 
                "items": {
                  "type": "object", 
                  "properties": {
                    "last_used": {
                      "minLength": 0, 
                      "type": "string", 
                      "description": "Specifies the last time the server was contacted.", 
                      "maxLength": 255
                    }, 
                    "server": {
                      "minLength": 0, 
                      "type": "string", 
                      "description": "Specifies the fully qualified domain name of the server.", 
                      "maxLength": 255
                    }, 
                    "address": {
                      "minLength": 0, 
                      "type": "string", 
                      "description": "Specifies the IP address of the provider.", 
                      "maxLength": 255
                    }
                  }
                }, 
                "type": "array", 
                "maxItems": 4294967295
              }, 
              "active_server": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "Specifies the server through which the provider serves authentication requests. Null if no server is set or is not applicable for that provider."
              }, 
              "forest": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "Specifies the Active Directory forest. Null if not applicable."
              }, 
              "groupnet": {
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ], 
                "description": "The groupnet the provider is in."
              }, 
              "type": {
                "enum": [
                  "file", 
                  "ldap", 
                  "local", 
                  "nis", 
                  "ads", 
                  "krb5", 
                  "unknown"
                ], 
                "type": "string", 
                "description": "Specifies the type of provider."
              }, 
              "id": {
                "minLength": 0, 
                "type": "string", 
                "description": "Specifies the ID of the provider.", 
                "maxLength": 255
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }
      }
    }
  ]
}
