aws-simple-sso v1.5.0
aws-simple-sso
Simple AWS SSO Sign-in
Install
npm install aws-simple-ssoAPI 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
| Param | Type | Description |
|---|---|---|
| params | AuthenticateParams | Optional 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
| Param | Type | Description |
|---|---|---|
| matchOrg | MatchFunction | Partial 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
| Param | Type | Description |
|---|---|---|
| orgUrl | SSOOrgUrl | SSO 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
| Param | Type | Description |
|---|---|---|
| token | SSOToken | SSO OIDC Token |
| matchAcc | MatchFunction | Partial 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
| Param | Type | Description |
|---|---|---|
| token | SSOToken | SSO OIDC Token |
| accountId | string | AWS Account Id |
| matchRole | MatchFunction | Partial 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
| Param | Type | Description |
|---|---|---|
| token | SSOToken | SSO OIDC Token |
| ssoRole | SSORole | SSO 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
| Param | Type | Description |
|---|---|---|
| ms | number | Delay in milliseconds |
aws-simple-sso~AuthenticateParams : object
Kind: inner typedef of aws-simple-sso
Properties
| Name | Type | Description |
|---|---|---|
| matchOrg | MatchFunction | Organization match function |
| matchAcc | MatchFunction | Account match function |
| matchRole | MatchFunction | Role match function |
aws-simple-sso~SSOOrgUrl : object
Kind: inner typedef of aws-simple-sso
Properties
| Name | Type | Description |
|---|---|---|
| name | string | Organization name |
| startUrl | string | SSO Start URL |
aws-simple-sso~SSOAccount : object
Kind: inner typedef of aws-simple-sso
Properties
| Name | Type | Description |
|---|---|---|
| accountId | string | AWS Account Id |
| name | string | Account name |
aws-simple-sso~SSOToken : object
Kind: inner typedef of aws-simple-sso
Properties
| Name | Type | Description |
|---|---|---|
| accessToken | string | AWS Access Token |
| tokenType | string | Token type |
| expiresIn | number | Token expiration in seconds |
| expireTime | Date | Token expiration time |
| refreshToken | string | Refresh token |
| idToken | string | ID token |
aws-simple-sso~SSORole : object
Kind: inner typedef of aws-simple-sso
Properties
| Name | Type | Description |
|---|---|---|
| accountId | string | AWS Account Id |
| name | string | SSO Role name |
aws-simple-sso~SSOCredentials : object
Kind: inner typedef of aws-simple-sso
Properties
| Name | Type | Description |
|---|---|---|
| accessKeyId | string | AWS Access Key Id |
| secretAccessKey | string | AWS Secret Access Key |
| sessionToken | string | AWS Session Token |
| expireTime | Date | Token expiration time |
aws-simple-sso~MatchFunction ⇒ boolean
Kind: inner typedef of aws-simple-sso
Returns: boolean - True if the value matches
| Param | Type | Description |
|---|---|---|
| value | object | Value to match |