AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Removes the locally stored SSO tokens from the client-side cache and sends an API call to the IAM Identity Center service to invalidate the corresponding server-side IAM Identity Center sign in session.

If a user uses IAM Identity Center to access the AWS CLI, the user’s IAM Identity Center sign in session is used to obtain an IAM session, as specified in the corresponding IAM Identity Center permission set. More specifically, IAM Identity Center assumes an IAM role in the target account on behalf of the user, and the corresponding temporary AWS credentials are returned to the client.

After user logout, any existing IAM role sessions that were created by using IAM Identity Center permission sets continue based on the duration configured in the permission set. For more information, see User authentications in the IAM Identity Center User Guide.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginLogout and EndLogout.

Namespace: Amazon.SSO
Assembly: AWSSDK.SSO.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<LogoutResponse> LogoutAsync(
         LogoutRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.SSO.Model.LogoutRequest

Container for the necessary parameters to execute the Logout service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the Logout service method, as returned by SSO.

Exceptions

ExceptionCondition
InvalidRequestException Indicates that a problem occurred with the input to the request. For example, a required parameter might be missing or out of range.
TooManyRequestsException Indicates that the request is being made too frequently and is more than what the server can handle.
UnauthorizedException Indicates that the request is not authorized. This can happen due to an invalid access token in the request.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also