@aws-sdk/client-sso-oidc 3.145.0 → 3.159.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +27 -0
- package/README.md +16 -38
- package/dist-types/SSOOIDC.d.ts +19 -42
- package/dist-types/SSOOIDCClient.d.ts +16 -38
- package/dist-types/commands/CreateTokenCommand.d.ts +1 -1
- package/dist-types/commands/RegisterClientCommand.d.ts +1 -1
- package/dist-types/commands/StartDeviceAuthorizationCommand.d.ts +1 -2
- package/dist-types/models/models_0.d.ts +22 -56
- package/dist-types/ts3.4/models/models_0.d.ts +1 -1
- package/package.json +24 -24
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,33 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [3.159.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.158.0...v3.159.0) (2022-08-26)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @aws-sdk/client-sso-oidc
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# [3.158.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.157.0...v3.158.0) (2022-08-25)
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Features
|
|
18
|
+
|
|
19
|
+
* **client-sso-oidc:** Updated required request parameters on IAM Identity Center's OIDC CreateToken action. ([ab82210](https://github.com/aws/aws-sdk-js-v3/commit/ab82210186cfaaddb6130c28153d3ac3f0fb8389))
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
# [3.154.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.153.0...v3.154.0) (2022-08-19)
|
|
26
|
+
|
|
27
|
+
**Note:** Version bump only for package @aws-sdk/client-sso-oidc
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
6
33
|
# [3.145.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.144.0...v3.145.0) (2022-08-08)
|
|
7
34
|
|
|
8
35
|
**Note:** Version bump only for package @aws-sdk/client-sso-oidc
|
package/README.md
CHANGED
|
@@ -9,46 +9,24 @@
|
|
|
9
9
|
|
|
10
10
|
AWS SDK for JavaScript SSOOIDC Client for Node.js, Browser and React Native.
|
|
11
11
|
|
|
12
|
-
<p>
|
|
13
|
-
or a native application) to register with
|
|
14
|
-
fetch the user’s access token upon successful authentication and
|
|
15
|
-
|
|
12
|
+
<p>AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client
|
|
13
|
+
(such as AWS CLI or a native application) to register with AWS SSO. The service also
|
|
14
|
+
enables the client to fetch the user’s access token upon successful authentication and
|
|
15
|
+
authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of
|
|
16
|
+
the device authorization grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>).</p>
|
|
17
|
+
|
|
18
|
+
<p>For general information about AWS SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is AWS
|
|
19
|
+
Single Sign-On?</a> in the <i>AWS SSO User Guide</i>.</p>
|
|
20
|
+
|
|
21
|
+
<p>This API reference guide describes the AWS SSO OIDC operations that you can call
|
|
22
|
+
programatically and includes detailed information on data types and errors.</p>
|
|
23
|
+
|
|
16
24
|
<note>
|
|
17
|
-
<p>
|
|
18
|
-
|
|
19
|
-
|
|
25
|
+
<p>AWS provides SDKs that consist of libraries and sample code for various programming
|
|
26
|
+
languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a
|
|
27
|
+
convenient way to create programmatic access to AWS SSO and other AWS services. For more
|
|
28
|
+
information about the AWS SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p>
|
|
20
29
|
</note>
|
|
21
|
-
<p>
|
|
22
|
-
<b>Considerations for Using This Guide</b>
|
|
23
|
-
</p>
|
|
24
|
-
<p>Before you begin using this guide, we recommend that you first review the following
|
|
25
|
-
important information about how the Amazon Web Services SSO OIDC service works.</p>
|
|
26
|
-
<ul>
|
|
27
|
-
<li>
|
|
28
|
-
<p>The Amazon Web Services SSO OIDC service currently implements only the portions of the OAuth 2.0
|
|
29
|
-
Device Authorization Grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>) that are necessary to enable single
|
|
30
|
-
sign-on authentication with the AWS CLI. Support for other OIDC flows frequently needed
|
|
31
|
-
for native applications, such as Authorization Code Flow (+ PKCE), will be addressed in
|
|
32
|
-
future releases.</p>
|
|
33
|
-
</li>
|
|
34
|
-
<li>
|
|
35
|
-
<p>The service emits only OIDC access tokens, such that obtaining a new token (For
|
|
36
|
-
example, token refresh) requires explicit user re-authentication.</p>
|
|
37
|
-
</li>
|
|
38
|
-
<li>
|
|
39
|
-
<p>The access tokens provided by this service grant access to all AWS account
|
|
40
|
-
entitlements assigned to an Amazon Web Services SSO user, not just a particular application.</p>
|
|
41
|
-
</li>
|
|
42
|
-
<li>
|
|
43
|
-
<p>The documentation in this guide does not describe the mechanism to convert the access
|
|
44
|
-
token into AWS Auth (“sigv4”) credentials for use with IAM-protected AWS service
|
|
45
|
-
endpoints. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html">GetRoleCredentials</a> in the <i>Amazon Web Services SSO Portal API Reference
|
|
46
|
-
Guide</i>.</p>
|
|
47
|
-
</li>
|
|
48
|
-
</ul>
|
|
49
|
-
|
|
50
|
-
<p>For general information about Amazon Web Services SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is
|
|
51
|
-
Amazon Web Services SSO?</a> in the <i>Amazon Web Services SSO User Guide</i>.</p>
|
|
52
30
|
|
|
53
31
|
## Installing
|
|
54
32
|
|
package/dist-types/SSOOIDC.d.ts
CHANGED
|
@@ -4,66 +4,43 @@ import { RegisterClientCommandInput, RegisterClientCommandOutput } from "./comma
|
|
|
4
4
|
import { StartDeviceAuthorizationCommandInput, StartDeviceAuthorizationCommandOutput } from "./commands/StartDeviceAuthorizationCommand";
|
|
5
5
|
import { SSOOIDCClient } from "./SSOOIDCClient";
|
|
6
6
|
/**
|
|
7
|
-
* <p>
|
|
8
|
-
* or a native application) to register with
|
|
9
|
-
* fetch the user’s access token upon successful authentication and
|
|
10
|
-
*
|
|
7
|
+
* <p>AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client
|
|
8
|
+
* (such as AWS CLI or a native application) to register with AWS SSO. The service also
|
|
9
|
+
* enables the client to fetch the user’s access token upon successful authentication and
|
|
10
|
+
* authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of
|
|
11
|
+
* the device authorization grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>).</p>
|
|
12
|
+
*
|
|
13
|
+
* <p>For general information about AWS SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is AWS
|
|
14
|
+
* Single Sign-On?</a> in the <i>AWS SSO User Guide</i>.</p>
|
|
15
|
+
*
|
|
16
|
+
* <p>This API reference guide describes the AWS SSO OIDC operations that you can call
|
|
17
|
+
* programatically and includes detailed information on data types and errors.</p>
|
|
18
|
+
*
|
|
11
19
|
* <note>
|
|
12
|
-
* <p>
|
|
13
|
-
*
|
|
14
|
-
*
|
|
20
|
+
* <p>AWS provides SDKs that consist of libraries and sample code for various programming
|
|
21
|
+
* languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a
|
|
22
|
+
* convenient way to create programmatic access to AWS SSO and other AWS services. For more
|
|
23
|
+
* information about the AWS SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p>
|
|
15
24
|
* </note>
|
|
16
|
-
* <p>
|
|
17
|
-
* <b>Considerations for Using This Guide</b>
|
|
18
|
-
* </p>
|
|
19
|
-
* <p>Before you begin using this guide, we recommend that you first review the following
|
|
20
|
-
* important information about how the Amazon Web Services SSO OIDC service works.</p>
|
|
21
|
-
* <ul>
|
|
22
|
-
* <li>
|
|
23
|
-
* <p>The Amazon Web Services SSO OIDC service currently implements only the portions of the OAuth 2.0
|
|
24
|
-
* Device Authorization Grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>) that are necessary to enable single
|
|
25
|
-
* sign-on authentication with the AWS CLI. Support for other OIDC flows frequently needed
|
|
26
|
-
* for native applications, such as Authorization Code Flow (+ PKCE), will be addressed in
|
|
27
|
-
* future releases.</p>
|
|
28
|
-
* </li>
|
|
29
|
-
* <li>
|
|
30
|
-
* <p>The service emits only OIDC access tokens, such that obtaining a new token (For
|
|
31
|
-
* example, token refresh) requires explicit user re-authentication.</p>
|
|
32
|
-
* </li>
|
|
33
|
-
* <li>
|
|
34
|
-
* <p>The access tokens provided by this service grant access to all AWS account
|
|
35
|
-
* entitlements assigned to an Amazon Web Services SSO user, not just a particular application.</p>
|
|
36
|
-
* </li>
|
|
37
|
-
* <li>
|
|
38
|
-
* <p>The documentation in this guide does not describe the mechanism to convert the access
|
|
39
|
-
* token into AWS Auth (“sigv4”) credentials for use with IAM-protected AWS service
|
|
40
|
-
* endpoints. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html">GetRoleCredentials</a> in the <i>Amazon Web Services SSO Portal API Reference
|
|
41
|
-
* Guide</i>.</p>
|
|
42
|
-
* </li>
|
|
43
|
-
* </ul>
|
|
44
|
-
*
|
|
45
|
-
* <p>For general information about Amazon Web Services SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is
|
|
46
|
-
* Amazon Web Services SSO?</a> in the <i>Amazon Web Services SSO User Guide</i>.</p>
|
|
47
25
|
*/
|
|
48
26
|
export declare class SSOOIDC extends SSOOIDCClient {
|
|
49
27
|
/**
|
|
50
28
|
* <p>Creates and returns an access token for the authorized client. The access token issued
|
|
51
|
-
* will be used to fetch short-term credentials for the assigned roles in the
|
|
29
|
+
* will be used to fetch short-term credentials for the assigned roles in the AWS
|
|
52
30
|
* account.</p>
|
|
53
31
|
*/
|
|
54
32
|
createToken(args: CreateTokenCommandInput, options?: __HttpHandlerOptions): Promise<CreateTokenCommandOutput>;
|
|
55
33
|
createToken(args: CreateTokenCommandInput, cb: (err: any, data?: CreateTokenCommandOutput) => void): void;
|
|
56
34
|
createToken(args: CreateTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTokenCommandOutput) => void): void;
|
|
57
35
|
/**
|
|
58
|
-
* <p>Registers a client with
|
|
36
|
+
* <p>Registers a client with AWS SSO. This allows clients to initiate device authorization.
|
|
59
37
|
* The output should be persisted for reuse through many authentication requests.</p>
|
|
60
38
|
*/
|
|
61
39
|
registerClient(args: RegisterClientCommandInput, options?: __HttpHandlerOptions): Promise<RegisterClientCommandOutput>;
|
|
62
40
|
registerClient(args: RegisterClientCommandInput, cb: (err: any, data?: RegisterClientCommandOutput) => void): void;
|
|
63
41
|
registerClient(args: RegisterClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterClientCommandOutput) => void): void;
|
|
64
42
|
/**
|
|
65
|
-
* <p>Initiates device authorization by requesting a pair of verification codes from the
|
|
66
|
-
* authorization service.</p>
|
|
43
|
+
* <p>Initiates device authorization by requesting a pair of verification codes from the authorization service.</p>
|
|
67
44
|
*/
|
|
68
45
|
startDeviceAuthorization(args: StartDeviceAuthorizationCommandInput, options?: __HttpHandlerOptions): Promise<StartDeviceAuthorizationCommandOutput>;
|
|
69
46
|
startDeviceAuthorization(args: StartDeviceAuthorizationCommandInput, cb: (err: any, data?: StartDeviceAuthorizationCommandOutput) => void): void;
|
|
@@ -123,46 +123,24 @@ declare type SSOOIDCClientResolvedConfigType = __SmithyResolvedConfiguration<__H
|
|
|
123
123
|
export interface SSOOIDCClientResolvedConfig extends SSOOIDCClientResolvedConfigType {
|
|
124
124
|
}
|
|
125
125
|
/**
|
|
126
|
-
* <p>
|
|
127
|
-
* or a native application) to register with
|
|
128
|
-
* fetch the user’s access token upon successful authentication and
|
|
129
|
-
*
|
|
126
|
+
* <p>AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client
|
|
127
|
+
* (such as AWS CLI or a native application) to register with AWS SSO. The service also
|
|
128
|
+
* enables the client to fetch the user’s access token upon successful authentication and
|
|
129
|
+
* authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of
|
|
130
|
+
* the device authorization grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>).</p>
|
|
131
|
+
*
|
|
132
|
+
* <p>For general information about AWS SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is AWS
|
|
133
|
+
* Single Sign-On?</a> in the <i>AWS SSO User Guide</i>.</p>
|
|
134
|
+
*
|
|
135
|
+
* <p>This API reference guide describes the AWS SSO OIDC operations that you can call
|
|
136
|
+
* programatically and includes detailed information on data types and errors.</p>
|
|
137
|
+
*
|
|
130
138
|
* <note>
|
|
131
|
-
* <p>
|
|
132
|
-
*
|
|
133
|
-
*
|
|
139
|
+
* <p>AWS provides SDKs that consist of libraries and sample code for various programming
|
|
140
|
+
* languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a
|
|
141
|
+
* convenient way to create programmatic access to AWS SSO and other AWS services. For more
|
|
142
|
+
* information about the AWS SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p>
|
|
134
143
|
* </note>
|
|
135
|
-
* <p>
|
|
136
|
-
* <b>Considerations for Using This Guide</b>
|
|
137
|
-
* </p>
|
|
138
|
-
* <p>Before you begin using this guide, we recommend that you first review the following
|
|
139
|
-
* important information about how the Amazon Web Services SSO OIDC service works.</p>
|
|
140
|
-
* <ul>
|
|
141
|
-
* <li>
|
|
142
|
-
* <p>The Amazon Web Services SSO OIDC service currently implements only the portions of the OAuth 2.0
|
|
143
|
-
* Device Authorization Grant standard (<a href="https://tools.ietf.org/html/rfc8628">https://tools.ietf.org/html/rfc8628</a>) that are necessary to enable single
|
|
144
|
-
* sign-on authentication with the AWS CLI. Support for other OIDC flows frequently needed
|
|
145
|
-
* for native applications, such as Authorization Code Flow (+ PKCE), will be addressed in
|
|
146
|
-
* future releases.</p>
|
|
147
|
-
* </li>
|
|
148
|
-
* <li>
|
|
149
|
-
* <p>The service emits only OIDC access tokens, such that obtaining a new token (For
|
|
150
|
-
* example, token refresh) requires explicit user re-authentication.</p>
|
|
151
|
-
* </li>
|
|
152
|
-
* <li>
|
|
153
|
-
* <p>The access tokens provided by this service grant access to all AWS account
|
|
154
|
-
* entitlements assigned to an Amazon Web Services SSO user, not just a particular application.</p>
|
|
155
|
-
* </li>
|
|
156
|
-
* <li>
|
|
157
|
-
* <p>The documentation in this guide does not describe the mechanism to convert the access
|
|
158
|
-
* token into AWS Auth (“sigv4”) credentials for use with IAM-protected AWS service
|
|
159
|
-
* endpoints. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html">GetRoleCredentials</a> in the <i>Amazon Web Services SSO Portal API Reference
|
|
160
|
-
* Guide</i>.</p>
|
|
161
|
-
* </li>
|
|
162
|
-
* </ul>
|
|
163
|
-
*
|
|
164
|
-
* <p>For general information about Amazon Web Services SSO, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is
|
|
165
|
-
* Amazon Web Services SSO?</a> in the <i>Amazon Web Services SSO User Guide</i>.</p>
|
|
166
144
|
*/
|
|
167
145
|
export declare class SSOOIDCClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, SSOOIDCClientResolvedConfig> {
|
|
168
146
|
/**
|
|
@@ -8,7 +8,7 @@ export interface CreateTokenCommandOutput extends CreateTokenResponse, __Metadat
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Creates and returns an access token for the authorized client. The access token issued
|
|
11
|
-
* will be used to fetch short-term credentials for the assigned roles in the
|
|
11
|
+
* will be used to fetch short-term credentials for the assigned roles in the AWS
|
|
12
12
|
* account.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,7 +7,7 @@ export interface RegisterClientCommandInput extends RegisterClientRequest {
|
|
|
7
7
|
export interface RegisterClientCommandOutput extends RegisterClientResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Registers a client with
|
|
10
|
+
* <p>Registers a client with AWS SSO. This allows clients to initiate device authorization.
|
|
11
11
|
* The output should be persisted for reuse through many authentication requests.</p>
|
|
12
12
|
* @example
|
|
13
13
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -7,8 +7,7 @@ export interface StartDeviceAuthorizationCommandInput extends StartDeviceAuthori
|
|
|
7
7
|
export interface StartDeviceAuthorizationCommandOutput extends StartDeviceAuthorizationResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Initiates device authorization by requesting a pair of verification codes from the
|
|
11
|
-
* authorization service.</p>
|
|
10
|
+
* <p>Initiates device authorization by requesting a pair of verification codes from the authorization service.</p>
|
|
12
11
|
* @example
|
|
13
12
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
13
|
* ```javascript
|
|
@@ -14,8 +14,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
14
14
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* <p>Indicates that a request to authorize a client with an access user session token is
|
|
18
|
-
* pending.</p>
|
|
17
|
+
* <p>Indicates that a request to authorize a client with an access user session token is pending.</p>
|
|
19
18
|
*/
|
|
20
19
|
export declare class AuthorizationPendingException extends __BaseException {
|
|
21
20
|
readonly name: "AuthorizationPendingException";
|
|
@@ -29,25 +28,15 @@ export declare class AuthorizationPendingException extends __BaseException {
|
|
|
29
28
|
}
|
|
30
29
|
export interface CreateTokenRequest {
|
|
31
30
|
/**
|
|
32
|
-
* <p>The unique identifier string for each client. This value should come from the persisted
|
|
33
|
-
* result of the <a>RegisterClient</a> API.</p>
|
|
31
|
+
* <p>The unique identifier string for each client. This value should come from the persisted result of the <a>RegisterClient</a> API.</p>
|
|
34
32
|
*/
|
|
35
33
|
clientId: string | undefined;
|
|
36
34
|
/**
|
|
37
|
-
* <p>A secret string generated for the client. This value should come from the persisted result
|
|
38
|
-
* of the <a>RegisterClient</a> API.</p>
|
|
35
|
+
* <p>A secret string generated for the client. This value should come from the persisted result of the <a>RegisterClient</a> API.</p>
|
|
39
36
|
*/
|
|
40
37
|
clientSecret: string | undefined;
|
|
41
38
|
/**
|
|
42
|
-
* <p>Supports grant types for
|
|
43
|
-
* For device code requests, specify the following value:</p>
|
|
44
|
-
*
|
|
45
|
-
* <p>
|
|
46
|
-
* <code>urn:ietf:params:oauth:grant-type:<i>device_code</i>
|
|
47
|
-
* </code>
|
|
48
|
-
* </p>
|
|
49
|
-
*
|
|
50
|
-
* <p>For information about how to obtain the device code, see the <a>StartDeviceAuthorization</a> topic.</p>
|
|
39
|
+
* <p>Supports grant types for authorization code, refresh token, and device code request.</p>
|
|
51
40
|
*/
|
|
52
41
|
grantType: string | undefined;
|
|
53
42
|
/**
|
|
@@ -55,19 +44,13 @@ export interface CreateTokenRequest {
|
|
|
55
44
|
* used to identify this authentication attempt. This should come from an in-memory reference to
|
|
56
45
|
* the result of the <a>StartDeviceAuthorization</a> API.</p>
|
|
57
46
|
*/
|
|
58
|
-
deviceCode
|
|
47
|
+
deviceCode?: string;
|
|
59
48
|
/**
|
|
60
|
-
* <p>The authorization code received from the authorization service. This parameter is required
|
|
61
|
-
* to perform an authorization grant request to get access to a token.</p>
|
|
49
|
+
* <p>The authorization code received from the authorization service. This parameter is required to perform an authorization grant request to get access to a token.</p>
|
|
62
50
|
*/
|
|
63
51
|
code?: string;
|
|
64
52
|
/**
|
|
65
|
-
* <p>
|
|
66
|
-
* information about the features and limitations of the current Amazon Web Services SSO OIDC implementation,
|
|
67
|
-
* see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">Amazon Web Services SSO
|
|
68
|
-
* OIDC API Reference</a>.</p>
|
|
69
|
-
* <p>The token used to obtain an access token in the event that the access token is invalid or
|
|
70
|
-
* expired.</p>
|
|
53
|
+
* <p>The token used to obtain an access token in the event that the access token is invalid or expired. This token is not issued by the service.</p>
|
|
71
54
|
*/
|
|
72
55
|
refreshToken?: string;
|
|
73
56
|
/**
|
|
@@ -83,7 +66,7 @@ export interface CreateTokenRequest {
|
|
|
83
66
|
}
|
|
84
67
|
export interface CreateTokenResponse {
|
|
85
68
|
/**
|
|
86
|
-
* <p>An opaque token to access
|
|
69
|
+
* <p>An opaque token to access AWS SSO resources assigned to a user.</p>
|
|
87
70
|
*/
|
|
88
71
|
accessToken?: string;
|
|
89
72
|
/**
|
|
@@ -96,20 +79,12 @@ export interface CreateTokenResponse {
|
|
|
96
79
|
*/
|
|
97
80
|
expiresIn?: number;
|
|
98
81
|
/**
|
|
99
|
-
* <p>
|
|
100
|
-
* information about the features and limitations of the current Amazon Web Services SSO OIDC implementation,
|
|
101
|
-
* see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">Amazon Web Services SSO
|
|
102
|
-
* OIDC API Reference</a>.</p>
|
|
103
|
-
* <p>A token that, if present, can be used to refresh a previously issued access token that
|
|
82
|
+
* <p>A token that, if present, can be used to refresh a previously issued access token that
|
|
104
83
|
* might have expired.</p>
|
|
105
84
|
*/
|
|
106
85
|
refreshToken?: string;
|
|
107
86
|
/**
|
|
108
|
-
* <p>
|
|
109
|
-
* information about the features and limitations of the current Amazon Web Services SSO OIDC implementation,
|
|
110
|
-
* see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">Amazon Web Services SSO
|
|
111
|
-
* OIDC API Reference</a>.</p>
|
|
112
|
-
* <p>The identifier of the user that associated with the access token, if present.</p>
|
|
87
|
+
* <p>The identifier of the user that associated with the access token, if present.</p>
|
|
113
88
|
*/
|
|
114
89
|
idToken?: string;
|
|
115
90
|
}
|
|
@@ -127,8 +102,7 @@ export declare class ExpiredTokenException extends __BaseException {
|
|
|
127
102
|
constructor(opts: __ExceptionOptionType<ExpiredTokenException, __BaseException>);
|
|
128
103
|
}
|
|
129
104
|
/**
|
|
130
|
-
* <p>Indicates that an error from the service occurred while trying to process a
|
|
131
|
-
* request.</p>
|
|
105
|
+
* <p>Indicates that an error from the service occurred while trying to process a request.</p>
|
|
132
106
|
*/
|
|
133
107
|
export declare class InternalServerException extends __BaseException {
|
|
134
108
|
readonly name: "InternalServerException";
|
|
@@ -156,8 +130,7 @@ export declare class InvalidClientException extends __BaseException {
|
|
|
156
130
|
constructor(opts: __ExceptionOptionType<InvalidClientException, __BaseException>);
|
|
157
131
|
}
|
|
158
132
|
/**
|
|
159
|
-
* <p>Indicates that a request contains an invalid grant. This can occur if a client makes a
|
|
160
|
-
* <a>CreateToken</a> request with an invalid grant type.</p>
|
|
133
|
+
* <p>Indicates that a request contains an invalid grant. This can occur if a client makes a <a>CreateToken</a> request with an invalid grant type.</p>
|
|
161
134
|
*/
|
|
162
135
|
export declare class InvalidGrantException extends __BaseException {
|
|
163
136
|
readonly name: "InvalidGrantException";
|
|
@@ -197,8 +170,7 @@ export declare class InvalidScopeException extends __BaseException {
|
|
|
197
170
|
constructor(opts: __ExceptionOptionType<InvalidScopeException, __BaseException>);
|
|
198
171
|
}
|
|
199
172
|
/**
|
|
200
|
-
* <p>Indicates that the client is making the request too frequently and is more than the
|
|
201
|
-
* service can handle. </p>
|
|
173
|
+
* <p>Indicates that the client is making the request too frequently and is more than the service can handle. </p>
|
|
202
174
|
*/
|
|
203
175
|
export declare class SlowDownException extends __BaseException {
|
|
204
176
|
readonly name: "SlowDownException";
|
|
@@ -238,8 +210,7 @@ export declare class UnsupportedGrantTypeException extends __BaseException {
|
|
|
238
210
|
constructor(opts: __ExceptionOptionType<UnsupportedGrantTypeException, __BaseException>);
|
|
239
211
|
}
|
|
240
212
|
/**
|
|
241
|
-
* <p>Indicates that the client information sent in the request during registration is
|
|
242
|
-
* invalid.</p>
|
|
213
|
+
* <p>Indicates that the client information sent in the request during registration is invalid.</p>
|
|
243
214
|
*/
|
|
244
215
|
export declare class InvalidClientMetadataException extends __BaseException {
|
|
245
216
|
readonly name: "InvalidClientMetadataException";
|
|
@@ -257,8 +228,7 @@ export interface RegisterClientRequest {
|
|
|
257
228
|
*/
|
|
258
229
|
clientName: string | undefined;
|
|
259
230
|
/**
|
|
260
|
-
* <p>The type of client. The service supports only <code>public</code> as a client type.
|
|
261
|
-
* Anything other than public will be rejected by the service.</p>
|
|
231
|
+
* <p>The type of client. The service supports only <code>public</code> as a client type. Anything other than public will be rejected by the service.</p>
|
|
262
232
|
*/
|
|
263
233
|
clientType: string | undefined;
|
|
264
234
|
/**
|
|
@@ -279,13 +249,11 @@ export interface RegisterClientResponse {
|
|
|
279
249
|
*/
|
|
280
250
|
clientSecret?: string;
|
|
281
251
|
/**
|
|
282
|
-
* <p>Indicates the time at which the <code>clientId</code> and <code>clientSecret</code> were
|
|
283
|
-
* issued.</p>
|
|
252
|
+
* <p>Indicates the time at which the <code>clientId</code> and <code>clientSecret</code> were issued.</p>
|
|
284
253
|
*/
|
|
285
254
|
clientIdIssuedAt?: number;
|
|
286
255
|
/**
|
|
287
|
-
* <p>Indicates the time at which the <code>clientId</code> and <code>clientSecret</code> will
|
|
288
|
-
* become invalid.</p>
|
|
256
|
+
* <p>Indicates the time at which the <code>clientId</code> and <code>clientSecret</code> will become invalid.</p>
|
|
289
257
|
*/
|
|
290
258
|
clientSecretExpiresAt?: number;
|
|
291
259
|
/**
|
|
@@ -299,7 +267,7 @@ export interface RegisterClientResponse {
|
|
|
299
267
|
}
|
|
300
268
|
export interface StartDeviceAuthorizationRequest {
|
|
301
269
|
/**
|
|
302
|
-
* <p>The unique identifier string for the client that is registered with
|
|
270
|
+
* <p>The unique identifier string for the client that is registered with AWS SSO. This value
|
|
303
271
|
* should come from the persisted result of the <a>RegisterClient</a> API
|
|
304
272
|
* operation.</p>
|
|
305
273
|
*/
|
|
@@ -310,8 +278,8 @@ export interface StartDeviceAuthorizationRequest {
|
|
|
310
278
|
*/
|
|
311
279
|
clientSecret: string | undefined;
|
|
312
280
|
/**
|
|
313
|
-
* <p>The URL for the AWS
|
|
314
|
-
*
|
|
281
|
+
* <p>The URL for the AWS SSO user portal. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html">Using
|
|
282
|
+
* the User Portal</a> in the <i>AWS Single Sign-On User Guide</i>.</p>
|
|
315
283
|
*/
|
|
316
284
|
startUrl: string | undefined;
|
|
317
285
|
}
|
|
@@ -325,8 +293,7 @@ export interface StartDeviceAuthorizationResponse {
|
|
|
325
293
|
*/
|
|
326
294
|
userCode?: string;
|
|
327
295
|
/**
|
|
328
|
-
* <p>The URI of the verification page that takes the <code>userCode</code> to authorize the
|
|
329
|
-
* device.</p>
|
|
296
|
+
* <p>The URI of the verification page that takes the <code>userCode</code> to authorize the device.</p>
|
|
330
297
|
*/
|
|
331
298
|
verificationUri?: string;
|
|
332
299
|
/**
|
|
@@ -340,8 +307,7 @@ export interface StartDeviceAuthorizationResponse {
|
|
|
340
307
|
*/
|
|
341
308
|
expiresIn?: number;
|
|
342
309
|
/**
|
|
343
|
-
* <p>Indicates the number of seconds the client must wait between attempts when polling for a
|
|
344
|
-
* session.</p>
|
|
310
|
+
* <p>Indicates the number of seconds the client must wait between attempts when polling for a session.</p>
|
|
345
311
|
*/
|
|
346
312
|
interval?: number;
|
|
347
313
|
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-sso-oidc",
|
|
3
3
|
"description": "AWS SDK for JavaScript Sso Oidc Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.159.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -18,32 +18,32 @@
|
|
|
18
18
|
"dependencies": {
|
|
19
19
|
"@aws-crypto/sha256-browser": "2.0.0",
|
|
20
20
|
"@aws-crypto/sha256-js": "2.0.0",
|
|
21
|
-
"@aws-sdk/config-resolver": "3.
|
|
22
|
-
"@aws-sdk/fetch-http-handler": "3.
|
|
23
|
-
"@aws-sdk/hash-node": "3.
|
|
24
|
-
"@aws-sdk/invalid-dependency": "3.
|
|
25
|
-
"@aws-sdk/middleware-content-length": "3.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
27
|
-
"@aws-sdk/middleware-logger": "3.
|
|
28
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
29
|
-
"@aws-sdk/middleware-retry": "3.
|
|
30
|
-
"@aws-sdk/middleware-serde": "3.
|
|
31
|
-
"@aws-sdk/middleware-stack": "3.
|
|
32
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
33
|
-
"@aws-sdk/node-config-provider": "3.
|
|
34
|
-
"@aws-sdk/node-http-handler": "3.
|
|
35
|
-
"@aws-sdk/protocol-http": "3.
|
|
36
|
-
"@aws-sdk/smithy-client": "3.
|
|
37
|
-
"@aws-sdk/types": "3.
|
|
38
|
-
"@aws-sdk/url-parser": "3.
|
|
21
|
+
"@aws-sdk/config-resolver": "3.159.0",
|
|
22
|
+
"@aws-sdk/fetch-http-handler": "3.159.0",
|
|
23
|
+
"@aws-sdk/hash-node": "3.159.0",
|
|
24
|
+
"@aws-sdk/invalid-dependency": "3.159.0",
|
|
25
|
+
"@aws-sdk/middleware-content-length": "3.159.0",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "3.159.0",
|
|
27
|
+
"@aws-sdk/middleware-logger": "3.159.0",
|
|
28
|
+
"@aws-sdk/middleware-recursion-detection": "3.159.0",
|
|
29
|
+
"@aws-sdk/middleware-retry": "3.159.0",
|
|
30
|
+
"@aws-sdk/middleware-serde": "3.159.0",
|
|
31
|
+
"@aws-sdk/middleware-stack": "3.159.0",
|
|
32
|
+
"@aws-sdk/middleware-user-agent": "3.159.0",
|
|
33
|
+
"@aws-sdk/node-config-provider": "3.159.0",
|
|
34
|
+
"@aws-sdk/node-http-handler": "3.159.0",
|
|
35
|
+
"@aws-sdk/protocol-http": "3.159.0",
|
|
36
|
+
"@aws-sdk/smithy-client": "3.159.0",
|
|
37
|
+
"@aws-sdk/types": "3.159.0",
|
|
38
|
+
"@aws-sdk/url-parser": "3.159.0",
|
|
39
39
|
"@aws-sdk/util-base64-browser": "3.109.0",
|
|
40
40
|
"@aws-sdk/util-base64-node": "3.55.0",
|
|
41
|
-
"@aws-sdk/util-body-length-browser": "3.
|
|
41
|
+
"@aws-sdk/util-body-length-browser": "3.154.0",
|
|
42
42
|
"@aws-sdk/util-body-length-node": "3.55.0",
|
|
43
|
-
"@aws-sdk/util-defaults-mode-browser": "3.
|
|
44
|
-
"@aws-sdk/util-defaults-mode-node": "3.
|
|
45
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
46
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
43
|
+
"@aws-sdk/util-defaults-mode-browser": "3.159.0",
|
|
44
|
+
"@aws-sdk/util-defaults-mode-node": "3.159.0",
|
|
45
|
+
"@aws-sdk/util-user-agent-browser": "3.159.0",
|
|
46
|
+
"@aws-sdk/util-user-agent-node": "3.159.0",
|
|
47
47
|
"@aws-sdk/util-utf8-browser": "3.109.0",
|
|
48
48
|
"@aws-sdk/util-utf8-node": "3.109.0",
|
|
49
49
|
"tslib": "^2.3.1"
|