IServiceConfiguration<TService> Interface

Article
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Represents a configured Microsoft Dynamics 365 service.

Namespace: Microsoft.Xrm.Sdk.Client
Assembly: Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Syntax

public interface IServiceConfiguration<TService>

Public Interface IServiceConfiguration(Of TService)

Type Parameters

TService
Type: Type. The type of service.

Properties

	Name	Description
	AuthenticationType	Gets the type of authentication in use by the identity provider of the service.
	CrossRealmIssuerEndpoints	Gets the available endpoints of the user’s home realm identity provider.
	CurrentIssuer	Gets or sets the endpoint used by the Secure Token Service (STS) to issue the trusted token.
	CurrentServiceEndpoint	Gets or sets the current endpoint in use by a service.
	IssuerEndpoints	Gets the available endpoints of the security token service (STS).
	PolicyConfiguration	Gets the policy configuration that identifies a Secure Token Service (STS).
	ServiceEndpoints	Gets the available endpoints of the service.

Methods

	Name	Description
	Authenticate(ClientCredentials)	Authenticates against the trusted Microsoft Dynamics 365 Secure Token Service using client credentials.
	Authenticate(ClientCredentials, SecurityTokenResponse)	Authenticates against Microsoft account using client credentials and a security token response.
	Authenticate(SecurityToken)	Authenticates against the trusted Microsoft Dynamics 365 Secure Token Service using a security token.
	AuthenticateCrossRealm(ClientCredentials, String, Uri)	Authenticates against a remote Secure Token Service (STS) using client credentials.
	AuthenticateCrossRealm(SecurityToken, String, Uri)	Authenticates against a remote Secure Token Service (STS) using a security token retrieved from an identity provider (when in federation mode).
	AuthenticateDevice(ClientCredentials)	Authenticates a registered device against Microsoft account.
	CreateChannelFactory()	Creates a client factory that uses the default Kerberos credentials.
	CreateChannelFactory(ClientAuthenticationType)	Creates a WCF channel factory with a specified type of authentication.
	CreateChannelFactory(ClientCredentials)	Creates a WCF channel factory that supports passing the client credentials, regardless of whether in federation authentication mode or not.
	CreateChannelFactory(TokenServiceCredentialType)	For internal use only.
	GetIdentityProvider(String)	Returns the identity provider used for a specified user when accessing a service.

Remarks

Instances of the IServiceConfiguration<TService> and IServiceManagement<TService> interfaces are basically interchangeable, the only real difference being that the IServiceManagement interface exposes support for the AuthenticationCredentials class and a single Authenticate call that covers most scenarios.

For best performance, create an instance of the IServiceConfiguration<TService> interface only one time per client session and re-use that instance as necessary.