Resource URL: /platform/<<version=1>>/auth/groups

    Overview: This resource applies the standard collection pattern to groups.

     Methods: GET, POST, DELETE

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

Method GET: List all groups.

       URL: GET /platform/<<version=1>>/auth/groups

Query arguments:
          domain=<string> Filter groups by domain.
            zone=<string> Filter groups by zone.
          resume=<string> Continue returning results from previous call using
                          this token (token should come from the previous call,
                          resume cannot be used with other options).
         cached=<boolean> If true, only return cached objects.
  resolve_names=<boolean> Resolve names of personas.
          filter=<string> Filter groups by name prefix.
query_member_of=<boolean> Enumerate all groups that a group is a member of.
        provider=<string> Filter groups by provider.
          limit=<integer> Return no more than this many results at once (see
                          resume).

GET response body schema:
{
  "type": "object", 
  "properties": {
    "groups": {
      "items": {
        "type": "object", 
        "description": "Specifies configuration properties for a group.", 
        "properties": {
          "dn": {
            "required": true, 
            "type": [
              "string", 
              "null"
            ], 
            "description": "Specifies the distinguished name for the user."
          }, 
          "domain": {
            "required": true, 
            "type": [
              "string", 
              "null"
            ], 
            "description": "Specifies the domain that the object is part of."
          }, 
          "generated_gid": {
            "required": true, 
            "type": [
              "boolean", 
              "null"
            ], 
            "description": "If true, the GID was generated."
          }, 
          "name": {
            "required": true, 
            "type": "string", 
            "description": "Specifies a user or group name."
          }, 
          "member_of": {
            "required": true, 
            "type": [
              {
                "type": "null"
              }, 
              {
                "items": {
                  "type": "object", 
                  "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                  "properties": {
                    "type": {
                      "enum": [
                        "user", 
                        "group", 
                        "wellknown"
                      ], 
                      "type": "string", 
                      "description": "Specifies the type of persona, which must be combined with a name."
                    }, 
                    "id": {
                      "type": "string", 
                      "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                    }, 
                    "name": {
                      "type": "string", 
                      "description": "Specifies the persona name, which must be combined with a type."
                    }
                  }
                }, 
                "type": "array"
              }
            ], 
            "description": "Specifies the groups that this user or group are members of."
          }, 
          "sid": {
            "required": true, 
            "type": [
              {
                "type": "object", 
                "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                "properties": {
                  "type": {
                    "enum": [
                      "user", 
                      "group", 
                      "wellknown"
                    ], 
                    "type": "string", 
                    "description": "Specifies the type of persona, which must be combined with a name."
                  }, 
                  "id": {
                    "type": "string", 
                    "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                  }, 
                  "name": {
                    "type": "string", 
                    "description": "Specifies the persona name, which must be combined with a type."
                  }
                }
              }
            ], 
            "description": "Specifies the security identifier."
          }, 
          "dns_domain": {
            "required": true, 
            "type": [
              "string", 
              "null"
            ], 
            "description": "Specifies the DNS domain."
          }, 
          "sam_account_name": {
            "required": true, 
            "type": [
              "string", 
              "null"
            ], 
            "description": "Specifies a user or group name."
          }, 
          "gid": {
            "required": true, 
            "type": [
              {
                "type": "object", 
                "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
                "properties": {
                  "type": {
                    "enum": [
                      "user", 
                      "group", 
                      "wellknown"
                    ], 
                    "type": "string", 
                    "description": "Specifies the type of persona, which must be combined with a name."
                  }, 
                  "id": {
                    "type": "string", 
                    "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
                  }, 
                  "name": {
                    "type": "string", 
                    "description": "Specifies the persona name, which must be combined with a type."
                  }
                }
              }, 
              {
                "type": "null"
              }
            ], 
            "description": "Specifies the numeric group identifier."
          }, 
          "provider": {
            "required": true, 
            "type": [
              "string", 
              "null"
            ], 
            "description": "Specifies the authentication provider that the object belongs to."
          }, 
          "type": {
            "required": true, 
            "type": "string", 
            "description": "Specifies the object type."
          }, 
          "id": {
            "required": true, 
            "type": "string", 
            "description": "Specifies the user or group ID."
          }
        }
      }, 
      "type": "array"
    }, 
    "resume": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
    }
  }
}

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

Method POST: Create a new group.

        URL: POST /platform/<<version=1>>/auth/groups

Query arguments:
    zone=<string> Optional zone.
provider=<string> Optional provider type.

Required POST request body fields:
name

POST request body schema:
{
  "type": "object", 
  "description": "Specifies the configuration properties for a group.", 
  "properties": {
    "gid": {
      "type": "integer", 
      "description": "Specifies the numeric group identifier."
    }, 
    "name": {
      "required": true, 
      "type": "string", 
      "description": "Specifies the group name."
    }, 
    "members": {
      "items": {
        "type": "object", 
        "description": "Specifies properties for a persona, which consists of either a 'type' and a 'name' or an 'ID'.", 
        "properties": {
          "type": {
            "enum": [
              "user", 
              "group", 
              "wellknown"
            ], 
            "type": "string", 
            "description": "Specifies the type of persona, which must be combined with a name."
          }, 
          "id": {
            "type": "string", 
            "description": "Specifies the serialized form of a persona, which can be 'UID:0', 'USER:name', 'GID:0', 'GROUP:wheel', or 'SID:S-1-1'."
          }, 
          "name": {
            "type": "string", 
            "description": "Specifies the persona name, which must be combined with a type."
          }
        }
      }, 
      "type": "array", 
      "description": "Specifies the members of the group."
    }, 
    "sid": {
      "type": "string", 
      "description": "Specifies the security identifier."
    }
  }
}

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."
    }
  }
}

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

Method DELETE: Flush the groups cache.

          URL: DELETE /platform/<<version=1>>/auth/groups

Query arguments:
 cached=<boolean> If true, only flush cached objects.
    zone=<string> Filter groups by zone.
provider=<string> Filter groups by provider.

There is no response body for this method.
