SecureStoreServiceApplication SecureStoreServiceApplication SecureStoreServiceApplication Class

Definition

Provides the application programming interface (API) for the SecureStoreServiceApplicationProxy to execute the client’s method call, and implements services provided by the Secure Store Service.

public ref class SecureStoreServiceApplication sealed : Microsoft::SharePoint::Administration::SPIisWebServiceApplication, IDisposable, Microsoft::Office::SecureStoreService::Server::ISecureStoreServiceApplication
[Microsoft.SharePoint.Administration.IisWebServiceApplicationBackupBehavior]
[System.Runtime.InteropServices.Guid("B85F20D0-BDED-4aa9-9449-F0005B4A0482")]
[System.ServiceModel.ServiceBehavior(IncludeExceptionDetailInFaults=true)]
public sealed class SecureStoreServiceApplication : Microsoft.SharePoint.Administration.SPIisWebServiceApplication, IDisposable, Microsoft.Office.SecureStoreService.Server.ISecureStoreServiceApplication
Public NotInheritable Class SecureStoreServiceApplication
Inherits SPIisWebServiceApplication
Implements IDisposable, ISecureStoreServiceApplication
Inheritance
Attributes
Implements

Remarks

This is the only application that is supported by the SecureStoreService object.

Constructors

SecureStoreServiceApplication() SecureStoreServiceApplication() SecureStoreServiceApplication()

Initializes a new instance of the SecureStoreServiceApplication class.

Properties

AccessRights AccessRights AccessRights Inherited from SPIisWebServiceApplication
AdministrationAccessRights AdministrationAccessRights AdministrationAccessRights Inherited from SPServiceApplication
ApplicationClassId ApplicationClassId ApplicationClassId

Gets the globally unique identifier (GUID) that represents the application class ID.

ApplicationPool ApplicationPool ApplicationPool Inherited from SPIisWebServiceApplication
ApplicationVersion ApplicationVersion ApplicationVersion

Gets the version of the current application.

CanUpgrade CanUpgrade CanUpgrade Inherited from SPPersistedUpgradableObject
Comments Comments Comments Inherited from SPIisWebServiceApplication
DefaultEndpoint DefaultEndpoint DefaultEndpoint Inherited from SPIisWebServiceApplication
DefaultEndpointName DefaultEndpointName DefaultEndpointName Inherited from SPIisWebServiceApplication
DisplayName DisplayName DisplayName Inherited from SPPersistedObject
Endpoints Endpoints Endpoints Inherited from SPIisWebServiceApplication
Farm Farm Farm Inherited from SPPersistedObject
IBackupRestore.CanRenameOnRestore IBackupRestore.CanRenameOnRestore IBackupRestore.CanRenameOnRestore Inherited from SPIisWebServiceApplication
IBackupRestore.CanSelectForBackup IBackupRestore.CanSelectForBackup IBackupRestore.CanSelectForBackup Inherited from SPIisWebServiceApplication
IBackupRestore.CanSelectForRestore IBackupRestore.CanSelectForRestore IBackupRestore.CanSelectForRestore Inherited from SPIisWebServiceApplication
IBackupRestore.DiskSizeRequired IBackupRestore.DiskSizeRequired IBackupRestore.DiskSizeRequired Inherited from SPIisWebServiceApplication
Id Id Id Inherited from SPPersistedObject
IisVirtualDirectoryPath IisVirtualDirectoryPath IisVirtualDirectoryPath Inherited from SPIisWebServiceApplication
InstallPath InstallPath InstallPath Inherited from SPIisWebServiceApplication
IsBackwardsCompatible IsBackwardsCompatible IsBackwardsCompatible Inherited from SPPersistedUpgradableObject
ISharedServiceApplication.DefaultEndpoint ISharedServiceApplication.DefaultEndpoint ISharedServiceApplication.DefaultEndpoint Inherited from SPIisWebServiceApplication
ManageLink ManageLink ManageLink

Gets a SharePoint SPAdministrationLink object to the page that is used to manage the application.

Name Name Name Inherited from SPPersistedObject
NeedsUpgrade NeedsUpgrade NeedsUpgrade Inherited from SPPersistedUpgradableObject
NeedsUpgradeIncludeChildren NeedsUpgradeIncludeChildren NeedsUpgradeIncludeChildren Inherited from SPPersistedUpgradableObject
Parent Parent Parent Inherited from SPPersistedObject
PermissionsLink PermissionsLink PermissionsLink Inherited from SPIisWebServiceApplication
Properties Properties Properties Inherited from SPPersistedObject
PropertiesLink PropertiesLink PropertiesLink

Returns a link to edit the properties for the current application.

Service Service Service Inherited from SPServiceApplication
ServiceApplicationProxyGroup ServiceApplicationProxyGroup ServiceApplicationProxyGroup Inherited from SPServiceApplication
ServiceInstances ServiceInstances ServiceInstances Inherited from SPServiceApplication
Shared Shared Shared Inherited from SPIisWebServiceApplication
Status Status Status Inherited from SPPersistedObject
TermsOfServiceUri TermsOfServiceUri TermsOfServiceUri Inherited from SPIisWebServiceApplication
TypeName TypeName TypeName

Gets the type name that describes the current application.

UpgradeContext UpgradeContext UpgradeContext Inherited from SPPersistedUpgradableObject
UpgradedPersistedProperties UpgradedPersistedProperties UpgradedPersistedProperties Inherited from SPAutoSerializingObject
Uri Uri Uri Inherited from SPIisWebServiceApplication
Version Version Version Inherited from SPPersistedObject
VirtualPath VirtualPath VirtualPath Inherited from SPIisWebServiceApplication
WasCreated WasCreated WasCreated Inherited from SPPersistedObject

Methods

AddServiceEndpoint(String, SPIisWebServiceBindingType) AddServiceEndpoint(String, SPIisWebServiceBindingType) AddServiceEndpoint(String, SPIisWebServiceBindingType) Inherited from SPIisWebServiceApplication
AddServiceEndpoint(String, SPIisWebServiceBindingType, String) AddServiceEndpoint(String, SPIisWebServiceBindingType, String) AddServiceEndpoint(String, SPIisWebServiceBindingType, String) Inherited from SPIisWebServiceApplication
ApplicationPoolChanged(SPIisWebServiceApplicationPool) ApplicationPoolChanged(SPIisWebServiceApplicationPool) ApplicationPoolChanged(SPIisWebServiceApplicationPool)

Grants the Secure Store Service database access to the new application pool owner after the application pool has changed.

BeginProvision(AsyncCallback, Object) BeginProvision(AsyncCallback, Object) BeginProvision(AsyncCallback, Object) Inherited from SPServiceApplication
BeginUnprovision(AsyncCallback, Object) BeginUnprovision(AsyncCallback, Object) BeginUnprovision(AsyncCallback, Object) Inherited from SPServiceApplication
ChangeMasterSecretKey(String, Byte[]) ChangeMasterSecretKey(String, Byte[]) ChangeMasterSecretKey(String, Byte[])

Changes the master key in the SecureStoreServiceDatabase for the current application.

CheckAccess(SPIisWebServiceApplicationRights) CheckAccess(SPIisWebServiceApplicationRights) CheckAccess(SPIisWebServiceApplicationRights) Inherited from SPIisWebServiceApplication
CheckAdministrationAccess(SPCentralAdministrationRights) CheckAdministrationAccess(SPCentralAdministrationRights) CheckAdministrationAccess(SPCentralAdministrationRights) Inherited from SPServiceApplication
Clone() Clone() Clone() Inherited from SPPersistedObject
CreateApplication(Guid, TargetApplication, IList<TargetApplicationField>, TargetApplicationClaims) CreateApplication(Guid, TargetApplication, IList<TargetApplicationField>, TargetApplicationClaims) CreateApplication(Guid, TargetApplication, IList<TargetApplicationField>, TargetApplicationClaims)

Creates a target application.

CreateConnectionSettings(Guid, ConnectionSettings) CreateConnectionSettings(Guid, ConnectionSettings) CreateConnectionSettings(Guid, ConnectionSettings)

Create a new instance of the ConnectionSettings.

Delete() Delete() Delete()

Removes the current application.

DeleteAllUserCredentials(Guid, SecureStoreServiceClaim) DeleteAllUserCredentials(Guid, SecureStoreServiceClaim) DeleteAllUserCredentials(Guid, SecureStoreServiceClaim)

Deletes the credentials for the specified user for all of the target applications in the specified partition.

DeleteApplication(Guid, String) DeleteApplication(Guid, String) DeleteApplication(Guid, String)

Deletes the specified target application from the specified partition.

DeleteConnectionSettings(Guid, String) DeleteConnectionSettings(Guid, String) DeleteConnectionSettings(Guid, String)

Delete the ConnectionSettings identified by the ConnectionSettings id.

DeleteCredentials(Guid, String) DeleteCredentials(Guid, String) DeleteCredentials(Guid, String)

Deletes the credentials of the current caller for the specified individual target application in the specified partition.

DeleteUserCredentials(Guid, String, SecureStoreServiceClaim) DeleteUserCredentials(Guid, String, SecureStoreServiceClaim) DeleteUserCredentials(Guid, String, SecureStoreServiceClaim)

Deletes the specified user credentials for the specified target application in the specified partition.

DemandAccess(SPIisWebServiceApplicationRights) DemandAccess(SPIisWebServiceApplicationRights) DemandAccess(SPIisWebServiceApplicationRights) Inherited from SPIisWebServiceApplication
DemandAdministrationAccess(SPCentralAdministrationRights) DemandAdministrationAccess(SPCentralAdministrationRights) DemandAdministrationAccess(SPCentralAdministrationRights) Inherited from SPServiceApplication
Dispose() Dispose() Dispose()

Releases all resources used by the current instance of the SecureStoreServiceApplication class.

EndProvision(IAsyncResult) EndProvision(IAsyncResult) EndProvision(IAsyncResult) Inherited from SPServiceApplication
EndUnprovision(IAsyncResult) EndUnprovision(IAsyncResult) EndUnprovision(IAsyncResult) Inherited from SPServiceApplication
Equals(Object) Equals(Object) Equals(Object) Inherited from SPPersistedObject
Finalize() Finalize() Finalize()

This member is reserved for internal use and is not intended to be used directly from your code.

GetAccessControl() GetAccessControl() GetAccessControl() Inherited from SPIisWebServiceApplication
GetAdministrationAccessControl() GetAdministrationAccessControl() GetAdministrationAccessControl() Inherited from SPServiceApplication
GetAllConnectionSettings(Guid, ConnectionSettingsType) GetAllConnectionSettings(Guid, ConnectionSettingsType) GetAllConnectionSettings(Guid, ConnectionSettingsType)

Return all the ConnectionSettings in the secure store.

GetApplication(Guid, String) GetApplication(Guid, String) GetApplication(Guid, String)

Gets the target application definition for the specified application in the specified partition.

GetApplicationAdministratorClaims(Guid, String) GetApplicationAdministratorClaims(Guid, String) GetApplicationAdministratorClaims(Guid, String)

Gets the claims of the administrators for the specified target application.

GetApplicationClaims(Guid, String) GetApplicationClaims(Guid, String) GetApplicationClaims(Guid, String)

Gets the collection of claims of the administrators, group members, and ticket redeemers for the specified target application in the specified partition.

GetApplicationFields(Guid, String) GetApplicationFields(Guid, String) GetApplicationFields(Guid, String)

Gets all of the application fields for the specified target application and partition.

GetApplicationGroupClaims(Guid, String) GetApplicationGroupClaims(Guid, String) GetApplicationGroupClaims(Guid, String)

Gets the claims of the group members of the specified group target application in the specified partition.

GetApplications(Guid) GetApplications(Guid) GetApplications(Guid)

Gets all the target application definitions in the specified partition.

GetApplicationTicketRedeemerClaims(Guid, String) GetApplicationTicketRedeemerClaims(Guid, String) GetApplicationTicketRedeemerClaims(Guid, String)

Gets all of the ticket redeemer claims for the specified partition in the specified target application.

GetChangeMasterSecretKeyToken() GetChangeMasterSecretKeyToken() GetChangeMasterSecretKeyToken()

Gets the token that is required to change the master secret key for the current application.

GetChild<T>() GetChild<T>() GetChild<T>() Inherited from SPPersistedObject
GetChild<T>(String) GetChild<T>(String) GetChild<T>(String) Inherited from SPPersistedObject
GetChildConnectionSettings(Guid, String) GetChildConnectionSettings(Guid, String) GetChildConnectionSettings(Guid, String)

Return the ConnectionSettings identified by the it's parent ConnectionSettings id

GetConnectionSettings(Guid, String, Boolean, SerializableSecureStoreCredentialCollection, SerializableSecureStoreCredentialCollection) GetConnectionSettings(Guid, String, Boolean, SerializableSecureStoreCredentialCollection, SerializableSecureStoreCredentialCollection) GetConnectionSettings(Guid, String, Boolean, SerializableSecureStoreCredentialCollection, SerializableSecureStoreCredentialCollection)

Return the ConnectionSettings identified by the ConnectionSettings id.

GetCredentials(Guid, String) GetCredentials(Guid, String) GetCredentials(Guid, String)

Gets the credentials for the specified target application in the specified partition.

GetDependentProcessIdentities() GetDependentProcessIdentities() GetDependentProcessIdentities() Inherited from SPServiceApplication
GetHashCode() GetHashCode() GetHashCode() Inherited from SPPersistedObject
GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) GetObjectData(SerializationInfo, StreamingContext) Inherited from SPAutoSerializingObject
GetRestrictedCredentials(Guid, String) GetRestrictedCredentials(Guid, String) GetRestrictedCredentials(Guid, String)

Gets the credentials for a restricted target application.

GetUserApplication(Guid, String) GetUserApplication(Guid, String) GetUserApplication(Guid, String)

Gets all of the application definitions for the specified target application for the current caller.

GetUserApplicationFields(Guid, String) GetUserApplicationFields(Guid, String) GetUserApplicationFields(Guid, String)

Gets all of the application fields information for the specified target application for the current caller.

GetUserApplications(Guid) GetUserApplications(Guid) GetUserApplications(Guid)

Gets all the target application definitions in the specified partition for the current caller.

HasAdditionalUpdateAccess() HasAdditionalUpdateAccess() HasAdditionalUpdateAccess() Inherited from SPServiceApplication
Invalidate() Invalidate() Invalidate() Inherited from SPPersistedUpgradableObject
IsConnected(SPServiceApplicationProxy) IsConnected(SPServiceApplicationProxy) IsConnected(SPServiceApplicationProxy) Inherited from SPIisWebServiceApplication
IsMasterSecretKeyPopulated() IsMasterSecretKeyPopulated() IsMasterSecretKeyPopulated()

Returns a value that indicates whether the master secret key has been populated for the Secure Store Service application.

IssueTicket(Guid) IssueTicket(Guid) IssueTicket(Guid)

Issues a ticket to the current caller.

MigrateGroupAccount(Guid, String, String, IEnumerable<Byte[]>, Byte[]) MigrateGroupAccount(Guid, String, String, IEnumerable<Byte[]>, Byte[]) MigrateGroupAccount(Guid, String, String, IEnumerable<Byte[]>, Byte[]) Inherited from SPServiceApplication
MigrateUserAccount(Guid, String, String, IEnumerable<Byte[]>, Byte[]) MigrateUserAccount(Guid, String, String, IEnumerable<Byte[]>, Byte[]) MigrateUserAccount(Guid, String, String, IEnumerable<Byte[]>, Byte[]) Inherited from SPIisWebServiceApplication
OnDependentProcessIdentityChanged() OnDependentProcessIdentityChanged() OnDependentProcessIdentityChanged() Inherited from SPServiceApplication
OnDeserialization() OnDeserialization() OnDeserialization() Inherited from SPIisWebServiceApplication
OnProcessIdentityChanged(SecurityIdentifier) OnProcessIdentityChanged(SecurityIdentifier) OnProcessIdentityChanged(SecurityIdentifier) Inherited from SPIisWebServiceApplication
OpenInstanceConfiguration() OpenInstanceConfiguration() OpenInstanceConfiguration() Inherited from SPIisWebServiceApplication
Provision() Provision() Provision()

Makes the changes to the local server that are needed before the SecureStoreServiceApplication object can be used.

ProvisionInstances() ProvisionInstances() ProvisionInstances() Inherited from SPServiceApplication
ProvisionLocal(SPServiceInstance) ProvisionLocal(SPServiceInstance) ProvisionLocal(SPServiceInstance) Inherited from SPIisWebServiceApplication
RedeemTicket(Guid, String, String) RedeemTicket(Guid, String, String) RedeemTicket(Guid, String, String)

Gets the credentials for the specified ticket and the specified target application.

SetAccessControl(SPIisWebServiceApplicationSecurity) SetAccessControl(SPIisWebServiceApplicationSecurity) SetAccessControl(SPIisWebServiceApplicationSecurity) Inherited from SPIisWebServiceApplication
SetAdministrationAccessControl(SPCentralAdministrationSecurity) SetAdministrationAccessControl(SPCentralAdministrationSecurity) SetAdministrationAccessControl(SPCentralAdministrationSecurity) Inherited from SPServiceApplication
SetChangeKeyPassphrase(Byte[]) SetChangeKeyPassphrase(Byte[]) SetChangeKeyPassphrase(Byte[])

Sets the passphrase hash on the application server.

SetCredentials(Guid, String, SerializableSecureStoreCredentialCollection) SetCredentials(Guid, String, SerializableSecureStoreCredentialCollection) SetCredentials(Guid, String, SerializableSecureStoreCredentialCollection)

Sets the credentials for the current caller for the specified individual target application in the specified partition.

SetGroupCredentials(Guid, String, SerializableSecureStoreCredentialCollection) SetGroupCredentials(Guid, String, SerializableSecureStoreCredentialCollection) SetGroupCredentials(Guid, String, SerializableSecureStoreCredentialCollection)

Sets the credentials for the specified group target application in the specified partition.

SetMasterSecretKey(Byte[]) SetMasterSecretKey(Byte[]) SetMasterSecretKey(Byte[])

Sets the master secret key of the application server.

SetUserCredentials(Guid, String, SecureStoreServiceClaim, SerializableSecureStoreCredentialCollection) SetUserCredentials(Guid, String, SecureStoreServiceClaim, SerializableSecureStoreCredentialCollection) SetUserCredentials(Guid, String, SecureStoreServiceClaim, SerializableSecureStoreCredentialCollection)

Sets the credentials for the specified user, target application, and partition.

ToString() ToString() ToString() Inherited from SPPersistedObject
Uncache() Uncache() Uncache() Inherited from SPPersistedObject
Unprovision() Unprovision() Unprovision() Inherited from SPServiceApplication
Unprovision(Boolean) Unprovision(Boolean) Unprovision(Boolean)

Unprovisions the current application.

UnprovisionInstances() UnprovisionInstances() UnprovisionInstances() Inherited from SPServiceApplication
UnprovisionLocal(SPServiceInstance) UnprovisionLocal(SPServiceInstance) UnprovisionLocal(SPServiceInstance) Inherited from SPIisWebServiceApplication
Update() Update() Update() Inherited from SPIisWebServiceApplication
Update(Boolean) Update(Boolean) Update(Boolean) Inherited from SPPersistedObject
UpdateApplication(Guid, TargetApplication, IList<TargetApplicationField>, TargetApplicationClaims) UpdateApplication(Guid, TargetApplication, IList<TargetApplicationField>, TargetApplicationClaims) UpdateApplication(Guid, TargetApplication, IList<TargetApplicationField>, TargetApplicationClaims)

Updates a target application definition.

UpdateConnectionSettings(Guid, ConnectionSettings) UpdateConnectionSettings(Guid, ConnectionSettings) UpdateConnectionSettings(Guid, ConnectionSettings)

Update the ConnectionSettings object.

UpdateParent() UpdateParent() UpdateParent() Inherited from SPAutoSerializingObject
Upgrade() Upgrade() Upgrade() Inherited from SPPersistedUpgradableObject
Upgrade(Boolean) Upgrade(Boolean) Upgrade(Boolean) Inherited from SPPersistedUpgradableObject
Validate() Validate() Validate() Inherited from SPPersistedObject
ValidateBackwardsCompatibility() ValidateBackwardsCompatibility() ValidateBackwardsCompatibility() Inherited from SPPersistedUpgradableObject

Explicit Interface Implementations

IBackupRestore.AddBackupObjects(SPBackupRestoreObject) IBackupRestore.AddBackupObjects(SPBackupRestoreObject) IBackupRestore.AddBackupObjects(SPBackupRestoreObject) Inherited from SPIisWebServiceApplication
IBackupRestore.OnAbort(Object, SPBackupRestoreInformation) IBackupRestore.OnAbort(Object, SPBackupRestoreInformation) IBackupRestore.OnAbort(Object, SPBackupRestoreInformation) Inherited from SPIisWebServiceApplication
IBackupRestore.OnBackup(Object, SPBackupInformation) IBackupRestore.OnBackup(Object, SPBackupInformation) IBackupRestore.OnBackup(Object, SPBackupInformation) Inherited from SPIisWebServiceApplication
IBackupRestore.OnBackupComplete(Object, SPBackupInformation) IBackupRestore.OnBackupComplete(Object, SPBackupInformation) IBackupRestore.OnBackupComplete(Object, SPBackupInformation) Inherited from SPIisWebServiceApplication
IBackupRestore.OnPostRestore(Object, SPRestoreInformation) IBackupRestore.OnPostRestore(Object, SPRestoreInformation) IBackupRestore.OnPostRestore(Object, SPRestoreInformation) Inherited from SPIisWebServiceApplication
IBackupRestore.OnPrepareBackup(Object, SPBackupInformation) IBackupRestore.OnPrepareBackup(Object, SPBackupInformation) IBackupRestore.OnPrepareBackup(Object, SPBackupInformation) Inherited from SPIisWebServiceApplication
IBackupRestore.OnPreRestore(Object, SPRestoreInformation) IBackupRestore.OnPreRestore(Object, SPRestoreInformation) IBackupRestore.OnPreRestore(Object, SPRestoreInformation) Inherited from SPIisWebServiceApplication
IBackupRestore.OnRestore(Object, SPRestoreInformation) IBackupRestore.OnRestore(Object, SPRestoreInformation) IBackupRestore.OnRestore(Object, SPRestoreInformation) Inherited from SPIisWebServiceApplication

Extension Methods

ToJson(Object) ToJson(Object) ToJson(Object)

Applies to