role.create

Description

Create a single role object.  Please see Creating Objects for an overview of how the create method works.

Parameters

role

An role object, as described by the object.describe call.  If a field in the role object is ommitted, a default value will be used if possible.  If extra fields are passed, they will be ignored.

Response

An role object, as described by the object.describe call.  This is actual role that was created.

Examples

A Sample JSON-RPC Role Create Request

{
    "method": "role.create",
    "params": [{"name":"example_role_name"}],
    "id": 1
}

The JSON-RPC Response

{
    "result": {
        "id": 378,
        "created": "2009-12-02T23:46:49Z",
        "updated": "2009-12-02T23:46:49Z",
        "name": "example_role_name",
        "description": "",
        "is_assignable": true,
        "is_predefined": false,
        "object_type": "role"
    },
    "error": null,
    "id": 1
}

Permissions Required

The user who owns the role used to authenticate the role.create 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, role.create may also return these errors: