Permissions In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:31:47 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:31:47

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IPermissions>() and is defined in Telligent.Evolution.Platform.dll

Methods

AdditionalInfo FlagPermissionForRegistrationUpdate(Guid permissionId);

Parameters

Name	Type	Description	Required	Default	Options
permissionId	`Guid`	Permission Id	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

PermissionCheck Get(Guid permissionId, int userId);

Obsolete. Obsolete in 11.0. Use Telligent.Evolution.Extensibility.Api.Version2.IPermissions.Get(...) Instead.

Parameters

Name	Type	Description	Required	Default	Options
permissionId	`Guid`	Permission Id	Required
userId	`int`	User Id	Required

Return Type

[[PermissionCheck In-Process API Supplementary Type|PermissionCheck]]

PermissionCheck Get(Guid permissionId, int userId, Guid contentId, Guid contentTypeId);

Obsolete. Obsolete in 11.0. Use Telligent.Evolution.Extensibility.Api.Version2.IPermissions.Get(...) Instead.

Parameters

Name	Type	Description	Required
permissionId	`Guid`	Permission Id	Required
userId	`int`	User Id	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required

Return Type

[[PermissionCheck In-Process API Supplementary Type|PermissionCheck]]

PermissionCheck Get(Guid permissionId, int userId, Guid entityId, Guid entityTypeId, PermissionType entityPermissionType);

Obsolete. Obsolete in 11.0. Use Telligent.Evolution.Extensibility.Api.Version2.IPermissions.Get(...) Instead.

Parameters

Name	Type	Description	Required
permissionId	`Guid`	Permission Id	Required
userId	`int`	User Id	Required
entityId	`Guid`	Entity Id	Required
entityTypeId	`Guid`	Entity Type Id	Required
entityPermissionType	`[[PermissionType In-Process API Supplementary Type\|PermissionType]]`	Entity Permission Type	Required

Return Type

[[PermissionCheck In-Process API Supplementary Type|PermissionCheck]]

Role Get(string application, int? id, int roleId, string permissionId, PermissionsGetOptions options = null);

Get Role for an application with a specific permission

Parameters

Name	Type	Description	Required
application	`string`	Application name, like Forum or Gallery	Required
id	`int?`	ID of the application	Required
roleId	`int`	Role Id	Required
permissionId	`string`	Permission Id	Required
options	`[[PermissionsGetOptions In-Process API Supplementary Type\|PermissionsGetOptions]]`	Optional parameter names are: Include	Optional

Return Type

[[Role In-Process API Supplementary Type|Role]]

Role Get(Guid applicationTypeId, Guid applicationId, int roleId, string permissionId, PermissionsGetOptions options = null);

Get Role for a group, application or content with a specific permission

Parameters

Name	Type	Description	Required
applicationTypeId	`Guid`	ApplicationTypeId of the group or application	Required
applicationId	`Guid`	ApplicationId of the group or application	Required
roleId	`int`	Role Id	Required
permissionId	`string`	Permission Id	Required
options	`[[PermissionsGetOptions In-Process API Supplementary Type\|PermissionsGetOptions]]`	Optional parameter names are: Include	Optional

Return Type

[[Role In-Process API Supplementary Type|Role]]

AdditionalInfo GrantApplicationPermission(Guid applicationId, int roleId, Guid permissionId);

Obsolete. Obsolete in 11.0. Use Telligent.Evolution.Extensibility.Api.Version2.IPermissions.Create(...) Instead.

Parameters

Name	Type	Description	Required
applicationId	`Guid`	Application Id	Required
roleId	`int`	Role Id	Required
permissionId	`Guid`	Permission Id	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

AdditionalInfo GrantGroupPermission(int groupId, int roleId, Guid permissionId);

Obsolete. Obsolete in 11.0. Use Telligent.Evolution.Extensibility.Api.Version2.IPermissions.Create(...) Instead.

Parameters

Name	Type	Description	Required
groupId	`int`	Group Id	Required
roleId	`int`	Role Id	Required
permissionId	`Guid`	Permission Id	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

AdditionalInfo GrantSitePermission(int roleId, Guid permissionId);

Obsolete. Obsolete in 11.0. Use Telligent.Evolution.Extensibility.Api.Version2.IPermissions.Create(...) Instead.

Parameters

Name	Type	Description	Required	Default	Options
roleId	`int`	Role Id	Required
permissionId	`Guid`	Permission Id	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

AdditionalInfo RevokeApplicationPermission(Guid applicationId, int roleId, Guid permissionId);

Obsolete. Obsolete in 11.0. Use Telligent.Evolution.Extensibility.Api.Version2.IPermissions.Delete(...) Instead.

Parameters

Name	Type	Description	Required
applicationId	`Guid`	Application Id	Required
roleId	`int`	Role Id	Required
permissionId	`Guid`	Permission Id	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

AdditionalInfo RevokeGroupPermission(int groupId, int roleId, Guid permissionId);

Obsolete. Obsolete in 11.0. Use Telligent.Evolution.Extensibility.Api.Version2.IPermissions.Delete(...) Instead.

Parameters

Name	Type	Description	Required
groupId	`int`	Group Id	Required
roleId	`int`	Role Id	Required
permissionId	`Guid`	Permission Id	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

AdditionalInfo RevokeSitePermission(int roleId, Guid permissionId);

Obsolete. Obsolete in 11.0. Use Telligent.Evolution.Extensibility.Api.Version2.IPermissions.Delete(...) Instead.

Parameters

Name	Type	Description	Required	Default	Options
roleId	`int`	Role Id	Required
permissionId	`Guid`	Permission Id	Required

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]