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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.SSOAWSCredentialsOptions

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

Syntax

C#
public class SSOAWSCredentialsOptions

The SSOAWSCredentialsOptions type exposes the following members

Constructors

NameDescription
Public Method SSOAWSCredentialsOptions()

Properties

NameTypeDescription
Public Property ClientName System.String

Required - Name of the application or system used during SSO client registration. A timestamp indicating when the client was registered will be appended to requests made to the SSOOIDC service.

Public Property ProxySettings System.Net.WebProxy

The proxy settings to use when calling SSOOIDC and SSO Services.

Public Property Scopes System.Collections.Generic.IList<System.String>

The SSO scopes that are provided for authorization when using AWS SSO.

Public Property SessionName System.String

The name of the sso_session section in the shared configuration file specified to be used when loading the token.

Public Property SsoVerificationCallback System.Action<Amazon.Runtime.SsoVerificationArguments>

A callback that is used to initiate the SSO Login flow with the user.

Public Property SupportsGettingNewToken System.Boolean

This field controls whether a new sso token will be generated if a valid cached token or refreshable token is not found.

If true and a valid cached token or refreshable token is not found then sso authorization flow is started, a new token is generated and the result is cached. If false and a valid cached token or refreshable token is not found, an exception is thrown.

NOTE: If setting to true, Amazon.Runtime.SSOAWSCredentialsOptions.SsoVerificationCallback must also be set for authorization flow to succeed.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5