IIdentityProvider.Authenticate Method

IIdentityProviderAuthenticate Method

Authenticates the user for the specified identity.

Namespace: net.openstack.Core.Providers
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c

Syntax

C++

Copy

UserAccess Authenticate(
	CloudIdentity identity = null
)

Function Authenticate ( 
	Optional identity As CloudIdentity = Nothing
) As UserAccess

UserAccess^ Authenticate(
	CloudIdentity^ identity = nullptr
)

abstract Authenticate : 
        ?identity : CloudIdentity 
(* Defaults:
        let _identity = defaultArg identity null
*)
-> UserAccess

Parameters

identity (Optional): Type: net.openstack.Core.DomainCloudIdentity
The identity of the user to authenticate. If this value is , the authentication is performed with the DefaultIdentity.

Return Value

Type: UserAccess
A UserAccess object containing the authentication token, service catalog and user data.

Exceptions

Exception	Condition
NotSupportedException	If the provider does not support the given identity type.
InvalidOperationException	If identity is and no default identity is available for the provider.
ResponseException	If the authentication request failed.

Remarks

This method always authenticates to the server, even if an unexpired, cached UserAccess is available for the specified identity.

Version Information

.NET Framework

Supported in: 4.5

openstack.net

Supported in: 1.6, 1.5, 1.4, 1.3.6

Reference

IIdentityProvider Interface

net.openstack.Core.Providers Namespace

Other Resources

Authenticate (OpenStack Identity Service API v2.0 Reference)