key.validate

Description

Validate field values from a key object.  Please see Validating Fields for an overview of how the validate method works.

Note that there are validations that are performed upon update or create that cannot be performed from the validate method.  Thus, even if validate returns TRUE, a create or update operation with the same values may still return an invalid object response.

Parameters

key

A partial key object, as described by the object.describe call.  If a field in the key object is ommitted, no validation will be peformed for that field.  If extra fields are passed, they will be ignored.

Response

TRUE is returned if all fields are valid, otherwise, an invalid object error object is returned.

Examples

A Sample JSON-RPC Key Validate Request

{
    "method": "key.validate",
    "params": [
        {
            "status": "active"
        }
    ],
    "id": 1
}

The JSON-RPC Response

{
    "result": true,
    "error": null,
    "id": 1
}

Permissions Required

The user who owns the key used to authenticate the key.validate call must be a member of one of the following roles

• Administrator
• Program Manager
• Community Manager

See authentication.

Errors

In addition to the standard json-rpc errors and authentication errors, key.validate may also return these errors: