• object SuccessfulUpdateOperation
  The response body for a successful update operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/AAAAuthTypesRead"
                    }
                }
            }
        }
    ]
}

• message: string
  The response message.

  Example: Updated record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful update operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Updated record"
        }
    },
    "type":"object"
}

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AAAAuthTypesRead"
            }
        }
    }
}

• Array of: object AAAAuthTypesRead
  Authentication type details.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AAAAuthTypesRead"
    }
}

• AuthenticationStatus: boolean
  Whether the authentication is enabled (1) or not (0).

  Example: 1
• AuthenticationStatusIcon: string
  The authentication status icon.

  Example: OrbGreen.png
• AuthenticationTypeID: integer
  The authentication type ID.

  Example: 1
• AuthenticationTypeName: string
  The authentication type name.

  Example: Internal
• PasswordMinimumLength: integer
  The minimum password length. This is used for internal authorization only.

  Example: 4
• PasswordRequiredLowercase: integer
  The minimum number of lowercase letters required in the password. This is used for internal authorization only.

  Example: 1
• PasswordRequiredNumbers: integer
  The minimum number of numerals required in the password. This is used for internal authorization only.

  Example: 0
• PasswordRequiredSpecialCharacters: integer
  The minimum number of special characters required in the password. This is used for internal authorization only.

  Example: 0
• PasswordRequiredUppercase: integer
  The minimum number of uppercase letters required in the password. This is used for internal authorization only.

  Example: 0
• PasswordResetAvailable: integer
  The number of password resets available. This is used for internal authorization only.

  Example: 0
• PasswordResetCustomText: string
  Custom text to show when resetting a password. This is used for internal authentication only.

  Example:
• PasswordResetQuestion1: string
  The question to ask a user when they reset their password. This is used for internal authentication only.

  Example:

{
    "properties":{
        "AuthenticationTypeID":{
            "description":"The authentication type ID.",
            "type":"integer",
            "example":"1"
        },
        "AuthenticationTypeName":{
            "description":"The authentication type name.",
            "type":"string",
            "example":"Internal"
        },
        "AuthenticationStatusIcon":{
            "description":"The authentication status icon.",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "AuthenticationStatus":{
            "description":"Whether the authentication is enabled (<b>1</b>) or not (<b>0</b>).",
            "type":"boolean",
            "example":"1"
        },
        "PasswordMinimumLength":{
            "description":"The minimum password length. This is used for internal authorization only.",
            "type":"integer",
            "example":"4"
        },
        "PasswordRequiredLowercase":{
            "description":"The minimum number of lowercase letters required in the password. This is used for internal authorization only.",
            "type":"integer",
            "example":"1"
        },
        "PasswordRequiredNumbers":{
            "description":"The minimum number of numerals required in the password. This is used for internal authorization only.",
            "type":"integer",
            "example":"0"
        },
        "PasswordRequiredSpecialCharacters":{
            "description":"The minimum number of special characters required in the password. This is used for internal authorization only.",
            "type":"integer",
            "example":"0"
        },
        "PasswordRequiredUppercase":{
            "description":"The minimum number of uppercase letters required in the password. This is used for internal authorization only.",
            "type":"integer",
            "example":"0"
        },
        "PasswordResetAvailable":{
            "description":"The number of password resets available. This is used for internal authorization only.",
            "type":"integer",
            "example":"0"
        },
        "PasswordResetCustomText":{
            "description":"Custom text to show when resetting a password. This is used for internal authentication only.",
            "type":"string",
            "example":""
        },
        "PasswordResetQuestion1":{
            "description":"The question to ask a user when they reset their password. This is used for internal authentication only.",
            "type":"string",
            "example":""
        }
    },
    "type":"object",
    "description":"Authentication type details."
}

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}