Interface IEmbeddedCredentialsApiClient

Interface for an API client that modifies content's embedded credentials.

Namespace: Tableau.Migration.Api.EmbeddedCredentials

Assembly: Tableau.Migration.dll

Syntax

public interface IEmbeddedCredentialsApiClient

Methods

ApplyKeychainAsync(Guid, IApplyKeychainOptions, CancellationToken)

Uploads and applies encrypted keychains to a content item.

Declaration

Task<IResult> ApplyKeychainAsync(Guid contentItemId, IApplyKeychainOptions options, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	contentItemId	The ID of the content item.
IApplyKeychainOptions	options	The apply keychain options.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult>	The operation result.

RetrieveKeychainAsync(Guid, IDestinationSiteInfo, CancellationToken)

Retrieves the encrypted keychains for the content item.

Declaration

Task<IResult<IEmbeddedCredentialKeychainResult>> RetrieveKeychainAsync(Guid contentItemId, IDestinationSiteInfo destinationSiteInfo, CancellationToken cancel)

Parameters

Type	Name	Description
Guid	contentItemId	The ID of the content item.
IDestinationSiteInfo	destinationSiteInfo	The destination site information.
CancellationToken	cancel	The cancellation token to obey.

Returns

Type	Description
Task<IResult<IEmbeddedCredentialKeychainResult>>	The operation result.