role EntityType
Grouping of security privileges. Users are assigned roles that authorize their access to the Microsoft CRM system.
- Entity set path:
- [organization URI]/api/data/v9.2/roles
- Base type:
- crmbaseentity
- Table type:
- Standard
- Display name:
- Security Role
- Primary key:
- roleid
- Primary name column:
- name
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| appliesto | Edm.String |
Personas/Licenses the security role applies to Display name: Applies To |
||||||||||
| canbedeleted | BooleanManagedProperty |
Tells whether the role can be deleted. Display name: Can Be Deleted |
||||||||||
| componentstate | Edm.Int32 |
For internal use only. Display name: Component State Read only
Default options
|
||||||||||
| createdon | Edm.DateTimeOffset |
Date and time when the role was created. Display name: Created On Read only
|
||||||||||
| description | Edm.String |
Description of the security role Display name: Description |
||||||||||
| importsequencenumber | Edm.Int32 |
Unique identifier of the data import or data migration that created this record. Display name: Import Sequence Number |
||||||||||
| isautoassigned | Edm.Int32 |
Value indicating whether security role is auto-assigned based on user license Display name: Is Auto Assigned
Default options
|
||||||||||
| iscustomizable | BooleanManagedProperty |
Information that specifies whether this component can be customized. Display name: Customizable |
||||||||||
| isinherited | Edm.Int32 |
Role is inherited by users from team membership, if role associated with team. Display name: Is Inherited
Default options
|
||||||||||
| ismanaged | Edm.Boolean |
Indicates whether the solution component is part of a managed solution. Display name: State Read only
Default options
|
||||||||||
| modifiedon | Edm.DateTimeOffset |
Date and time when the role was last modified. Display name: Modified On Read only
|
||||||||||
| name | Edm.String |
Name of the role. Display name: Name |
||||||||||
| organizationid | Edm.Guid |
Unique identifier of the organization associated with the role. Display name: Organization Read only
|
||||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On |
||||||||||
| overwritetime | Edm.DateTimeOffset |
For internal use only. Display name: Record Overwrite Time Read only
|
||||||||||
| roleid | Edm.Guid |
Unique identifier of the role. Display name: Role |
||||||||||
| roleidunique | Edm.Guid |
For internal use only. Display name: Unique Id Read only
|
||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display name: Solution Read only
|
||||||||||
| summaryofcoretablepermissions | Edm.String |
Summary of Core Table Permissions of the Role Display name: Summary of Core Table Permissions |
||||||||||
| versionnumber | Edm.Int64 |
Version number of the role. Display name: Version number Read only
|
Lookup properties
Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.
| Name | Single-valued navigation property | Description |
|---|---|---|
| _businessunitid_value | businessunitid |
Unique identifier of the business unit with which the role is associated. |
| _createdby_value | createdby |
Unique identifier of the user who created the role. |
| _createdonbehalfby_value | createdonbehalfby |
Unique identifier of the delegate user who created the role. |
| _modifiedby_value | modifiedby |
Unique identifier of the user who last modified the role. |
| _modifiedonbehalfby_value | modifiedonbehalfby |
Unique identifier of the delegate user who last modified the role. |
| _parentroleid_value | parentroleid |
Unique identifier of the parent role. |
| _parentrootroleid_value | parentrootroleid |
Unique identifier of the parent root role. |
| _roletemplateid_value | roletemplateid |
Unique identifier of the role template that is associated with the role. |
Single-valued navigation properties
Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.
| Name | Type | Partner |
|---|---|---|
| businessunitid | businessunit | business_unit_roles |
| createdby | systemuser | lk_rolebase_createdby |
| createdonbehalfby | systemuser | lk_role_createdonbehalfby |
| modifiedby | systemuser | lk_rolebase_modifiedby |
| modifiedonbehalfby | systemuser | lk_role_modifiedonbehalfby |
| organizationid_organization | organization | organization_roles |
| parentroleid | role | role_parent_role |
| parentrootroleid | role | role_parent_root_role |
| roletemplateid | roletemplate | role_template_roles |
| solution_role | solution | solution_role |
Collection-valued navigation properties
Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.
| Name | Type | Partner |
|---|---|---|
| application_role | application | application_role |
| applicationuserrole | applicationuser | applicationuserrole |
| appmoduleroles_association | appmodule | appmoduleroles_association |
| Role_AsyncOperations | asyncoperation | regardingobjectid_role |
| Role_BulkDeleteFailures | bulkdeletefailure | regardingobjectid_role |
| role_parent_role | role | parentroleid |
| role_parent_root_role | role | parentrootroleid |
| Role_SyncErrors | syncerror | regardingobjectid_role_syncerror |
| roleprivileges_association | privilege | roleprivileges_association |
| systemuserroles_association | systemuser | systemuserroles_association |
| teamroles_association | team | teamroles_association |
Operations
The following operations can be used with the role entity type.
| Name | Binding |
|---|---|
| AddPrivilegesRole | Bound to Entity |
| RemovePrivilegeRole | Bound to Entity |
| ReplacePrivilegesRole | Bound to Entity |
| RetrieveAadUserRoles | Not Bound |
| RetrieveRolePrivilegesRole | Not Bound |