Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SSO

AWS Single Sign-On Portal is a web service that makes it easy for you to assign user access to AWS SSO resources such as the user portal. Users can get AWS account applications and roles assigned to them and get federated into the application.

For general information about AWS SSO, see What is AWS Single Sign-On? in the AWS SSO User Guide.

This API reference guide describes the AWS SSO Portal operations that you can call programatically and includes detailed information on data types and errors.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms, such as Java, Ruby, .Net, iOS, or Android. The SDKs provide a convenient way to create programmatic access to AWS SSO and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

The resolved configuration of SSOClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

destroy

  • destroy(): void
  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

getRoleCredentials

listAccountRoles

listAccounts

logout

  • Removes the client- and server-side session that is associated with the user.

    Parameters

    Returns Promise<LogoutCommandOutput>

  • Removes the client- and server-side session that is associated with the user.

    Parameters

    Returns void

  • Removes the client- and server-side session that is associated with the user.

    Parameters

    Returns void

send