Set-InkCanvasOwner

Module:

InkCanvasAdmin Module

Transfers ownership of a specific Ink Canvas canvas from one user to another.

Syntax

Default (Default)

Set-InkCanvasOwner
    -FromUserId <String>
    -ToUserId <String>
    -CanvasId <String>
    [-DryRun]
    [-TenantId <String>]
    [-ClientId <String>]
    [-ClientSecret <String>]
    [-ContainerTypeId <String>]
    [-Auth <String>]
    [-Tenant <String>]
    [<CommonParameters>]

Description

Transfers ownership of a single Ink Canvas canvas from a source user to a target user. The canvas is copied to the target user's SharePoint Embedded container and then deleted from the source user's container. The target user must have opened Ink Canvas at least once to provision their container.

Use Invoke-TransferAllInkCanvases to transfer all canvases from one user to another.

Examples

EXAMPLE 1

Transfer a specific canvas from one user to another.

PS C:\>Set-InkCanvasOwner -FromUserId 00000000-0000-0000-0000-000000000001 -ToUserId 00000000-0000-0000-0000-000000000002 -CanvasId canvas_1712345678_abc12

EXAMPLE 2

Preview a canvas transfer without making any changes.

PS C:\>Set-InkCanvasOwner -FromUserId 00000000-0000-0000-0000-000000000001 -ToUserId 00000000-0000-0000-0000-000000000002 -CanvasId canvas_1712345678_abc12 -DryRun

Parameters

-Auth

Authentication method to use. Accepted values are: device-code, client-credentials. Defaults to device-code.

Parameter properties

Type:	System.String
Default value:	device-code
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-CanvasId

Required. The specific canvas ID (folder name) to transfer.

Parameter properties

Type:	System.String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ClientId

The client ID of the admin app registration in Azure Active Directory.

Parameter properties

Type:	System.String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ClientSecret

The client secret for client-credentials authentication.

Parameter properties

Type:	System.String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ContainerTypeId

The SharePoint Embedded container type ID for Ink Canvas.

Parameter properties

Type:	System.String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DryRun

If specified, prints what would be transferred without performing any actual changes.

Parameter properties

Type:	System.Management.Automation.SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-FromUserId

Required. The Azure Active Directory object GUID of the source user (current canvas owner).

Parameter properties

Type:	System.String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Tenant

A known tenant preset name that automatically fills in TenantId, ClientId, and ContainerTypeId.

Parameter properties

Type:	System.String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-TenantId

The Azure Active Directory tenant ID.

Parameter properties

Type:	System.String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ToUserId

Required. The Azure Active Directory object GUID of the target user (new canvas owner).

Parameter properties

Type:	System.String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Notes

The target user must have opened Ink Canvas at least once to provision their SharePoint Embedded container before a transfer can be performed.