| IIdentityServiceGetUserAccessAsync Method |
This API is preliminary and subject to change.
Gets the user access details, authenticating with the server if necessary.
Namespace: net.openstack.Core.Providers
Assembly: openstacknet (in openstacknet.dll) Version: 1.7.7+Branch.master.Sha.25d803f397c8693c2c13777ef6675f796f520f2c
SyntaxTask<UserAccess> GetUserAccessAsync( CloudIdentity identity, bool forceCacheRefresh, CancellationToken cancellationToken )
Parameters
- identity
- Type: net.openstack.Core.DomainCloudIdentity
The identity of the user to authenticate. - forceCacheRefresh
- Type: SystemBoolean
If , the user is always authenticated against the server; otherwise a cached IdentityToken may be returned. - cancellationToken
- Type: System.ThreadingCancellationToken
The CancellationToken that the task will observe.
Return Value
Type: TaskUserAccessA Task object representing the asynchronous operation. When the task completes successfully, the Result property will contain 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 REST API request failed. |
Remarks
If forceCacheRefresh is and a cached UserAccess
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 is equivalent to AuthenticateAsync(CloudIdentity, CancellationToken).
Version Information.NET Framework
Supported in: 4.5openstack.net
Supported in: 1.6, 1.5, 1.4, 1.3.6See Also