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

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

     Methods: GET, POST

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

Method GET: List all roles.

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

Query arguments:
          sort=<string> The field that will be used for sorting.
resolve_names=<boolean> Filter users by zone.
        limit=<integer> Return no more than this many results at once (see
                        resume).
             dir=<enum> Where <enum> is one of ASC, DESC.  The direction of the
                        sort.
        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).

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": {
        "total": {
          "minimum": 0, 
          "type": "integer", 
          "description": "Total number of items available.", 
          "maximum": 4294967295
        }, 
        "roles": {
          "minItems": 0, 
          "items": {
            "type": "object", 
            "description": "Specifies the role maps privileges to users and groups.", 
            "properties": {
              "name": {
                "minLength": 0, 
                "required": true, 
                "type": "string", 
                "description": "Specifies the name of the role.", 
                "maxLength": 255
              }, 
              "privileges": {
                "description": "Specifies the privileges granted by this role.", 
                "minItems": 0, 
                "items": {
                  "type": "object", 
                  "description": "Specifies the system-defined privilege that may be granted to users.", 
                  "properties": {
                    "read_only": {
                      "type": "boolean", 
                      "description": "True, if the privilege is read-only."
                    }, 
                    "id": {
                      "minLength": 0, 
                      "required": true, 
                      "type": "string", 
                      "description": "Specifies the ID of the privilege.", 
                      "maxLength": 255
                    }, 
                    "name": {
                      "minLength": 0, 
                      "type": "string", 
                      "description": "Specifies the name of the privilege.", 
                      "maxLength": 255
                    }
                  }
                }, 
                "required": true, 
                "maxItems": 4294967295, 
                "type": "array"
              }, 
              "description": {
                "required": true, 
                "type": [
                  {
                    "minLength": 0, 
                    "type": "string", 
                    "description": "Specifies the description of the role.", 
                    "maxLength": 255
                  }, 
                  {
                    "type": "null"
                  }
                ]
              }, 
              "members": {
                "description": "Specifies the users or groups that have this role.", 
                "minItems": 0, 
                "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": {
                      "minLength": 0, 
                      "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'.", 
                      "maxLength": 261
                    }, 
                    "name": {
                      "minLength": 0, 
                      "type": "string", 
                      "description": "Specifies the persona name, which must be combined with a type.", 
                      "maxLength": 255
                    }
                  }
                }, 
                "required": true, 
                "maxItems": 4294967295, 
                "type": "array"
              }, 
              "id": {
                "minLength": 0, 
                "required": true, 
                "type": "string", 
                "description": "Specifies the ID of the role.", 
                "maxLength": 255
              }
            }
          }, 
          "type": "array", 
          "maxItems": 4294967295
        }, 
        "resume": {
          "minLength": 0, 
          "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 role.

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

There are no query arguments for this method.

Required POST request body fields:
name

POST request body schema:
{
  "type": "object", 
  "description": "Specifies the role maps privileges to users and groups.", 
  "properties": {
    "privileges": {
      "minItems": 0, 
      "items": {
        "type": "object", 
        "description": "Specifies the system-defined privilege that may be granted to users.", 
        "properties": {
          "read_only": {
            "type": "boolean", 
            "description": "True, if the privilege is read-only."
          }, 
          "id": {
            "minLength": 0, 
            "required": true, 
            "type": "string", 
            "description": "Specifies the ID of the privilege.", 
            "maxLength": 255
          }, 
          "name": {
            "minLength": 0, 
            "type": "string", 
            "description": "Specifies the name of the privilege.", 
            "maxLength": 255
          }
        }
      }, 
      "type": "array", 
      "description": "Specifies the privileges granted by this role.", 
      "maxItems": 4294967295
    }, 
    "description": {
      "minLength": 0, 
      "type": "string", 
      "description": "Specifies the description of the role.", 
      "maxLength": 255
    }, 
    "members": {
      "minItems": 0, 
      "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": {
            "minLength": 0, 
            "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'.", 
            "maxLength": 261
          }, 
          "name": {
            "minLength": 0, 
            "type": "string", 
            "description": "Specifies the persona name, which must be combined with a type.", 
            "maxLength": 255
          }
        }
      }, 
      "type": "array", 
      "description": "Specifies the users or groups that have this role.", 
      "maxItems": 4294967295
    }, 
    "name": {
      "minLength": 0, 
      "required": true, 
      "type": "string", 
      "description": "Specifies the name of the role.", 
      "maxLength": 255
    }
  }
}

POST 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"
        }
      }
    }, 
    {
      "type": "object", 
      "properties": {
        "id": {
          "minLength": 0, 
          "required": true, 
          "type": "string", 
          "description": "ID of created item that can be used to refer to item in the collection-item resource path.", 
          "maxLength": 255
        }
      }
    }
  ]
}
