Roles

Description

A Role groups members and controls access to portal features and content

Object Fields

id

The id field is the primary identifier for a role object.

type maxLength format default optional readonly createonly queryable sortable
integer       yes yes no yes no

created

The date that this object was created.

type maxLength format default optional readonly createonly queryable sortable
string  20 date-time   yes yes no yes no

updated

The date this object was last updated.

type maxLength format default optional readonly createonly queryable sortable
string  20 date-time   yes yes no yes no

name

The name of this object.  The name must be unique.  Some names are reserved for Mashery defined roles.

type maxLength format default optional readonly createonly queryable sortable
string 127     no no no yes yes

description

A description of the role.

type maxLength format default optional readonly createonly queryable sortable
string       yes no no yes no

is_assignable

True if a member can be assigned to this role.

type maxLength format default optional readonly createonly queryable sortable
boolean       yes yes no no no

is_predefined

True if this role is pre-defined from Mashery.

type maxLength format default optional readonly createonly queryable sortable
boolean       yes yes no no no

object_type

The type of the object.  This is always "role" for a role.

type maxLength format default optional readonly createonly queryable sortable
string 32    "role" yes yes no no no

Relationships

members

A role may have many mambers.  There is currently no members property representing this relationship from the role side of the association.  Access roles from the member object using REQUIRE RELATED role query terms.

Object Methods

The role namespace contains the following methods for manipulating roles:

role.fetch
Returns a role object based on a specified id.
role.create
Create a new role object.
role.update
Modifies an existing role object.
role.validate
Validates fields on a role object.
role.delete
Deletes a role object.

Docs Navigation