| CloudIdentityProvider.GetToken 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.Rackspace
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
Syntaxpublic virtual IdentityToken GetToken( CloudIdentity identity, bool forceCacheRefresh = false )
Parameters
- identity
- Type: net.openstack.Core.Domain.CloudIdentity
The identity of the user to authenticate. If this value is null, the authentication is performed with the DefaultIdentity. - forceCacheRefresh (Optional)
- Type: System.Boolean
If true, the user is always authenticated against the server; otherwise a cached IdentityToken may be returned.
Return Value
Type: IdentityTokenThe user's authentication token.
Implements
IIdentityProvider.GetToken(CloudIdentity, Boolean)Exceptions| Exception | Condition |
|---|---|
| NotSupportedException | If the provider does not support the given identity type. |
| InvalidOperationException | If identity is null and no default identity is available for the provider. |
| ResponseException | If the authentication request failed. |
Remarks
If forceCacheRefresh is false 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 true, this method returns the equivalent of the following statement.
provider.Authenticate(identity).Token
Version Information.NET Framework
Supported in: 4.5openstack.net
Supported in: 1.6, 1.5, 1.4, 1.3.6See Also