role EntityType

Description: Grouping of security privileges. Users are assigned roles that authorize their access to the Microsoft CRM system.

Entity Set path: [organization URI]/api/data/v8.0/roles

Base Type: crmbaseentity EntityType

Display Name: Security Role

Primary Key: roleid

Primary Name Attribute: name

Properties

Single-valued navigation properties

Collection-valued navigation properties

Operations bound to role

Operations using the role entity type.

Properties

Properties represent fields of data stored in the entity. Some properties are not writable.

Name Type Details

_businessunitid_value

Edm.Guid

Description: Unique identifier of the business unit with which the role is associated.

Computed property

Read-only property

_createdby_value

Edm.Guid

Description: Unique identifier of the user who created the role.

Computed property

Read-only property

_createdonbehalfby_value

Edm.Guid

Description: Unique identifier of the delegate user who created the role.

Computed property

Read-only property

_modifiedby_value

Edm.Guid

Description: Unique identifier of the user who last modified the role.

Computed property

Read-only property

_modifiedonbehalfby_value

Edm.Guid

Description: Unique identifier of the delegate user who last modified the role.

Computed property

Read-only property

_parentroleid_value

Edm.Guid

Description: Unique identifier of the parent role.

Computed property

Read-only property

_parentrootroleid_value

Edm.Guid

Description: Unique identifier of the parent root role.

Computed property

Read-only property

_roletemplateid_value

Edm.Guid

Description: Unique identifier of the role template that is associated with the role.

Computed property

Read-only property

componentstate

Edm.Int32

Description: For internal use only.

Default Options:

0 : Published
1 : Unpublished
2 : Deleted
3 : Deleted Unpublished

Display Name: Component State

Read-only property

createdon

Edm.DateTimeOffset

Description: Date and time when the role was created.

Display Name: Created On

Read-only property

importsequencenumber

Edm.Int32

Description: Unique identifier of the data import or data migration that created this record.

Display Name: Import Sequence Number

iscustomizable

mscrm.BooleanManagedProperty

Description: Information that specifies whether this component can be customized.

Display Name: Customizable

ismanaged

Edm.Boolean

Description: Indicates whether the solution component is part of a managed solution.

Default Options:

1 : Managed
0 : Unmanaged

Display Name: State

Read-only property

modifiedon

Edm.DateTimeOffset

Description: Date and time when the role was last modified.

Display Name: Modified On

Read-only property

name

Edm.String

Description: Name of the role.

Display Name: Name

organizationid

Edm.Guid

Description: Unique identifier of the organization associated with the role.

Display Name: Organization

Read-only property

overriddencreatedon

Edm.DateTimeOffset

Description: Date and time that the record was migrated.

Display Name: Record Created On

overwritetime

Edm.DateTimeOffset

Description: For internal use only.

Display Name: Record Overwrite Time

Read-only property

roleid

Edm.Guid

Description: Unique identifier of the role.

Display Name: Role

roleidunique

Edm.Guid

Description: For internal use only.

Display Name: Unique Id

Read-only property

solutionid

Edm.Guid

Description: Unique identifier of the associated solution.

Display Name: Solution

Read-only property

versionnumber

Edm.Int64

Description: Version number of the role.

Display Name: Version number

Read-only property

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced.

Name Type Partner

businessunitid

businessunit EntityType

business_unit_roles

createdby

systemuser EntityType

lk_rolebase_createdby

createdonbehalfby

systemuser EntityType

lk_role_createdonbehalfby

modifiedby

systemuser EntityType

lk_rolebase_modifiedby

modifiedonbehalfby

systemuser EntityType

lk_role_modifiedonbehalfby

organizationid_organization

organization EntityType

organization_roles

parentroleid

role EntityType

role_parent_role

parentrootroleid

role EntityType

role_parent_root_role

roletemplateid

roletemplate EntityType

role_template_roles

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

Role_AsyncOperations

asyncoperation EntityType

regardingobjectid_role

Role_BulkDeleteFailures

bulkdeletefailure EntityType

regardingobjectid_role

role_parent_role

role EntityType

parentroleid

role_parent_root_role

role EntityType

parentrootroleid

roleprivileges_association

privilege EntityType

roleprivileges_association

systemuserroles_association

systemuser EntityType

systemuserroles_association

teamroles_association

team EntityType

teamroles_association

Operations bound to role

The following operations are bound to the role entity type.

Name Bound to

AddPrivilegesRole Action

Entity

RemovePrivilegeRole Action

Entity

ReplacePrivilegesRole Action

Entity

Operations using the role entity type.

The following operations use the role entity type in a parameter or return type.

Name How used Description

AddPrivilegesRole Action

entity Parameter

Adds a set of existing privileges to an existing role.

RemovePrivilegeRole Action

entity Parameter

Removes a privilege from an existing role.

ReplacePrivilegesRole Action

entity Parameter

Replaces the privilege set of an existing role.

関連項目

他のリソース

Web API Action Reference
Web API Function Reference
Web API Query Function Reference
Web API EnumType Reference
Web API ComplexType Reference
Web API Metadata EntityType Reference

Microsoft Dynamics CRM 2016 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2015 Microsoft. All rights reserved.