Roles

Description

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

Note: With the adoption of DAPI (Distributed API Management), we have re-branded "Roles" as "Portal Access Groups". We have updated our documentation to reflect this name change, however the resource names in the URI (V3 API) and method names (V2 API) have not been updated to reflect this change. For example, you will still use the URI path of "/roles" will be used in a V3 API call that is accessing Portal Access Group objects.

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.