UserRole

Represents a user role in your organization.

Note

This object was called “Role” in previous versions of the API documentation.

Supported Calls

create(), update(), delete(), describeSObjects(), query(), search(), retrieve(), getDeleted(), getUpdated()

Special Access Rules

Customer Portal users cannot access this object.

Fields

Field	Field Type	Field Properties	Description
CaseAccessForAccountOwner	picklist	Filter Nillable Restricted picklist	The case access level for the account owner.
ContactAccessForAccountOwner	picklist	Filter Nillable Restricted picklist	The contact access level for the account owner. Note When DefaultContactAccess is set to “Controlled by Parent,” you cannot create or update this field.
ForecastUserId	reference	Filter Nillable	The ID of the forecast manager associated with this role. Label is User ID.
IsPartner	boolean	Defaulted on create Filter	Indicates whether the user role is a partner who has access to the PRM Portal (`true`) or not (`false`). This field is not available for release 9.0 and later. Instead, use PortalType with the value `Partner`.
MayForecastManagerShare	boolean	Filter	Indicates whether the forecast manager can manually share their own forecast.
Name	string	Filter idLookup	Required. Name of the role.
OpportunityAccessForAccountOwner	picklist	Filter Restricted picklist	Required. The opportunity access level for the account owner. Note that you cannot set a user role with an opportunity access less than that specified in organization-wide defaults.
ParentRoleId	reference	Filter Nillable	The ID of the parent role.
PortalRole	picklist	Filter Nillable	The portal role (either Executive, Manager, User, or PersonAccount).
PortalType	picklist	Defaulted on create Filter	This value indicates the type of portal for the role: None: Salesforce.com application role. CustomerPortal: Customer portal role. Partner: PRM Portal role. The field IsPartner used in release 8.0 will map to this value. This field replaces IsPartner beginning with release 9.0.
RollupDescription	string	Filter Nillable	Description of the forecast rollup. Label is Description.

Usage

Use this object to query() the set of currently configured user roles in your organization. Use it in your client application to obtain valid UserRole IDs to use when querying or modifying a User.

All users have access to invoke query() or describeSObjects() with this object. If your client application logs in with the “Modify All Data” permission, it can query(), create(), delete(), and update()UserRole records.