Share via

Clear-AipServiceDocumentRevoked

  • Reference
Module:
AIPService

Un-revokes a specified, protected document that currently has a revoke status.

Syntax

Clear-AipServiceDocumentRevoked
     [-Force]
     -ContentId <Guid>
     - IssuerName <String>
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Clear-AipServiceDocumentRevoked cmdlet clears the document's revoke status, and un-revokes a specified protected document, based on the document's contentID and Rights Management issuer.

For example, use this cmdlet if you have accidentally revoked access to the specified document, and want to now grant access again.

Before running this cmdlet you must first load the AipService.dll.

Examples

Example 1: Unrevoke access for a specific document

Import-Module -Name "C:\Program Files\WindowsPowerShell\Modules\AIPService\1.0.0.4\AipService.dll"
Clear-AipServiceDocumentRevoked -ContentId c03bf90c-6e40-4f3f-9ba0-2bcd77524b87 - IssuerName  "alice@contoso.com"

This command clears the revoked state for a document with a contentID value of c03bf90c-6e40-4f3f-9ba0-2bcd77524b87, which was protected by a user with the alice@contoso.com email address.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ContentId

Specifies the contentID value for the document you want to return tracking data for.

To retrieve the contentID for a specific document, use the Get-AipServiceDocumentLog cmdlet.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IssuerName

Specifies the email of the Rights Management issuer for the document you want to unrevoke access for.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False