1.5.0 • Published 12 months ago

aws-simple-sso v1.5.0

Weekly downloads
-
License
MIT
Repository
github
Last release
12 months ago

aws-simple-sso

Simple AWS SSO Sign-in

Install

npm install aws-simple-sso

API Reference

Simplified AWS SSO authentication

Example

import { authenticate } from 'aws-simple-sso'
const credentials = await authenticate()

aws-simple-sso.authenticate ⇒ Promise.<SSOCredentials>

Simplified Authentication function

Kind: static constant of aws-simple-sso
Returns: Promise.<SSOCredentials> - SSO Role Credentials

ParamTypeDescription
paramsAuthenticateParamsOptional function parameters

aws-simple-sso.getOrgUrl ⇒ Promise.<SSOOrgUrl>

Get an Organization Start URL

Kind: static constant of aws-simple-sso
Returns: Promise.<SSOOrgUrl> - Organization Start URL

ParamTypeDescription
matchOrgMatchFunctionPartial string to match with the Org name

aws-simple-sso.getToken ⇒ Promise.<SSOToken>

Get an SSO OIDC Token

Kind: static constant of aws-simple-sso
Returns: Promise.<SSOToken> - SSO OIDC Token

ParamTypeDescription
orgUrlSSOOrgUrlSSO Start URL

aws-simple-sso.getAccount ⇒ Promise.<SSOAccount>

Get a list of SSO AWS Accounts

Kind: static constant of aws-simple-sso
Returns: Promise.<SSOAccount> - SSO Role

ParamTypeDescription
tokenSSOTokenSSO OIDC Token
matchAccMatchFunctionPartial string to match with the Account name

aws-simple-sso.getRole ⇒ Promise.<SSORole>

Get an SSO Role

Kind: static constant of aws-simple-sso
Returns: Promise.<SSORole> - SSO Role

ParamTypeDescription
tokenSSOTokenSSO OIDC Token
accountIdstringAWS Account Id
matchRoleMatchFunctionPartial string to match with the Role name

aws-simple-sso.getRoleCredentials ⇒ Promise.<SSOCredentials>

Get SSO Role Credentials

Kind: static constant of aws-simple-sso
Returns: Promise.<SSOCredentials> - SSO Role Credentials

ParamTypeDescription
tokenSSOTokenSSO OIDC Token
ssoRoleSSORoleSSO Role structure

aws-simple-sso~delay(ms) ⇒ Promise

Delay function

Kind: inner method of aws-simple-sso
Returns: Promise - Promise that resolves after the delay

ParamTypeDescription
msnumberDelay in milliseconds

aws-simple-sso~AuthenticateParams : object

Kind: inner typedef of aws-simple-sso
Properties

NameTypeDescription
matchOrgMatchFunctionOrganization match function
matchAccMatchFunctionAccount match function
matchRoleMatchFunctionRole match function

aws-simple-sso~SSOOrgUrl : object

Kind: inner typedef of aws-simple-sso
Properties

NameTypeDescription
namestringOrganization name
startUrlstringSSO Start URL

aws-simple-sso~SSOAccount : object

Kind: inner typedef of aws-simple-sso
Properties

NameTypeDescription
accountIdstringAWS Account Id
namestringAccount name

aws-simple-sso~SSOToken : object

Kind: inner typedef of aws-simple-sso
Properties

NameTypeDescription
accessTokenstringAWS Access Token
tokenTypestringToken type
expiresInnumberToken expiration in seconds
expireTimeDateToken expiration time
refreshTokenstringRefresh token
idTokenstringID token

aws-simple-sso~SSORole : object

Kind: inner typedef of aws-simple-sso
Properties

NameTypeDescription
accountIdstringAWS Account Id
namestringSSO Role name

aws-simple-sso~SSOCredentials : object

Kind: inner typedef of aws-simple-sso
Properties

NameTypeDescription
accessKeyIdstringAWS Access Key Id
secretAccessKeystringAWS Secret Access Key
sessionTokenstringAWS Session Token
expireTimeDateToken expiration time

aws-simple-sso~MatchFunction ⇒ boolean

Kind: inner typedef of aws-simple-sso
Returns: boolean - True if the value matches

ParamTypeDescription
valueobjectValue to match

License

MIT ©

1.5.0

12 months ago

1.4.0

1 year ago

1.3.1

1 year ago

1.3.0

1 year ago

1.2.2

1 year ago

1.2.1

1 year ago

1.2.0

1 year ago

1.1.0

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago