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:
Docs Navigation
- API Documentation Portal
- IO Docs Definition
- Mashery API Documentation
- Mashery 3.0 API Guide
- Mashery 2.0 API Guide
- OAuth Supporting Methods
- Examples
- API Sandbox
- JSON RPC
- Authentication
- API Objects
- Fetching Objects
- Query Language
- Creating Objects
- Updating Objects
- Validating Fields
- Deleting Objects
- Applications
- General Object Methods
- Members
- Packages
- Plans
- Package Keys
- Keys
- Developer Classes
- Services
- Roles
- Mashery 2.0 Reporting API Guide
- Event Trigger API
- Mashery Reporting Event Post API Guide
- Tips and Tricks
- Your Portal
- API Traffic Manager
- I/O Docs WSDL requirements