Skip to content

Commit 90f84e0

Browse files
author
awstools
committed
docs(client-sso-oidc): Fixed typos in the descriptions.
1 parent d4cfdc2 commit 90f84e0

File tree

9 files changed

+232
-227
lines changed

9 files changed

+232
-227
lines changed

clients/client-sso-oidc/README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,16 @@
66

77
AWS SDK for JavaScript SSOOIDC Client for Node.js, Browser and React Native.
88

9-
<p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI
10-
or a native application) to register with IAM Identity Center. The service also enables the client to
11-
fetch the user’s access token upon successful authentication and authorization with
12-
IAM Identity Center.</p>
13-
<note>
14-
<p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p>
15-
</note>
9+
<p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a
10+
native application) to register with IAM Identity Center. The service also enables the client to fetch the
11+
user’s access token upon successful authentication and authorization with IAM Identity Center.</p>
1612
<p>
17-
<b>Considerations for Using This Guide</b>
13+
<b>API namespaces</b>
14+
</p>
15+
<p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces. IAM Identity Center
16+
OpenID Connect uses the <code>sso-oidc</code> namespace.</p>
17+
<p>
18+
<b>Considerations for using this guide</b>
1819
</p>
1920
<p>Before you begin using this guide, we recommend that you first review the following
2021
important information about how the IAM Identity Center OIDC service works.</p>
@@ -28,8 +29,8 @@ sign-on authentication with the CLI. </p>
2829
<p>With older versions of the CLI, the service only emits OIDC access tokens, so to
2930
obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that
3031
supports token refresh and doesn’t require re-authentication, update to the latest CLI
31-
version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh and
32-
configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </p>
32+
version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh
33+
and configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </p>
3334
</li>
3435
<li>
3536
<p>The access tokens provided by this service grant access to all Amazon Web Services account

clients/client-sso-oidc/src/SSOOIDC.ts

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -89,15 +89,16 @@ export interface SSOOIDC {
8989
}
9090

9191
/**
92-
* <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI
93-
* or a native application) to register with IAM Identity Center. The service also enables the client to
94-
* fetch the user’s access token upon successful authentication and authorization with
95-
* IAM Identity Center.</p>
96-
* <note>
97-
* <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p>
98-
* </note>
92+
* <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a
93+
* native application) to register with IAM Identity Center. The service also enables the client to fetch the
94+
* user’s access token upon successful authentication and authorization with IAM Identity Center.</p>
9995
* <p>
100-
* <b>Considerations for Using This Guide</b>
96+
* <b>API namespaces</b>
97+
* </p>
98+
* <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces. IAM Identity Center
99+
* OpenID Connect uses the <code>sso-oidc</code> namespace.</p>
100+
* <p>
101+
* <b>Considerations for using this guide</b>
101102
* </p>
102103
* <p>Before you begin using this guide, we recommend that you first review the following
103104
* important information about how the IAM Identity Center OIDC service works.</p>
@@ -111,8 +112,8 @@ export interface SSOOIDC {
111112
* <p>With older versions of the CLI, the service only emits OIDC access tokens, so to
112113
* obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that
113114
* supports token refresh and doesn’t require re-authentication, update to the latest CLI
114-
* version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh and
115-
* configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </p>
115+
* version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh
116+
* and configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </p>
116117
* </li>
117118
* <li>
118119
* <p>The access tokens provided by this service grant access to all Amazon Web Services account
@@ -122,7 +123,7 @@ export interface SSOOIDC {
122123
* <p>The documentation in this guide does not describe the mechanism to convert the access
123124
* token into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service
124125
* endpoints. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html">GetRoleCredentials</a> in the <i>IAM Identity Center Portal API Reference
125-
* Guide</i>.</p>
126+
* Guide</i>.</p>
126127
* </li>
127128
* </ul>
128129
* <p>For general information about IAM Identity Center, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is

clients/client-sso-oidc/src/SSOOIDCClient.ts

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -280,15 +280,16 @@ export type SSOOIDCClientResolvedConfigType = __SmithyResolvedConfiguration<__Ht
280280
export interface SSOOIDCClientResolvedConfig extends SSOOIDCClientResolvedConfigType {}
281281

282282
/**
283-
* <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI
284-
* or a native application) to register with IAM Identity Center. The service also enables the client to
285-
* fetch the user’s access token upon successful authentication and authorization with
286-
* IAM Identity Center.</p>
287-
* <note>
288-
* <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p>
289-
* </note>
283+
* <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a
284+
* native application) to register with IAM Identity Center. The service also enables the client to fetch the
285+
* user’s access token upon successful authentication and authorization with IAM Identity Center.</p>
290286
* <p>
291-
* <b>Considerations for Using This Guide</b>
287+
* <b>API namespaces</b>
288+
* </p>
289+
* <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces. IAM Identity Center
290+
* OpenID Connect uses the <code>sso-oidc</code> namespace.</p>
291+
* <p>
292+
* <b>Considerations for using this guide</b>
292293
* </p>
293294
* <p>Before you begin using this guide, we recommend that you first review the following
294295
* important information about how the IAM Identity Center OIDC service works.</p>
@@ -302,8 +303,8 @@ export interface SSOOIDCClientResolvedConfig extends SSOOIDCClientResolvedConfig
302303
* <p>With older versions of the CLI, the service only emits OIDC access tokens, so to
303304
* obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that
304305
* supports token refresh and doesn’t require re-authentication, update to the latest CLI
305-
* version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh and
306-
* configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </p>
306+
* version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh
307+
* and configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </p>
307308
* </li>
308309
* <li>
309310
* <p>The access tokens provided by this service grant access to all Amazon Web Services account
@@ -313,7 +314,7 @@ export interface SSOOIDCClientResolvedConfig extends SSOOIDCClientResolvedConfig
313314
* <p>The documentation in this guide does not describe the mechanism to convert the access
314315
* token into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service
315316
* endpoints. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html">GetRoleCredentials</a> in the <i>IAM Identity Center Portal API Reference
316-
* Guide</i>.</p>
317+
* Guide</i>.</p>
317318
* </li>
318319
* </ul>
319320
* <p>For general information about IAM Identity Center, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is

clients/client-sso-oidc/src/commands/CreateTokenCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export interface CreateTokenCommandOutput extends CreateTokenResponse, __Metadat
3434

3535
/**
3636
* <p>Creates and returns access and refresh tokens for clients that are authenticated using
37-
* client secrets. The access token can be used to fetch short-term credentials for the assigned
37+
* client secrets. The access token can be used to fetch short-lived credentials for the assigned
3838
* AWS accounts or to access application APIs using <code>bearer</code> authentication.</p>
3939
* @example
4040
* Use a bare-bones client and the command you need to make an API call.

clients/client-sso-oidc/src/commands/CreateTokenWithIAMCommand.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ export interface CreateTokenWithIAMCommandOutput extends CreateTokenWithIAMRespo
3434

3535
/**
3636
* <p>Creates and returns access and refresh tokens for clients and applications that are
37-
* authenticated using IAM entities. The access token can be used to fetch short-term credentials
38-
* for the assigned Amazon Web Services accounts or to access application APIs using <code>bearer</code>
39-
* authentication.</p>
37+
* authenticated using IAM entities. The access token can be used to fetch short-lived
38+
* credentials for the assigned Amazon Web Services accounts or to access application APIs using
39+
* <code>bearer</code> authentication.</p>
4040
* @example
4141
* Use a bare-bones client and the command you need to make an API call.
4242
* ```javascript

clients/client-sso-oidc/src/commands/RegisterClientCommand.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,9 @@ export interface RegisterClientCommandInput extends RegisterClientRequest {}
3232
export interface RegisterClientCommandOutput extends RegisterClientResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Registers a client with IAM Identity Center. This allows clients to initiate device authorization.
36-
* The output should be persisted for reuse through many authentication requests.</p>
35+
* <p>Registers a public client with IAM Identity Center. This allows clients to perform authorization using
36+
* the authorization code grant with Proof Key for Code Exchange (PKCE) or the device
37+
* code grant.</p>
3738
* @example
3839
* Use a bare-bones client and the command you need to make an API call.
3940
* ```javascript
@@ -83,7 +84,8 @@ export interface RegisterClientCommandOutput extends RegisterClientResponse, __M
8384
* invalid.</p>
8485
*
8586
* @throws {@link InvalidRedirectUriException} (client fault)
86-
* <p>Indicates that one or more redirect URI in the request is not supported for this operation.</p>
87+
* <p>Indicates that one or more redirect URI in the request is not supported for this
88+
* operation.</p>
8789
*
8890
* @throws {@link InvalidRequestException} (client fault)
8991
* <p>Indicates that something is wrong with the input to the request. For example, a required

clients/client-sso-oidc/src/index.ts

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
// smithy-typescript generated code
22
/* eslint-disable */
33
/**
4-
* <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI
5-
* or a native application) to register with IAM Identity Center. The service also enables the client to
6-
* fetch the user’s access token upon successful authentication and authorization with
7-
* IAM Identity Center.</p>
8-
* <note>
9-
* <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p>
10-
* </note>
4+
* <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a
5+
* native application) to register with IAM Identity Center. The service also enables the client to fetch the
6+
* user’s access token upon successful authentication and authorization with IAM Identity Center.</p>
117
* <p>
12-
* <b>Considerations for Using This Guide</b>
8+
* <b>API namespaces</b>
9+
* </p>
10+
* <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces. IAM Identity Center
11+
* OpenID Connect uses the <code>sso-oidc</code> namespace.</p>
12+
* <p>
13+
* <b>Considerations for using this guide</b>
1314
* </p>
1415
* <p>Before you begin using this guide, we recommend that you first review the following
1516
* important information about how the IAM Identity Center OIDC service works.</p>
@@ -23,8 +24,8 @@
2324
* <p>With older versions of the CLI, the service only emits OIDC access tokens, so to
2425
* obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that
2526
* supports token refresh and doesn’t require re-authentication, update to the latest CLI
26-
* version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh and
27-
* configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </p>
27+
* version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh
28+
* and configurable IAM Identity Center session durations. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html">Configure Amazon Web Services access portal session duration </a>. </p>
2829
* </li>
2930
* <li>
3031
* <p>The access tokens provided by this service grant access to all Amazon Web Services account
@@ -34,7 +35,7 @@
3435
* <p>The documentation in this guide does not describe the mechanism to convert the access
3536
* token into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service
3637
* endpoints. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html">GetRoleCredentials</a> in the <i>IAM Identity Center Portal API Reference
37-
* Guide</i>.</p>
38+
* Guide</i>.</p>
3839
* </li>
3940
* </ul>
4041
* <p>For general information about IAM Identity Center, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">What is

0 commit comments

Comments
 (0)