UserRole

Represents a user role in your organization.

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

  • As of Summer ’20 and later, only users with the View Roles and Role Hierarchy permission can access this object, and only users with the Manage Roles permission can edit this object.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The case access level for the account owner.

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Introduced: API version 10.0

  • Description: The contact access level for the account owner.

    When DefaultContactAccess is set to Controlled by Parent, you can’t create or update this field.

  • Type: string

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 24.0

  • Description:

    The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Corresponds to Role Name in the user interface.

    When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record.

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 6.0
  • Description: The ID of the forecast manager associated with this role. Label is User ID.
  • Relationship name: ForecastUser
  • Relationship type: relationship
  • Refers to: User
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 11.0
  • Description: Indicates whether the forecast manager can manually share their own forecast.
  • Default value: false
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Required. Name of the role. Corresponds to Label on the user interface.
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Required. The opportunity access level for the account owner. Note that you can’t set a user role with an opportunity access less than that specified in organization-wide defaults.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The ID of the parent role.
  • Relationship name: ParentRole
  • Relationship type: relationship
  • Refers to: UserRole
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort
  • Introduced: API version 8.0
  • Description: The ID of the role’s associated portal account. This field is read-only.
  • Relationship name: PortalAccount
  • Relationship type: relationship
  • Refers to: Account
  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 12.0
  • Description: The ID of the role’s associated portal account’s owner. This field is read-only.
  • Relationship name: PortalAccountOwner
  • Relationship type: relationship
  • Refers to: User
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 12.0
  • Description: The portal role: Executive, Manager, User, or PersonAccount.

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort

  • Introduced: API version 9.0

  • Description:

    This value indicates the type of portal for the role:

    • None: Salesforce application role.
    • CustomerPortal: Customer portal role.
    • Partner: partner portal role. The field IsPartner used in release 8.0 will map to this value.

    This field replaces IsPartner beginning with release 9.0.

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Description of the forecast rollup. Label is Description.

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 record.

Users with the View Roles and Role Hierarchy permission can query or describe this object. If your client application logs in with the “Manage Users” permission, it can query, create, update, or delete UserRole records.

You can’t update any field for a portal role.

For example, the following code finds all roles that are not assigned to any users.