Skip to main content

GetEffectivePermissions

Gets the effective permissions of a document.

Syntax

// Assumes shellUI has been initialized with IShellUI instance
const results = await shellUI.Vault.ObjectOperations.GetEffectivePermissions({
obj_ver: {
obj_id: {
type: 0,
item_id: {
internal_id: 0,
external_repository_id: {
connection: "<!< The external repository connection identifier.>",
item: "<item>",
},
},
},
version: {
type: 7 /* Enum: ObjVerVersionType */,
internal_version: 0,
external_repository_version: "<external_repository_version>",
external_repository_sort_key: 0,
},
},
});

Message

NameDescriptionType
obj_verThe object version.ObjVer

Return type

NameDescriptionType
permissionsPermissions.EffectivePermissions[]

Example

{
"permissions": [] /* Array of EffectivePermissions */
}