CloudIdentityProviderGetToken Method |
Gets the authentication token for the specified identity. If necessary, the identity is authenticated
on the server to obtain a token.
Namespace: net.openstack.Providers.RackspaceAssembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntax public virtual IdentityToken GetToken(
CloudIdentity identity,
bool forceCacheRefresh = false
)
Public Overridable Function GetToken (
identity As CloudIdentity,
Optional forceCacheRefresh As Boolean = false
) As IdentityToken
public:
virtual IdentityToken^ GetToken(
CloudIdentity^ identity,
bool forceCacheRefresh = false
)
abstract GetToken :
identity : CloudIdentity *
?forceCacheRefresh : bool
(* Defaults:
let _forceCacheRefresh = defaultArg forceCacheRefresh false
*)
-> IdentityToken
override GetToken :
identity : CloudIdentity *
?forceCacheRefresh : bool
(* Defaults:
let _forceCacheRefresh = defaultArg forceCacheRefresh false
*)
-> IdentityToken
Parameters
- identity
- Type: net.openstack.Core.DomainCloudIdentity
The identity of the user to authenticate. If this value is , the authentication is performed with the DefaultIdentity. - forceCacheRefresh (Optional)
- Type: SystemBoolean
If , the user is always authenticated against the server; otherwise a cached IdentityToken may be returned.
Return Value
Type:
IdentityTokenThe user's authentication token.
Implements
IIdentityProviderGetToken(CloudIdentity, Boolean)Exceptions Remarks
If
forceCacheRefresh is
and a cached
IdentityToken
is available for the specified
identity, this method may return the cached
value without performing an authentication against the server. If
forceCacheRefresh
is
, this method returns the equivalent of the following statement.
provider.Authenticate(identity).Token
Version Information .NET Framework
Supported in: 4.5
openstack.net
Supported in: 1.6, 1.5, 1.4, 1.3.6
See Also