Documentation

Overview

    Package sso provides the API client, operations, and parameter types for AWS Single Sign-On.

    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? (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html) 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 (http://aws.amazon.com/tools/).

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2019-06-10"
    View Source
    const ServiceID = "SSO"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

          type Client struct {
          	// contains filtered or unexported fields
          }

            Client provides the API client to make operations call for AWS Single Sign-On.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) GetRoleCredentials

                func (c *Client) GetRoleCredentials(ctx context.Context, params *GetRoleCredentialsInput, optFns ...func(*Options)) (*GetRoleCredentialsOutput, error)

                  Returns the STS short-term credentials for a given role name that is assigned to the user.

                  func (*Client) ListAccountRoles

                  func (c *Client) ListAccountRoles(ctx context.Context, params *ListAccountRolesInput, optFns ...func(*Options)) (*ListAccountRolesOutput, error)

                    Lists all roles that are assigned to the user for a given AWS account.

                    func (*Client) ListAccounts

                    func (c *Client) ListAccounts(ctx context.Context, params *ListAccountsInput, optFns ...func(*Options)) (*ListAccountsOutput, error)

                      Lists all AWS accounts assigned to the user. These AWS accounts are assigned by the administrator of the account. For more information, see Assign User Access (https://docs.aws.amazon.com/singlesignon/latest/userguide/useraccess.html#assignusers) in the AWS SSO User Guide. This operation returns a paginated response.

                      func (*Client) Logout

                      func (c *Client) Logout(ctx context.Context, params *LogoutInput, optFns ...func(*Options)) (*LogoutOutput, error)

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

                        type EndpointResolver

                        type EndpointResolver interface {
                        	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                        }

                          EndpointResolver interface for resolving service endpoints.

                          func EndpointResolverFromURL

                          func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                            EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                            type EndpointResolverFunc

                            type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                              EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                              func (EndpointResolverFunc) ResolveEndpoint

                              func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                              type EndpointResolverOptions

                              type EndpointResolverOptions = internalendpoints.Options

                                EndpointResolverOptions is the service endpoint resolver options

                                type GetRoleCredentialsInput

                                type GetRoleCredentialsInput struct {
                                
                                	// The token issued by the CreateToken API call. For more information, see
                                	// CreateToken
                                	// (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html)
                                	// in the AWS SSO OIDC API Reference Guide.
                                	//
                                	// This member is required.
                                	AccessToken *string
                                
                                	// The identifier for the AWS account that is assigned to the user.
                                	//
                                	// This member is required.
                                	AccountId *string
                                
                                	// The friendly name of the role that is assigned to the user.
                                	//
                                	// This member is required.
                                	RoleName *string
                                }

                                type GetRoleCredentialsOutput

                                type GetRoleCredentialsOutput struct {
                                
                                	// The credentials for the role that is assigned to the user.
                                	RoleCredentials *types.RoleCredentials
                                
                                	// Metadata pertaining to the operation's result.
                                	ResultMetadata middleware.Metadata
                                }

                                type HTTPClient

                                type HTTPClient interface {
                                	Do(*http.Request) (*http.Response, error)
                                }

                                type HTTPSignerV4

                                type HTTPSignerV4 interface {
                                	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                }

                                type ListAccountRolesAPIClient

                                type ListAccountRolesAPIClient interface {
                                	ListAccountRoles(context.Context, *ListAccountRolesInput, ...func(*Options)) (*ListAccountRolesOutput, error)
                                }

                                  ListAccountRolesAPIClient is a client that implements the ListAccountRoles operation.

                                  type ListAccountRolesInput

                                  type ListAccountRolesInput struct {
                                  
                                  	// The token issued by the CreateToken API call. For more information, see
                                  	// CreateToken
                                  	// (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html)
                                  	// in the AWS SSO OIDC API Reference Guide.
                                  	//
                                  	// This member is required.
                                  	AccessToken *string
                                  
                                  	// The identifier for the AWS account that is assigned to the user.
                                  	//
                                  	// This member is required.
                                  	AccountId *string
                                  
                                  	// The number of items that clients can request per page.
                                  	MaxResults *int32
                                  
                                  	// The page token from the previous response output when you request subsequent
                                  	// pages.
                                  	NextToken *string
                                  }

                                  type ListAccountRolesOutput

                                  type ListAccountRolesOutput struct {
                                  
                                  	// The page token client that is used to retrieve the list of accounts.
                                  	NextToken *string
                                  
                                  	// A paginated response with the list of roles and the next token if more results
                                  	// are available.
                                  	RoleList []types.RoleInfo
                                  
                                  	// Metadata pertaining to the operation's result.
                                  	ResultMetadata middleware.Metadata
                                  }

                                  type ListAccountRolesPaginator

                                  type ListAccountRolesPaginator struct {
                                  	// contains filtered or unexported fields
                                  }

                                    ListAccountRolesPaginator is a paginator for ListAccountRoles

                                    func NewListAccountRolesPaginator

                                    func NewListAccountRolesPaginator(client ListAccountRolesAPIClient, params *ListAccountRolesInput, optFns ...func(*ListAccountRolesPaginatorOptions)) *ListAccountRolesPaginator

                                      NewListAccountRolesPaginator returns a new ListAccountRolesPaginator

                                      func (*ListAccountRolesPaginator) HasMorePages

                                      func (p *ListAccountRolesPaginator) HasMorePages() bool

                                        HasMorePages returns a boolean indicating whether more pages are available

                                        func (*ListAccountRolesPaginator) NextPage

                                        func (p *ListAccountRolesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAccountRolesOutput, error)

                                          NextPage retrieves the next ListAccountRoles page.

                                          type ListAccountRolesPaginatorOptions

                                          type ListAccountRolesPaginatorOptions struct {
                                          	// The number of items that clients can request per page.
                                          	Limit int32
                                          
                                          	// Set to true if pagination should stop if the service returns a pagination token
                                          	// that matches the most recent token provided to the service.
                                          	StopOnDuplicateToken bool
                                          }

                                            ListAccountRolesPaginatorOptions is the paginator options for ListAccountRoles

                                            type ListAccountsAPIClient

                                            type ListAccountsAPIClient interface {
                                            	ListAccounts(context.Context, *ListAccountsInput, ...func(*Options)) (*ListAccountsOutput, error)
                                            }

                                              ListAccountsAPIClient is a client that implements the ListAccounts operation.

                                              type ListAccountsInput

                                              type ListAccountsInput struct {
                                              
                                              	// The token issued by the CreateToken API call. For more information, see
                                              	// CreateToken
                                              	// (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html)
                                              	// in the AWS SSO OIDC API Reference Guide.
                                              	//
                                              	// This member is required.
                                              	AccessToken *string
                                              
                                              	// This is the number of items clients can request per page.
                                              	MaxResults *int32
                                              
                                              	// (Optional) When requesting subsequent pages, this is the page token from the
                                              	// previous response output.
                                              	NextToken *string
                                              }

                                              type ListAccountsOutput

                                              type ListAccountsOutput struct {
                                              
                                              	// A paginated response with the list of account information and the next token if
                                              	// more results are available.
                                              	AccountList []types.AccountInfo
                                              
                                              	// The page token client that is used to retrieve the list of accounts.
                                              	NextToken *string
                                              
                                              	// Metadata pertaining to the operation's result.
                                              	ResultMetadata middleware.Metadata
                                              }

                                              type ListAccountsPaginator

                                              type ListAccountsPaginator struct {
                                              	// contains filtered or unexported fields
                                              }

                                                ListAccountsPaginator is a paginator for ListAccounts

                                                func NewListAccountsPaginator

                                                func NewListAccountsPaginator(client ListAccountsAPIClient, params *ListAccountsInput, optFns ...func(*ListAccountsPaginatorOptions)) *ListAccountsPaginator

                                                  NewListAccountsPaginator returns a new ListAccountsPaginator

                                                  func (*ListAccountsPaginator) HasMorePages

                                                  func (p *ListAccountsPaginator) HasMorePages() bool

                                                    HasMorePages returns a boolean indicating whether more pages are available

                                                    func (*ListAccountsPaginator) NextPage

                                                    func (p *ListAccountsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAccountsOutput, error)

                                                      NextPage retrieves the next ListAccounts page.

                                                      type ListAccountsPaginatorOptions

                                                      type ListAccountsPaginatorOptions struct {
                                                      	// This is the number of items clients can request per page.
                                                      	Limit int32
                                                      
                                                      	// Set to true if pagination should stop if the service returns a pagination token
                                                      	// that matches the most recent token provided to the service.
                                                      	StopOnDuplicateToken bool
                                                      }

                                                        ListAccountsPaginatorOptions is the paginator options for ListAccounts

                                                        type LogoutInput

                                                        type LogoutInput struct {
                                                        
                                                        	// The token issued by the CreateToken API call. For more information, see
                                                        	// CreateToken
                                                        	// (https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/API_CreateToken.html)
                                                        	// in the AWS SSO OIDC API Reference Guide.
                                                        	//
                                                        	// This member is required.
                                                        	AccessToken *string
                                                        }

                                                        type LogoutOutput

                                                        type LogoutOutput struct {
                                                        	// Metadata pertaining to the operation's result.
                                                        	ResultMetadata middleware.Metadata
                                                        }

                                                        type Options

                                                        type Options struct {
                                                        	// Set of options to modify how an operation is invoked. These apply to all
                                                        	// operations invoked for this client. Use functional options on operation call to
                                                        	// modify this list for per operation behavior.
                                                        	APIOptions []func(*middleware.Stack) error
                                                        
                                                        	// Configures the events that will be sent to the configured logger.
                                                        	ClientLogMode aws.ClientLogMode
                                                        
                                                        	// The credentials object to use when signing requests.
                                                        	Credentials aws.CredentialsProvider
                                                        
                                                        	// The endpoint options to be used when attempting to resolve an endpoint.
                                                        	EndpointOptions EndpointResolverOptions
                                                        
                                                        	// The service endpoint resolver.
                                                        	EndpointResolver EndpointResolver
                                                        
                                                        	// Signature Version 4 (SigV4) Signer
                                                        	HTTPSignerV4 HTTPSignerV4
                                                        
                                                        	// The logger writer interface to write logging messages to.
                                                        	Logger logging.Logger
                                                        
                                                        	// The region to send requests to. (Required)
                                                        	Region string
                                                        
                                                        	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                        	// failures. When nil the API client will use a default retryer.
                                                        	Retryer aws.Retryer
                                                        
                                                        	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                        	// implementation if nil.
                                                        	HTTPClient HTTPClient
                                                        }

                                                        func (Options) Copy

                                                        func (o Options) Copy() Options

                                                          Copy creates a clone where the APIOptions list is deep copied.

                                                          type ResolveEndpoint

                                                          type ResolveEndpoint struct {
                                                          	Resolver EndpointResolver
                                                          	Options  EndpointResolverOptions
                                                          }

                                                          func (*ResolveEndpoint) HandleSerialize

                                                          func (*ResolveEndpoint) ID

                                                          func (*ResolveEndpoint) ID() string

                                                          Directories

                                                          Path Synopsis
                                                          internal