Class SAMLEndpointManager

Namespace

Amazon.Runtime.CredentialManagement

Assembly

AWSSDK.Core.dll

Manages endpoints to be used in conjunction with SAML role profiles. The role profiles reference the endpoint to obtain the actual endpoint and any customization settings needed to perform authentication.

public class SAMLEndpointManager

Inheritance

object

SAMLEndpointManager

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SAMLEndpointManager()

Construct a SAMLEndpointManager.

public SAMLEndpointManager()

Properties

IsAvailable

True if the SAMLEndpointManager is available on the current platform, false otherwise.

public static bool IsAvailable { get; }

Property Value

bool

Methods

GetEndpoint(string)

Get an endpoint from the store. Throws an exception if there's an error reading the endpoint, or if it doesn't exist.

public SAMLEndpoint GetEndpoint(string endpointName)

Parameters

endpointName string

The name of the endpoint to get.

Returns

SAMLEndpoint

The endpoint with the given name.

ListEndpointNames()

List the names of valid endpoints in the store.

public List<string> ListEndpointNames()

Returns

List<string>

ListEndpoints()

List valid endopints that can be read from the store.

public List<SAMLEndpoint> ListEndpoints()

Returns

List<SAMLEndpoint>

RegisterEndpoint(SAMLEndpoint)

Register an endpoint, or update an existing one.

public void RegisterEndpoint(SAMLEndpoint samlEndpoint)

Parameters

samlEndpoint SAMLEndpoint

The endpoint to register.

TryGetEndpoint(string, out SAMLEndpoint)

Get an endpoint, if it exists and is valid.

public bool TryGetEndpoint(string endpointName, out SAMLEndpoint samlEndpoint)

Parameters

endpointName string

The name of the endpoint to get.

samlEndpoint SAMLEndpoint

The endpoint, or null if it's invalid or doesn't exist.

Returns

bool

True if the endpoint exists and is valid, false otherwise.

UnregisterEndpoint(string)

Delete an endpoint from the store, if it exists.

public void UnregisterEndpoint(string endpointName)

Parameters

endpointName string

The name of the endpoint to delete.