IServiceConfiguration<TService>.AuthenticateCrossRealm Method

Definition

Namespace:

Microsoft.Xrm.Sdk.Client

Assembly:

Microsoft.Xrm.Sdk.dll

Package:

Microsoft.PowerPlatform.Dataverse.Client v1.1.17

Overloads

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).
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).

public:
 Microsoft::Xrm::Sdk::Client::SecurityTokenResponse ^ AuthenticateCrossRealm(System::IdentityModel::Tokens::SecurityToken ^ securityToken, System::String ^ appliesTo, Uri ^ crossRealmSts);

public Microsoft.Xrm.Sdk.Client.SecurityTokenResponse AuthenticateCrossRealm (System.IdentityModel.Tokens.SecurityToken securityToken, string appliesTo, Uri crossRealmSts);

abstract member AuthenticateCrossRealm : System.IdentityModel.Tokens.SecurityToken * string * Uri -> Microsoft.Xrm.Sdk.Client.SecurityTokenResponse

Public Function AuthenticateCrossRealm (securityToken As SecurityToken, appliesTo As String, crossRealmSts As Uri) As SecurityTokenResponse

Parameters

securityToken

SecurityToken

Specifies a security token issued from an identity provider.

appliesTo

String

Specifies the identifier of the STS to authenticate on behalf of.

crossRealmSts

Uri

Specifies the URI of the cross realm STS metadata endpoint.

Returns

SecurityTokenResponse

The security token response.

AuthenticateCrossRealm(ClientCredentials, String, Uri)

Authenticates against a remote Secure Token Service (STS) using client credentials.

public:
 Microsoft::Xrm::Sdk::Client::SecurityTokenResponse ^ AuthenticateCrossRealm(System::ServiceModel::Description::ClientCredentials ^ clientCredentials, System::String ^ appliesTo, Uri ^ crossRealmSts);

public Microsoft.Xrm.Sdk.Client.SecurityTokenResponse AuthenticateCrossRealm (System.ServiceModel.Description.ClientCredentials clientCredentials, string appliesTo, Uri crossRealmSts);

abstract member AuthenticateCrossRealm : System.ServiceModel.Description.ClientCredentials * string * Uri -> Microsoft.Xrm.Sdk.Client.SecurityTokenResponse

Public Function AuthenticateCrossRealm (clientCredentials As ClientCredentials, appliesTo As String, crossRealmSts As Uri) As SecurityTokenResponse

Parameters

clientCredentials

ClientCredentials

Specifies a client credentials instance with the Windows credentials or the UserName (.UserName and .Password) set.

appliesTo

String

Specifies the identifier of the STS to authenticate on behalf of.

crossRealmSts

Uri

Specifies the URI of the cross realm STS metadata endpoint.

Returns

SecurityTokenResponse

The security token response.