REST API for Unified Assurance Core

Update a User

put

/api/AAA/Users/{id}

Updates the properties of the user that matches the specified ID.

Request

Path Parameters

id(required): integer(int32)
The user ID.
Example:
```
1
```

Supported Media Types

application/json

Root Schema : schema

Type: object

Details of the user to create or update.

Show Source

AccountExpiration: string

The date when the account's password will expire. Set to 0 for never, or a date/time string in a format parsable by the strtotimeM PHP function.

Example: [Never]
AccountStatus: string

A flag to indicate if the user account is enabled or disabled. Possible values are 0 for disabled or 1 for enabled.

Example: 1
AuthenticationType: integer

Unique identifier for the authentication type instance.

Example: 1
EmailAddress: string

The user email address.

Example: example@example.com
FullName: string

The full name of the user.

Example: Operator
Password: string

The user's password. Required for Internal authentication only.

Example:
PasswordChange: string
When the user's password will expire. Set either this or PasswordExpiration, not both.
Allowed values are:
- never: The password never expires.
- immediate: The password expires the next time the user logs in, and they must reset it immediately.
- YYYY-MM-DD: The date when the password expires.
Example: date
PasswordExpiration: string

The UNIX timestamp when the user's password will expire. Set either this or PasswordChange, not both. 0 means immediate, 2147483647 means never.

Example: 2147483647
Preferences: array Preferences

The user preferences.
Properties: array Properties

The user's properties.
RepeatPassword: string

The user's password, repeated. Required for Internal authentication only.

Example:
Subgroups: array Subgroups

A list of the user's subgroup IDs. Users inherit only restrictive access properties set for the subgroup, not roles or preferences. The same group cannot appear in both the UserGroup (primary) and Subgroups list for the user.
SupportPassword: string

The Unified Assurance support site password.

Example:
SupportUsername: string

The support user name.

Example:
UserGroup: integer

The unique identifier for the primary user group from which the user inherits configurations, including roles, properties, and preferences.

Example: 1
UserName: string

The username.
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

Example: operator

{
    "properties":{
        "UserName":{
            "description":"The username.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"operator"
        },
        "FullName":{
            "description":"The full name of the user.",
            "type":"string",
            "example":"Operator"
        },
        "EmailAddress":{
            "description":"The user email address.",
            "type":"string",
            "example":"example@example.com"
        },
        "AuthenticationType":{
            "description":"Unique identifier for the authentication type instance.",
            "type":"integer",
            "example":1
        },
        "Password":{
            "description":"The user's password. Required for Internal authentication only.",
            "type":"string",
            "example":""
        },
        "RepeatPassword":{
            "description":"The user's password, repeated. Required for Internal authentication only.",
            "type":"string",
            "example":""
        },
        "PasswordChange":{
            "description":"When the user's password will expire. Set either this or <b>PasswordExpiration</b>, not both.<br>\nAllowed values are: \n<ul><li><b>never</b>: The password never expires.</li>\n<li><b>immediate</b>: The password expires the next time the user logs in, and they must reset it immediately.</li>\n<li><i>YYYY-MM-DD</i>: The date when the password expires.</li></ul>",
            "type":"string",
            "example":"date"
        },
        "PasswordExpiration":{
            "description":"The UNIX timestamp when the user's password will expire. Set either this or <b>PasswordChange</b>, not both. <b>0</b> means immediate, <b>2147483647</b> means never.",
            "type":"string",
            "example":"2147483647"
        },
        "UserGroup":{
            "description":"The unique identifier for the primary user group from which the user inherits configurations, including roles, properties, and preferences.",
            "type":"integer",
            "example":1
        },
        "Subgroups":{
            "description":"A list of the user's subgroup IDs. Users inherit only restrictive access properties set for the subgroup, not roles or preferences. The same group cannot appear in both the UserGroup (primary) and Subgroups list for the user.",
            "type":"array",
            "example":"[2, 1001]"
        },
        "AccountExpiration":{
            "description":"The date when the account's password will expire. Set to <b>0</b> for never, or a date/time string in a format parsable by the <b>strtotimeM</b> PHP function.",
            "type":"string",
            "example":"[Never]"
        },
        "AccountStatus":{
            "description":"A flag to indicate if the user account is enabled or disabled. Possible values are <b>0</b> for disabled or <b>1</b> for enabled.",
            "type":"string",
            "example":"1"
        },
        "SupportUsername":{
            "description":"The support user name.",
            "type":"string",
            "example":""
        },
        "SupportPassword":{
            "description":"The Unified Assurance support site password.",
            "type":"string",
            "example":""
        },
        "Properties":{
            "description":"The user's properties.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PropertyID":{
                        "description":"The property ID.",
                        "type":"integer",
                        "example":"1"
                    },
                    "PropertyName":{
                        "description":"The property name.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
                        "type":"string",
                        "example":"ResetQuestion"
                    },
                    "PropertyValue":{
                        "description":"The property value.",
                        "type":"string",
                        "example":"resetval"
                    },
                    "Description":{
                        "description":"The description of the property.",
                        "type":"string",
                        "example":"Reserved for future use"
                    },
                    "id":{
                        "type":"integer",
                        "example":2
                    }
                }
            }
        },
        "Preferences":{
            "description":"The user preferences.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PreferenceID":{
                        "description":"The preference ID.",
                        "type":"integer",
                        "example":"3"
                    },
                    "PreferenceName":{
                        "description":"The preference name.",
                        "type":"string",
                        "example":"DefaultDisplayID"
                    },
                    "PreferenceValue":{
                        "description":"The preference value.",
                        "type":"integer",
                        "example":5
                    },
                    "Description":{
                        "description":"The preference description.",
                        "type":"string",
                        "example":"Default event list display (default 'Default')"
                    },
                    "Override":{
                        "description":"Whether the preference is unlocked (<b>0</b>), allowing the user to override their group preference, or locked (<b>1</b>), preventing the user from overriding it.",
                        "type":"integer",
                        "example":0
                    },
                    "id":{
                        "type":"integer",
                        "example":1
                    }
                }
            }
        }
    },
    "description":"Details of the user to create or update."
}

Nested Schema : Preferences

Type: array

The user preferences.

Show Source

Array of: object items

{
    "description":"The user preferences.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PreferenceID":{
                "description":"The preference ID.",
                "type":"integer",
                "example":"3"
            },
            "PreferenceName":{
                "description":"The preference name.",
                "type":"string",
                "example":"DefaultDisplayID"
            },
            "PreferenceValue":{
                "description":"The preference value.",
                "type":"integer",
                "example":5
            },
            "Description":{
                "description":"The preference description.",
                "type":"string",
                "example":"Default event list display (default 'Default')"
            },
            "Override":{
                "description":"Whether the preference is unlocked (<b>0</b>), allowing the user to override their group preference, or locked (<b>1</b>), preventing the user from overriding it.",
                "type":"integer",
                "example":0
            },
            "id":{
                "type":"integer",
                "example":1
            }
        }
    }
}

Nested Schema : Properties

Type: array

The user's properties.

Show Source

Array of: object items

{
    "description":"The user's properties.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PropertyID":{
                "description":"The property ID.",
                "type":"integer",
                "example":"1"
            },
            "PropertyName":{
                "description":"The property name.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
                "type":"string",
                "example":"ResetQuestion"
            },
            "PropertyValue":{
                "description":"The property value.",
                "type":"string",
                "example":"resetval"
            },
            "Description":{
                "description":"The description of the property.",
                "type":"string",
                "example":"Reserved for future use"
            },
            "id":{
                "type":"integer",
                "example":2
            }
        }
    }
}

Nested Schema : Subgroups

Type: array

A list of the user's subgroup IDs. Users inherit only restrictive access properties set for the subgroup, not roles or preferences. The same group cannot appear in both the UserGroup (primary) and Subgroups list for the user.

Example:

[2, 1001]

Nested Schema : items

Type: object

Show Source

Description: string

The preference description.

Example: Default event list display (default 'Default')
id: integer

Example: 1
Override: integer

Whether the preference is unlocked (0), allowing the user to override their group preference, or locked (1), preventing the user from overriding it.

Example: 0
PreferenceID: integer

The preference ID.

Example: 3
PreferenceName: string

The preference name.

Example: DefaultDisplayID
PreferenceValue: integer

The preference value.

Example: 5

{
    "type":"object",
    "properties":{
        "PreferenceID":{
            "description":"The preference ID.",
            "type":"integer",
            "example":"3"
        },
        "PreferenceName":{
            "description":"The preference name.",
            "type":"string",
            "example":"DefaultDisplayID"
        },
        "PreferenceValue":{
            "description":"The preference value.",
            "type":"integer",
            "example":5
        },
        "Description":{
            "description":"The preference description.",
            "type":"string",
            "example":"Default event list display (default 'Default')"
        },
        "Override":{
            "description":"Whether the preference is unlocked (<b>0</b>), allowing the user to override their group preference, or locked (<b>1</b>), preventing the user from overriding it.",
            "type":"integer",
            "example":0
        },
        "id":{
            "type":"integer",
            "example":1
        }
    }
}

Nested Schema : items

Type: object

Show Source

Description: string

The description of the property.

Example: Reserved for future use
id: integer

Example: 2
PropertyID: integer

The property ID.

Example: 1
PropertyName: string

The property name.
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.

Example: ResetQuestion
PropertyValue: string

The property value.

Example: resetval

{
    "type":"object",
    "properties":{
        "PropertyID":{
            "description":"The property ID.",
            "type":"integer",
            "example":"1"
        },
        "PropertyName":{
            "description":"The property name.\n<br>To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"ResetQuestion"
        },
        "PropertyValue":{
            "description":"The property value.",
            "type":"string",
            "example":"resetval"
        },
        "Description":{
            "description":"The description of the property.",
            "type":"string",
            "example":"Reserved for future use"
        },
        "id":{
            "type":"integer",
            "example":2
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

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/AAAUsersRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

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

Nested Schema : type

Type: object

Show Source

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/AAAUsersRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object AAAUsersRead

User details.

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

Nested Schema : AAAUsersRead

Type: object

User details.

Show Source

AccountExpiration: string

The date when the account's password will expire. 0 means it never expires.

Example: [Never]
AccountStatus: integer

A flag to indicate if the user account is enabled (1) or disabled (0).

Example: 1
AuthenticationType: object AuthenticationType

The authentication type instance for the user..
AuthenticationTypeName: string

The authentication type instance name.

Example: Internal
EmailAddress: string

The user email address.

Example: example@example.com
FailedLoginCount: integer

The number of failed logins.

Example: 0
FullName: string

The full name of the user.

Example: Operator
LastLoginFailed: integer

The last failed login attempt.

Example: 0
LastLoginSuccess: integer

The last successful login attempt.

Example: 0
Password: string

The user's password. Required for Internal authentication only.

Example:
PasswordExpiration: string

The UNIX timestamp when the password will expire. 0 means it has expired.

Example: 2147483647
Preferences: array Preferences

The user preferences.
Properties: array Properties

The user's properties.
RepeatPassword: string

The user's password, repeated. Required for Internal authentication only.

Example:
Subgroups: array Subgroups

A list of the user's subgroup IDs. Users inherit only restrictive access properties set for the subgroup, not roles or preferences.
SupportUsername: string

The support user name.

Example:
UserGroup: object UserGroup

The user group.
UserGroupName: string

The user group name.

Example: Administrators
UserID: integer

The user ID.

Example: 1065
UserName: string

The user name.

Example: operator

{
    "properties":{
        "UserID":{
            "description":"The user ID.",
            "type":"integer",
            "example":"1065"
        },
        "UserName":{
            "description":"The user name.",
            "type":"string",
            "example":"operator"
        },
        "FullName":{
            "description":"The full name of the user.",
            "type":"string",
            "example":"Operator"
        },
        "EmailAddress":{
            "description":"The user email address.",
            "type":"string",
            "example":"example@example.com"
        },
        "LastLoginSuccess":{
            "description":"The last successful login attempt.",
            "type":"integer",
            "example":"0"
        },
        "LastLoginFailed":{
            "description":"The last failed login attempt.",
            "type":"integer",
            "example":"0"
        },
        "PasswordExpiration":{
            "description":"The UNIX timestamp when the password will expire. <b>0</b> means it has expired.",
            "type":"string",
            "example":"2147483647"
        },
        "AccountExpiration":{
            "description":"The date when the account's password will expire. <b>0</b> means it never expires.",
            "type":"string",
            "example":"[Never]"
        },
        "FailedLoginCount":{
            "description":"The number of failed logins.",
            "type":"integer",
            "example":"0"
        },
        "AuthenticationType":{
            "description":"The authentication type instance for the user..",
            "type":"object",
            "properties":{
                "id":{
                    "description":"The unique identifier for the authentication type instance.",
                    "type":"integer"
                },
                "name":{
                    "description":"The name for the authentication type instance.",
                    "type":"string"
                }
            },
            "example":{
                "id":"1",
                "name":"Internal"
            }
        },
        "AccountStatus":{
            "description":"A flag to indicate if the user account is enabled (<b>1</b>) or disabled (<b>0</b>).",
            "type":"integer",
            "example":"1"
        },
        "SupportUsername":{
            "description":"The support user name.",
            "type":"string",
            "example":""
        },
        "UserGroupName":{
            "description":"The user group name.",
            "type":"string",
            "example":"Administrators"
        },
        "AuthenticationTypeName":{
            "description":"The authentication type instance name.",
            "type":"string",
            "example":"Internal"
        },
        "UserGroup":{
            "description":"The user group.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"The unique identifier for the primary user group from which the user inherits configurations which includes roles, properties, and preferences.",
                    "type":"integer"
                },
                "name":{
                    "description":"The user group name.",
                    "type":"string"
                }
            },
            "example":{
                "id":"1",
                "name":"Administrators"
            }
        },
        "Subgroups":{
            "description":"A list of the user's subgroup IDs. Users inherit only restrictive access properties set for the subgroup, not roles or preferences.",
            "type":"array",
            "example":"[2, 1001]"
        },
        "Password":{
            "description":"The user's password. Required for Internal authentication only.",
            "type":"string",
            "example":""
        },
        "RepeatPassword":{
            "description":"The user's password, repeated. Required for Internal authentication only.",
            "type":"string",
            "example":""
        },
        "Properties":{
            "description":"The user's properties.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PropertyID":{
                        "description":"The property ID.",
                        "type":"integer",
                        "example":"1"
                    },
                    "PropertyName":{
                        "description":"The property name.",
                        "type":"string",
                        "example":"ResetQuestion"
                    },
                    "PropertyValue":{
                        "description":"The property value.",
                        "type":"string",
                        "example":"resetval"
                    },
                    "Description":{
                        "description":"The description associated with the property.",
                        "type":"string",
                        "example":"Reserved for future use"
                    }
                }
            }
        },
        "Preferences":{
            "description":"The user preferences.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "PreferenceID":{
                        "description":"The preference ID.",
                        "type":"integer",
                        "example":"3"
                    },
                    "PreferenceName":{
                        "description":"The preference name.",
                        "type":"string",
                        "example":"DefaultDisplayID"
                    },
                    "PreferenceValue":{
                        "description":"The preference value.",
                        "type":"string",
                        "example":"5"
                    },
                    "Description":{
                        "description":"The preference description.",
                        "type":"string",
                        "example":"Default event list display (default 'Default')"
                    },
                    "Override":{
                        "description":"Whether the preference is unlocked (<b>0</b>), allowing the user to override their group preference, or locked (<b>1</b>), preventing the user from overriding it.",
                        "type":"integer",
                        "example":0
                    }
                }
            }
        }
    },
    "description":"User details."
}

Nested Schema : AuthenticationType

Type: object

The authentication type instance for the user..

Show Source

id: integer

The unique identifier for the authentication type instance.
name: string

The name for the authentication type instance.

{
    "description":"The authentication type instance for the user..",
    "type":"object",
    "properties":{
        "id":{
            "description":"The unique identifier for the authentication type instance.",
            "type":"integer"
        },
        "name":{
            "description":"The name for the authentication type instance.",
            "type":"string"
        }
    },
    "example":{
        "id":"1",
        "name":"Internal"
    }
}

Example:

{
    "id":"1",
    "name":"Internal"
}

Nested Schema : Preferences

Type: array

The user preferences.

Show Source

Array of: object items

{
    "description":"The user preferences.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PreferenceID":{
                "description":"The preference ID.",
                "type":"integer",
                "example":"3"
            },
            "PreferenceName":{
                "description":"The preference name.",
                "type":"string",
                "example":"DefaultDisplayID"
            },
            "PreferenceValue":{
                "description":"The preference value.",
                "type":"string",
                "example":"5"
            },
            "Description":{
                "description":"The preference description.",
                "type":"string",
                "example":"Default event list display (default 'Default')"
            },
            "Override":{
                "description":"Whether the preference is unlocked (<b>0</b>), allowing the user to override their group preference, or locked (<b>1</b>), preventing the user from overriding it.",
                "type":"integer",
                "example":0
            }
        }
    }
}

Nested Schema : Properties

Type: array

The user's properties.

Show Source

Array of: object items

{
    "description":"The user's properties.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "PropertyID":{
                "description":"The property ID.",
                "type":"integer",
                "example":"1"
            },
            "PropertyName":{
                "description":"The property name.",
                "type":"string",
                "example":"ResetQuestion"
            },
            "PropertyValue":{
                "description":"The property value.",
                "type":"string",
                "example":"resetval"
            },
            "Description":{
                "description":"The description associated with the property.",
                "type":"string",
                "example":"Reserved for future use"
            }
        }
    }
}

Nested Schema : Subgroups

Type: array

A list of the user's subgroup IDs. Users inherit only restrictive access properties set for the subgroup, not roles or preferences.

Example:

[2, 1001]

Nested Schema : UserGroup

Type: object

The user group.

Show Source

id: integer

The unique identifier for the primary user group from which the user inherits configurations which includes roles, properties, and preferences.
name: string

The user group name.

{
    "description":"The user group.",
    "type":"object",
    "properties":{
        "id":{
            "description":"The unique identifier for the primary user group from which the user inherits configurations which includes roles, properties, and preferences.",
            "type":"integer"
        },
        "name":{
            "description":"The user group name.",
            "type":"string"
        }
    },
    "example":{
        "id":"1",
        "name":"Administrators"
    }
}

Example:

{
    "id":"1",
    "name":"Administrators"
}

Nested Schema : items

Type: object

Show Source

Description: string

The preference description.

Example: Default event list display (default 'Default')
Override: integer

Whether the preference is unlocked (0), allowing the user to override their group preference, or locked (1), preventing the user from overriding it.

Example: 0
PreferenceID: integer

The preference ID.

Example: 3
PreferenceName: string

The preference name.

Example: DefaultDisplayID
PreferenceValue: string

The preference value.

Example: 5

{
    "type":"object",
    "properties":{
        "PreferenceID":{
            "description":"The preference ID.",
            "type":"integer",
            "example":"3"
        },
        "PreferenceName":{
            "description":"The preference name.",
            "type":"string",
            "example":"DefaultDisplayID"
        },
        "PreferenceValue":{
            "description":"The preference value.",
            "type":"string",
            "example":"5"
        },
        "Description":{
            "description":"The preference description.",
            "type":"string",
            "example":"Default event list display (default 'Default')"
        },
        "Override":{
            "description":"Whether the preference is unlocked (<b>0</b>), allowing the user to override their group preference, or locked (<b>1</b>), preventing the user from overriding it.",
            "type":"integer",
            "example":0
        }
    }
}

Nested Schema : items

Type: object

Show Source

Description: string

The description associated with the property.

Example: Reserved for future use
PropertyID: integer

The property ID.

Example: 1
PropertyName: string

The property name.

Example: ResetQuestion
PropertyValue: string

The property value.

Example: resetval

{
    "type":"object",
    "properties":{
        "PropertyID":{
            "description":"The property ID.",
            "type":"integer",
            "example":"1"
        },
        "PropertyName":{
            "description":"The property name.",
            "type":"string",
            "example":"ResetQuestion"
        },
        "PropertyValue":{
            "description":"The property value.",
            "type":"string",
            "example":"resetval"
        },
        "Description":{
            "description":"The description associated with the property.",
            "type":"string",
            "example":"Reserved for future use"
        }
    }
}

Default Response

Failed operation

Root Schema : schema

Type: object

Show Source

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

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

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

Nested Schema : items

Type: object

An error.