@aws-sdk/client-sso-oidc 3.142.0 → 3.145.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 CHANGED
@@ -3,6 +3,14 @@
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.145.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.144.0...v3.145.0) (2022-08-08)
7
+
8
+ **Note:** Version bump only for package @aws-sdk/client-sso-oidc
9
+
10
+
11
+
12
+
13
+
6
14
  # [3.142.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.141.0...v3.142.0) (2022-08-02)
7
15
 
8
16
 
package/README.md CHANGED
@@ -9,24 +9,46 @@
9
9
 
10
10
  AWS SDK for JavaScript SSOOIDC Client for Node.js, Browser and React Native.
11
11
 
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
-
12
+ <p>Amazon Web Services Single Sign On OpenID Connect (OIDC) is a web service that enables a client (such as Amazon Web Services CLI
13
+ or a native application) to register with Amazon Web Services SSO. The service also enables the client to
14
+ fetch the user’s access token upon successful authentication and authorization with
15
+ Amazon Web Services SSO.</p>
24
16
  <note>
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>
17
+ <p>Although Amazon Web Services Single Sign-On was renamed, the <code>sso</code> and
18
+ <code>identitystore</code> API namespaces will continue to retain their original name for
19
+ backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">Amazon Web Services SSO rename</a>.</p>
29
20
  </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>
30
52
 
31
53
  ## Installing
32
54
 
@@ -4,43 +4,66 @@ import { RegisterClientCommandInput, RegisterClientCommandOutput } from "./comma
4
4
  import { StartDeviceAuthorizationCommandInput, StartDeviceAuthorizationCommandOutput } from "./commands/StartDeviceAuthorizationCommand";
5
5
  import { SSOOIDCClient } from "./SSOOIDCClient";
6
6
  /**
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
- *
7
+ * <p>Amazon Web Services Single Sign On OpenID Connect (OIDC) is a web service that enables a client (such as Amazon Web Services CLI
8
+ * or a native application) to register with Amazon Web Services SSO. The service also enables the client to
9
+ * fetch the user’s access token upon successful authentication and authorization with
10
+ * Amazon Web Services SSO.</p>
19
11
  * <note>
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>
12
+ * <p>Although Amazon Web Services Single Sign-On was renamed, the <code>sso</code> and
13
+ * <code>identitystore</code> API namespaces will continue to retain their original name for
14
+ * backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">Amazon Web Services SSO rename</a>.</p>
24
15
  * </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>
25
47
  */
26
48
  export declare class SSOOIDC extends SSOOIDCClient {
27
49
  /**
28
50
  * <p>Creates and returns an access token for the authorized client. The access token issued
29
- * will be used to fetch short-term credentials for the assigned roles in the AWS
51
+ * will be used to fetch short-term credentials for the assigned roles in the Amazon Web Services
30
52
  * account.</p>
31
53
  */
32
54
  createToken(args: CreateTokenCommandInput, options?: __HttpHandlerOptions): Promise<CreateTokenCommandOutput>;
33
55
  createToken(args: CreateTokenCommandInput, cb: (err: any, data?: CreateTokenCommandOutput) => void): void;
34
56
  createToken(args: CreateTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateTokenCommandOutput) => void): void;
35
57
  /**
36
- * <p>Registers a client with AWS SSO. This allows clients to initiate device authorization.
58
+ * <p>Registers a client with Amazon Web Services SSO. This allows clients to initiate device authorization.
37
59
  * The output should be persisted for reuse through many authentication requests.</p>
38
60
  */
39
61
  registerClient(args: RegisterClientCommandInput, options?: __HttpHandlerOptions): Promise<RegisterClientCommandOutput>;
40
62
  registerClient(args: RegisterClientCommandInput, cb: (err: any, data?: RegisterClientCommandOutput) => void): void;
41
63
  registerClient(args: RegisterClientCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterClientCommandOutput) => void): void;
42
64
  /**
43
- * <p>Initiates device authorization by requesting a pair of verification codes from the authorization service.</p>
65
+ * <p>Initiates device authorization by requesting a pair of verification codes from the
66
+ * authorization service.</p>
44
67
  */
45
68
  startDeviceAuthorization(args: StartDeviceAuthorizationCommandInput, options?: __HttpHandlerOptions): Promise<StartDeviceAuthorizationCommandOutput>;
46
69
  startDeviceAuthorization(args: StartDeviceAuthorizationCommandInput, cb: (err: any, data?: StartDeviceAuthorizationCommandOutput) => void): void;
@@ -123,24 +123,46 @@ declare type SSOOIDCClientResolvedConfigType = __SmithyResolvedConfiguration<__H
123
123
  export interface SSOOIDCClientResolvedConfig extends SSOOIDCClientResolvedConfigType {
124
124
  }
125
125
  /**
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
- *
126
+ * <p>Amazon Web Services Single Sign On OpenID Connect (OIDC) is a web service that enables a client (such as Amazon Web Services CLI
127
+ * or a native application) to register with Amazon Web Services SSO. The service also enables the client to
128
+ * fetch the user’s access token upon successful authentication and authorization with
129
+ * Amazon Web Services SSO.</p>
138
130
  * <note>
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>
131
+ * <p>Although Amazon Web Services Single Sign-On was renamed, the <code>sso</code> and
132
+ * <code>identitystore</code> API namespaces will continue to retain their original name for
133
+ * backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">Amazon Web Services SSO rename</a>.</p>
143
134
  * </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>
144
166
  */
145
167
  export declare class SSOOIDCClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, SSOOIDCClientResolvedConfig> {
146
168
  /**
@@ -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 AWS
11
+ * will be used to fetch short-term credentials for the assigned roles in the Amazon Web Services
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 AWS SSO. This allows clients to initiate device authorization.
10
+ * <p>Registers a client with Amazon Web Services 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,7 +7,8 @@ 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 authorization service.</p>
10
+ * <p>Initiates device authorization by requesting a pair of verification codes from the
11
+ * authorization service.</p>
11
12
  * @example
12
13
  * Use a bare-bones client and the command you need to make an API call.
13
14
  * ```javascript
@@ -14,7 +14,8 @@ 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 pending.</p>
17
+ * <p>Indicates that a request to authorize a client with an access user session token is
18
+ * pending.</p>
18
19
  */
19
20
  export declare class AuthorizationPendingException extends __BaseException {
20
21
  readonly name: "AuthorizationPendingException";
@@ -28,15 +29,25 @@ export declare class AuthorizationPendingException extends __BaseException {
28
29
  }
29
30
  export interface CreateTokenRequest {
30
31
  /**
31
- * <p>The unique identifier string for each client. This value should come from the persisted result of the <a>RegisterClient</a> API.</p>
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>
32
34
  */
33
35
  clientId: string | undefined;
34
36
  /**
35
- * <p>A secret string generated for the client. This value should come from the persisted result of the <a>RegisterClient</a> API.</p>
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>
36
39
  */
37
40
  clientSecret: string | undefined;
38
41
  /**
39
- * <p>Supports grant types for authorization code, refresh token, and device code request.</p>
42
+ * <p>Supports grant types for the authorization code, refresh token, and device code request.
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>
40
51
  */
41
52
  grantType: string | undefined;
42
53
  /**
@@ -46,11 +57,17 @@ export interface CreateTokenRequest {
46
57
  */
47
58
  deviceCode: string | undefined;
48
59
  /**
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>
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>
50
62
  */
51
63
  code?: string;
52
64
  /**
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>
65
+ * <p>Currently, <code>refreshToken</code> is not yet implemented and is not supported. For more
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>
54
71
  */
55
72
  refreshToken?: string;
56
73
  /**
@@ -66,7 +83,7 @@ export interface CreateTokenRequest {
66
83
  }
67
84
  export interface CreateTokenResponse {
68
85
  /**
69
- * <p>An opaque token to access AWS SSO resources assigned to a user.</p>
86
+ * <p>An opaque token to access Amazon Web Services SSO resources assigned to a user.</p>
70
87
  */
71
88
  accessToken?: string;
72
89
  /**
@@ -79,12 +96,20 @@ export interface CreateTokenResponse {
79
96
  */
80
97
  expiresIn?: number;
81
98
  /**
82
- * <p>A token that, if present, can be used to refresh a previously issued access token that
99
+ * <p>Currently, <code>refreshToken</code> is not yet implemented and is not supported. For more
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
83
104
  * might have expired.</p>
84
105
  */
85
106
  refreshToken?: string;
86
107
  /**
87
- * <p>The identifier of the user that associated with the access token, if present.</p>
108
+ * <p>Currently, <code>idToken</code> is not yet implemented and is not supported. For more
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>
88
113
  */
89
114
  idToken?: string;
90
115
  }
@@ -102,7 +127,8 @@ export declare class ExpiredTokenException extends __BaseException {
102
127
  constructor(opts: __ExceptionOptionType<ExpiredTokenException, __BaseException>);
103
128
  }
104
129
  /**
105
- * <p>Indicates that an error from the service occurred while trying to process a request.</p>
130
+ * <p>Indicates that an error from the service occurred while trying to process a
131
+ * request.</p>
106
132
  */
107
133
  export declare class InternalServerException extends __BaseException {
108
134
  readonly name: "InternalServerException";
@@ -130,7 +156,8 @@ export declare class InvalidClientException extends __BaseException {
130
156
  constructor(opts: __ExceptionOptionType<InvalidClientException, __BaseException>);
131
157
  }
132
158
  /**
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>
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>
134
161
  */
135
162
  export declare class InvalidGrantException extends __BaseException {
136
163
  readonly name: "InvalidGrantException";
@@ -170,7 +197,8 @@ export declare class InvalidScopeException extends __BaseException {
170
197
  constructor(opts: __ExceptionOptionType<InvalidScopeException, __BaseException>);
171
198
  }
172
199
  /**
173
- * <p>Indicates that the client is making the request too frequently and is more than the service can handle. </p>
200
+ * <p>Indicates that the client is making the request too frequently and is more than the
201
+ * service can handle. </p>
174
202
  */
175
203
  export declare class SlowDownException extends __BaseException {
176
204
  readonly name: "SlowDownException";
@@ -210,7 +238,8 @@ export declare class UnsupportedGrantTypeException extends __BaseException {
210
238
  constructor(opts: __ExceptionOptionType<UnsupportedGrantTypeException, __BaseException>);
211
239
  }
212
240
  /**
213
- * <p>Indicates that the client information sent in the request during registration is invalid.</p>
241
+ * <p>Indicates that the client information sent in the request during registration is
242
+ * invalid.</p>
214
243
  */
215
244
  export declare class InvalidClientMetadataException extends __BaseException {
216
245
  readonly name: "InvalidClientMetadataException";
@@ -228,7 +257,8 @@ export interface RegisterClientRequest {
228
257
  */
229
258
  clientName: string | undefined;
230
259
  /**
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>
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>
232
262
  */
233
263
  clientType: string | undefined;
234
264
  /**
@@ -249,11 +279,13 @@ export interface RegisterClientResponse {
249
279
  */
250
280
  clientSecret?: string;
251
281
  /**
252
- * <p>Indicates the time at which the <code>clientId</code> and <code>clientSecret</code> were issued.</p>
282
+ * <p>Indicates the time at which the <code>clientId</code> and <code>clientSecret</code> were
283
+ * issued.</p>
253
284
  */
254
285
  clientIdIssuedAt?: number;
255
286
  /**
256
- * <p>Indicates the time at which the <code>clientId</code> and <code>clientSecret</code> will become invalid.</p>
287
+ * <p>Indicates the time at which the <code>clientId</code> and <code>clientSecret</code> will
288
+ * become invalid.</p>
257
289
  */
258
290
  clientSecretExpiresAt?: number;
259
291
  /**
@@ -267,7 +299,7 @@ export interface RegisterClientResponse {
267
299
  }
268
300
  export interface StartDeviceAuthorizationRequest {
269
301
  /**
270
- * <p>The unique identifier string for the client that is registered with AWS SSO. This value
302
+ * <p>The unique identifier string for the client that is registered with Amazon Web Services SSO. This value
271
303
  * should come from the persisted result of the <a>RegisterClient</a> API
272
304
  * operation.</p>
273
305
  */
@@ -278,8 +310,8 @@ export interface StartDeviceAuthorizationRequest {
278
310
  */
279
311
  clientSecret: string | undefined;
280
312
  /**
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>
313
+ * <p>The URL for the AWS access portal. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html">Using
314
+ * the AWS access portal</a> in the <i>Amazon Web Services SSO User Guide</i>.</p>
283
315
  */
284
316
  startUrl: string | undefined;
285
317
  }
@@ -293,7 +325,8 @@ export interface StartDeviceAuthorizationResponse {
293
325
  */
294
326
  userCode?: string;
295
327
  /**
296
- * <p>The URI of the verification page that takes the <code>userCode</code> to authorize the device.</p>
328
+ * <p>The URI of the verification page that takes the <code>userCode</code> to authorize the
329
+ * device.</p>
297
330
  */
298
331
  verificationUri?: string;
299
332
  /**
@@ -307,7 +340,8 @@ export interface StartDeviceAuthorizationResponse {
307
340
  */
308
341
  expiresIn?: number;
309
342
  /**
310
- * <p>Indicates the number of seconds the client must wait between attempts when polling for a session.</p>
343
+ * <p>Indicates the number of seconds the client must wait between attempts when polling for a
344
+ * session.</p>
311
345
  */
312
346
  interval?: number;
313
347
  }
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.142.0",
4
+ "version": "3.145.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",
@@ -58,6 +58,11 @@
58
58
  "typedoc": "0.19.2",
59
59
  "typescript": "~4.6.2"
60
60
  },
61
+ "overrides": {
62
+ "typedoc": {
63
+ "typescript": "~4.6.2"
64
+ }
65
+ },
61
66
  "engines": {
62
67
  "node": ">=12.0.0"
63
68
  },