New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
@aws-sdk/client-sso-oidc
Advanced tools
@aws-sdk/client-sso-oidc - npm Package Compare versions
Comparing version 3.734.0 to 3.735.0
@@ -231,4 +231,3 @@ "use strict"; | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>access_denied</code>.</p> | ||
| * <p>Single error code. For this exception the value will be <code>access_denied</code>.</p> | ||
| * @public | ||
@@ -238,4 +237,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -265,4 +264,4 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>authorization_pending</code>.</p> | ||
| * <p>Single error code. For this exception the value will be | ||
| * <code>authorization_pending</code>.</p> | ||
| * @public | ||
@@ -272,4 +271,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -299,4 +298,3 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>expired_token</code>.</p> | ||
| * <p>Single error code. For this exception the value will be <code>expired_token</code>.</p> | ||
| * @public | ||
@@ -306,4 +304,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -333,4 +331,3 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>server_error</code>.</p> | ||
| * <p>Single error code. For this exception the value will be <code>server_error</code>.</p> | ||
| * @public | ||
@@ -340,4 +337,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -367,4 +364,4 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>invalid_client</code>.</p> | ||
| * <p>Single error code. For this exception the value will be | ||
| * <code>invalid_client</code>.</p> | ||
| * @public | ||
@@ -374,4 +371,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -401,4 +398,3 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>invalid_grant</code>.</p> | ||
| * <p>Single error code. For this exception the value will be <code>invalid_grant</code>.</p> | ||
| * @public | ||
@@ -408,4 +404,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -435,4 +431,4 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>invalid_request</code>.</p> | ||
| * <p>Single error code. For this exception the value will be | ||
| * <code>invalid_request</code>.</p> | ||
| * @public | ||
@@ -442,4 +438,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -469,4 +465,3 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>invalid_scope</code>.</p> | ||
| * <p>Single error code. For this exception the value will be <code>invalid_scope</code>.</p> | ||
| * @public | ||
@@ -476,4 +471,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -503,4 +498,3 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>slow_down</code>.</p> | ||
| * <p>Single error code. For this exception the value will be <code>slow_down</code>.</p> | ||
| * @public | ||
@@ -510,4 +504,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -537,4 +531,4 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>unauthorized_client</code>.</p> | ||
| * <p>Single error code. For this exception the value will be | ||
| * <code>unauthorized_client</code>.</p> | ||
| * @public | ||
@@ -544,4 +538,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -571,4 +565,4 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>unsupported_grant_type</code>.</p> | ||
| * <p>Single error code. For this exception the value will be | ||
| * <code>unsupported_grant_type</code>.</p> | ||
| * @public | ||
@@ -578,4 +572,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -605,4 +599,4 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>invalid_request</code>.</p> | ||
| * <p>Single error code. For this exception the value will be | ||
| * <code>invalid_request</code>.</p> | ||
| * @public | ||
@@ -612,4 +606,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -651,4 +645,4 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>invalid_client_metadata</code>.</p> | ||
| * <p>Single error code. For this exception the value will be | ||
| * <code>invalid_client_metadata</code>.</p> | ||
| * @public | ||
@@ -658,4 +652,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -685,4 +679,4 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>invalid_redirect_uri</code>.</p> | ||
| * <p>Single error code. For this exception the value will be | ||
| * <code>invalid_redirect_uri</code>.</p> | ||
| * @public | ||
@@ -692,4 +686,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -696,0 +690,0 @@ */ |
@@ -31,3 +31,3 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * <p>Creates and returns access and refresh tokens for clients that are authenticated using | ||
| * client secrets. The access token can be used to fetch short-term credentials for the assigned | ||
| * client secrets. The access token can be used to fetch short-lived credentials for the assigned | ||
| * AWS accounts or to access application APIs using <code>bearer</code> authentication.</p> | ||
@@ -34,0 +34,0 @@ * @example |
@@ -31,5 +31,5 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| * <p>Creates and returns access and refresh tokens for clients and applications that are | ||
| * authenticated using IAM entities. The access token can be used to fetch short-term credentials | ||
| * for the assigned Amazon Web Services accounts or to access application APIs using <code>bearer</code> | ||
| * authentication.</p> | ||
| * authenticated using IAM entities. The access token can be used to fetch short-lived | ||
| * credentials for the assigned Amazon Web Services accounts or to access application APIs using | ||
| * <code>bearer</code> authentication.</p> | ||
| * @example | ||
@@ -36,0 +36,0 @@ * Use a bare-bones client and the command you need to make an API call. |
@@ -30,4 +30,5 @@ import { Command as $Command } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Registers a client with IAM Identity Center. This allows clients to initiate device authorization. | ||
| * The output should be persisted for reuse through many authentication requests.</p> | ||
| * <p>Registers a public client with IAM Identity Center. This allows clients to perform authorization using | ||
| * the authorization code grant with Proof Key for Code Exchange (PKCE) or the device | ||
| * code grant.</p> | ||
| * @example | ||
@@ -82,3 +83,4 @@ * Use a bare-bones client and the command you need to make an API call. | ||
| * @throws {@link InvalidRedirectUriException} (client fault) | ||
| * <p>Indicates that one or more redirect URI in the request is not supported for this operation.</p> | ||
| * <p>Indicates that one or more redirect URI in the request is not supported for this | ||
| * operation.</p> | ||
| * | ||
@@ -85,0 +87,0 @@ * @throws {@link InvalidRequestException} (client fault) |
| /** | ||
| * <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI | ||
| * or a native application) to register with IAM Identity Center. The service also enables the client to | ||
| * fetch the user’s access token upon successful authentication and authorization with | ||
| * IAM Identity Center.</p> | ||
| * <note> | ||
| * <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p> | ||
| * </note> | ||
| * <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a | ||
| * native application) to register with IAM Identity Center. The service also enables the client to fetch the | ||
| * user’s access token upon successful authentication and authorization with IAM Identity Center.</p> | ||
| * <p> | ||
| * <b>Considerations for Using This Guide</b> | ||
| * <b>API namespaces</b> | ||
| * </p> | ||
| * <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces. IAM Identity Center | ||
| * OpenID Connect uses the <code>sso-oidc</code> namespace.</p> | ||
| * <p> | ||
| * <b>Considerations for using this guide</b> | ||
| * </p> | ||
| * <p>Before you begin using this guide, we recommend that you first review the following | ||
@@ -24,4 +25,4 @@ * important information about how the IAM Identity Center OIDC service works.</p> | ||
| * supports token refresh and doesn’t require re-authentication, update to the latest CLI | ||
| * version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh 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> | ||
| * version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh | ||
| * 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> | ||
| * </li> | ||
@@ -36,3 +37,3 @@ * <li> | ||
| * 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 | ||
| * Guide</i>.</p> | ||
| * Guide</i>.</p> | ||
| * </li> | ||
@@ -39,0 +40,0 @@ * </ul> |
@@ -11,4 +11,3 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client"; | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>access_denied</code>.</p> | ||
| * <p>Single error code. For this exception the value will be <code>access_denied</code>.</p> | ||
| * @public | ||
@@ -18,4 +17,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -38,4 +37,4 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>authorization_pending</code>.</p> | ||
| * <p>Single error code. For this exception the value will be | ||
| * <code>authorization_pending</code>.</p> | ||
| * @public | ||
@@ -45,4 +44,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -73,4 +72,6 @@ */ | ||
| /** | ||
| * <p>Supports the following OAuth grant types: Device Code and Refresh Token. | ||
| * Specify either of the following values, depending on the grant type that you want:</p> | ||
| * <p>Supports the following OAuth grant types: Authorization Code, Device Code, and Refresh | ||
| * Token. Specify one of the following values, depending on the grant type that you want:</p> | ||
| * <p>* Authorization Code - <code>authorization_code</code> | ||
| * </p> | ||
| * <p>* Device Code - <code>urn:ietf:params:oauth:grant-type:device_code</code> | ||
@@ -80,3 +81,2 @@ * </p> | ||
| * </p> | ||
| * <p>For information about how to obtain the device code, see the <a>StartDeviceAuthorization</a> topic.</p> | ||
| * @public | ||
@@ -86,5 +86,4 @@ */ | ||
| /** | ||
| * <p>Used only when calling this API for the Device Code grant type. This short-term code is | ||
| * used to identify this authorization request. This comes from the result of the | ||
| * <a>StartDeviceAuthorization</a> API.</p> | ||
| * <p>Used only when calling this API for the Device Code grant type. This short-lived code is | ||
| * used to identify this authorization request. This comes from the result of the <a>StartDeviceAuthorization</a> API.</p> | ||
| * @public | ||
@@ -94,5 +93,4 @@ */ | ||
| /** | ||
| * <p>Used only when calling this API for the Authorization Code grant type. The short-term code is | ||
| * used to identify this authorization request. This grant type is currently unsupported for the | ||
| * <a>CreateToken</a> API.</p> | ||
| * <p>Used only when calling this API for the Authorization Code grant type. The short-lived | ||
| * code is used to identify this authorization request.</p> | ||
| * @public | ||
@@ -103,6 +101,6 @@ */ | ||
| * <p>Used only when calling this API for the Refresh Token grant type. This token is used to | ||
| * refresh short-term tokens, such as the access token, that might expire.</p> | ||
| * refresh short-lived tokens, such as the access token, that might expire.</p> | ||
| * <p>For more information about the features and limitations of the current IAM Identity Center OIDC | ||
| * implementation, see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center | ||
| * OIDC API Reference</a>.</p> | ||
| * OIDC API Reference</a>.</p> | ||
| * @public | ||
@@ -114,4 +112,3 @@ */ | ||
| * is limited to the scopes that are granted. If this value is not specified, IAM Identity Center authorizes | ||
| * all scopes that are configured for the client during the call to | ||
| * <a>RegisterClient</a>.</p> | ||
| * all scopes that are configured for the client during the call to <a>RegisterClient</a>.</p> | ||
| * @public | ||
@@ -121,5 +118,5 @@ */ | ||
| /** | ||
| * <p>Used only when calling this API for the Authorization Code grant type. This value specifies | ||
| * the location of the client or application that has registered to receive the authorization | ||
| * code.</p> | ||
| * <p>Used only when calling this API for the Authorization Code grant type. This value | ||
| * specifies the location of the client or application that has registered to receive the | ||
| * authorization code.</p> | ||
| * @public | ||
@@ -129,5 +126,5 @@ */ | ||
| /** | ||
| * <p>Used only when calling this API for the Authorization Code grant type. This value is generated | ||
| * by the client and presented to validate the original code challenge value the client passed at | ||
| * authorization time.</p> | ||
| * <p>Used only when calling this API for the Authorization Code grant type. This value is | ||
| * generated by the client and presented to validate the original code challenge value the client | ||
| * passed at authorization time.</p> | ||
| * @public | ||
@@ -160,5 +157,4 @@ */ | ||
| * might have expired.</p> | ||
| * <p>For more | ||
| * information about the features and limitations of the current IAM Identity Center OIDC implementation, | ||
| * see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center | ||
| * <p>For more information about the features and limitations of the current IAM Identity Center OIDC | ||
| * implementation, see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center | ||
| * OIDC API Reference</a>.</p> | ||
@@ -170,7 +166,7 @@ * @public | ||
| * <p>The <code>idToken</code> is not implemented or supported. For more information about the | ||
| * features and limitations of the current IAM Identity Center OIDC implementation, see <i>Considerations | ||
| * for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center | ||
| * OIDC API Reference</a>.</p> | ||
| * features and limitations of the current IAM Identity Center OIDC implementation, see | ||
| * <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center | ||
| * OIDC API Reference</a>.</p> | ||
| * <p>A JSON Web Token (JWT) that identifies who is associated with the issued access token. | ||
| * </p> | ||
| * </p> | ||
| * @public | ||
@@ -188,4 +184,3 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>expired_token</code>.</p> | ||
| * <p>Single error code. For this exception the value will be <code>expired_token</code>.</p> | ||
| * @public | ||
@@ -195,4 +190,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -215,4 +210,3 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>server_error</code>.</p> | ||
| * <p>Single error code. For this exception the value will be <code>server_error</code>.</p> | ||
| * @public | ||
@@ -222,4 +216,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -243,4 +237,4 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>invalid_client</code>.</p> | ||
| * <p>Single error code. For this exception the value will be | ||
| * <code>invalid_client</code>.</p> | ||
| * @public | ||
@@ -250,4 +244,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -270,4 +264,3 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>invalid_grant</code>.</p> | ||
| * <p>Single error code. For this exception the value will be <code>invalid_grant</code>.</p> | ||
| * @public | ||
@@ -277,4 +270,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -297,4 +290,4 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>invalid_request</code>.</p> | ||
| * <p>Single error code. For this exception the value will be | ||
| * <code>invalid_request</code>.</p> | ||
| * @public | ||
@@ -304,4 +297,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -323,4 +316,3 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>invalid_scope</code>.</p> | ||
| * <p>Single error code. For this exception the value will be <code>invalid_scope</code>.</p> | ||
| * @public | ||
@@ -330,4 +322,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -350,4 +342,3 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>slow_down</code>.</p> | ||
| * <p>Single error code. For this exception the value will be <code>slow_down</code>.</p> | ||
| * @public | ||
@@ -357,4 +348,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -377,4 +368,4 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>unauthorized_client</code>.</p> | ||
| * <p>Single error code. For this exception the value will be | ||
| * <code>unauthorized_client</code>.</p> | ||
| * @public | ||
@@ -384,4 +375,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -403,4 +394,4 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>unsupported_grant_type</code>.</p> | ||
| * <p>Single error code. For this exception the value will be | ||
| * <code>unsupported_grant_type</code>.</p> | ||
| * @public | ||
@@ -410,4 +401,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -447,6 +438,6 @@ */ | ||
| /** | ||
| * <p>Used only when calling this API for the Authorization Code grant type. This short-term | ||
| * code is used to identify this authorization request. The code is obtained through a redirect | ||
| * from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the | ||
| * application.</p> | ||
| * <p>Used only when calling this API for the Authorization Code grant type. This short-lived | ||
| * code is used to identify this authorization request. The code is obtained through a redirect | ||
| * from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the | ||
| * application.</p> | ||
| * @public | ||
@@ -457,6 +448,6 @@ */ | ||
| * <p>Used only when calling this API for the Refresh Token grant type. This token is used to | ||
| * refresh short-term tokens, such as the access token, that might expire.</p> | ||
| * refresh short-lived tokens, such as the access token, that might expire.</p> | ||
| * <p>For more information about the features and limitations of the current IAM Identity Center OIDC | ||
| * implementation, see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center | ||
| * OIDC API Reference</a>.</p> | ||
| * OIDC API Reference</a>.</p> | ||
| * @public | ||
@@ -466,4 +457,4 @@ */ | ||
| /** | ||
| * <p>Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON | ||
| * Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, | ||
| * <p>Used only when calling this API for the JWT Bearer grant type. This value specifies the | ||
| * JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, | ||
| * configure the JWT Bearer GrantOptions for the application.</p> | ||
@@ -477,3 +468,3 @@ * @public | ||
| * scopes configured for the application, including the following default scopes: | ||
| * <code>openid</code>, <code>aws</code>, <code>sts:identity_context</code>.</p> | ||
| * <code>openid</code>, <code>aws</code>, <code>sts:identity_context</code>.</p> | ||
| * @public | ||
@@ -483,5 +474,5 @@ */ | ||
| /** | ||
| * <p>Used only when calling this API for the Authorization Code grant type. This value specifies | ||
| * the location of the client or application that has registered to receive the authorization code. | ||
| * </p> | ||
| * <p>Used only when calling this API for the Authorization Code grant type. This value | ||
| * specifies the location of the client or application that has registered to receive the | ||
| * authorization code. </p> | ||
| * @public | ||
@@ -493,4 +484,4 @@ */ | ||
| * the subject of the exchange. The value of the subject token must be an access token issued by | ||
| * IAM Identity Center to a different client or application. The access token must have authorized scopes | ||
| * that indicate the requested application as a target audience.</p> | ||
| * IAM Identity Center to a different client or application. The access token must have authorized scopes that | ||
| * indicate the requested application as a target audience.</p> | ||
| * @public | ||
@@ -519,5 +510,5 @@ */ | ||
| /** | ||
| * <p>Used only when calling this API for the Authorization Code grant type. This value is generated | ||
| * by the client and presented to validate the original code challenge value the client passed at | ||
| * authorization time.</p> | ||
| * <p>Used only when calling this API for the Authorization Code grant type. This value is | ||
| * generated by the client and presented to validate the original code challenge value the client | ||
| * passed at authorization time.</p> | ||
| * @public | ||
@@ -550,5 +541,4 @@ */ | ||
| * might have expired.</p> | ||
| * <p>For more | ||
| * information about the features and limitations of the current IAM Identity Center OIDC implementation, | ||
| * see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center | ||
| * <p>For more information about the features and limitations of the current IAM Identity Center OIDC | ||
| * implementation, see <i>Considerations for Using this Guide</i> in the <a href="https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html">IAM Identity Center | ||
| * OIDC API Reference</a>.</p> | ||
@@ -560,3 +550,3 @@ * @public | ||
| * <p>A JSON Web Token (JWT) that identifies the user associated with the issued access token. | ||
| * </p> | ||
| * </p> | ||
| * @public | ||
@@ -566,4 +556,3 @@ */ | ||
| /** | ||
| * <p>Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported: | ||
| * </p> | ||
| * <p>Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported: </p> | ||
| * <p>* Access Token - <code>urn:ietf:params:oauth:token-type:access_token</code> | ||
@@ -577,4 +566,4 @@ * </p> | ||
| /** | ||
| * <p>The list of scopes for which authorization is granted. The access token that is issued | ||
| * is limited to the scopes that are granted.</p> | ||
| * <p>The list of scopes for which authorization is granted. The access token that is issued is | ||
| * limited to the scopes that are granted.</p> | ||
| * @public | ||
@@ -593,4 +582,4 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>invalid_request</code>.</p> | ||
| * <p>Single error code. For this exception the value will be | ||
| * <code>invalid_request</code>.</p> | ||
| * @public | ||
@@ -600,4 +589,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -630,4 +619,4 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>invalid_client_metadata</code>.</p> | ||
| * <p>Single error code. For this exception the value will be | ||
| * <code>invalid_client_metadata</code>.</p> | ||
| * @public | ||
@@ -637,4 +626,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -649,3 +638,4 @@ */ | ||
| /** | ||
| * <p>Indicates that one or more redirect URI in the request is not supported for this operation.</p> | ||
| * <p>Indicates that one or more redirect URI in the request is not supported for this | ||
| * operation.</p> | ||
| * @public | ||
@@ -657,4 +647,4 @@ */ | ||
| /** | ||
| * <p>Single error code. | ||
| * For this exception the value will be <code>invalid_redirect_uri</code>.</p> | ||
| * <p>Single error code. For this exception the value will be | ||
| * <code>invalid_redirect_uri</code>.</p> | ||
| * @public | ||
@@ -664,4 +654,4 @@ */ | ||
| /** | ||
| * <p>Human-readable text providing additional information, used to assist the | ||
| * client developer in understanding the error that occurred.</p> | ||
| * <p>Human-readable text providing additional information, used to assist the client developer | ||
| * in understanding the error that occurred.</p> | ||
| * @public | ||
@@ -704,3 +694,10 @@ */ | ||
| * <p>The list of OAuth 2.0 grant types that are defined by the client. This list is used to | ||
| * restrict the token granting flows available to the client.</p> | ||
| * restrict the token granting flows available to the client. Supports the following OAuth 2.0 | ||
| * grant types: Authorization Code, Device Code, and Refresh Token. </p> | ||
| * <p>* Authorization Code - <code>authorization_code</code> | ||
| * </p> | ||
| * <p>* Device Code - <code>urn:ietf:params:oauth:grant-type:device_code</code> | ||
| * </p> | ||
| * <p>* Refresh Token - <code>refresh_token</code> | ||
| * </p> | ||
| * @public | ||
@@ -710,3 +707,4 @@ */ | ||
| /** | ||
| * <p>The IAM Identity Center Issuer URL associated with an instance of IAM Identity Center. This value is needed for user access to resources through the client.</p> | ||
| * <p>The IAM Identity Center Issuer URL associated with an instance of IAM Identity Center. This value is needed for user | ||
| * access to resources through the client.</p> | ||
| * @public | ||
@@ -716,4 +714,5 @@ */ | ||
| /** | ||
| * <p>This IAM Identity Center application ARN is used to define administrator-managed configuration for public client access to resources. At | ||
| * authorization, the scopes, grants, and redirect URI available to this client will be restricted by this application resource.</p> | ||
| * <p>This IAM Identity Center application ARN is used to define administrator-managed configuration for | ||
| * public client access to resources. At authorization, the scopes, grants, and redirect URI | ||
| * available to this client will be restricted by this application resource.</p> | ||
| * @public | ||
@@ -781,3 +780,3 @@ */ | ||
| * <p>The URL for the Amazon Web Services access portal. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html">Using | ||
| * the Amazon Web Services access portal</a> in the <i>IAM Identity Center User Guide</i>.</p> | ||
| * the Amazon Web Services access portal</a> in the <i>IAM Identity Center User Guide</i>.</p> | ||
| * @public | ||
@@ -784,0 +783,0 @@ */ |
@@ -34,12 +34,13 @@ import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types"; | ||
| /** | ||
| * <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI | ||
| * or a native application) to register with IAM Identity Center. The service also enables the client to | ||
| * fetch the user’s access token upon successful authentication and authorization with | ||
| * IAM Identity Center.</p> | ||
| * <note> | ||
| * <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p> | ||
| * </note> | ||
| * <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a | ||
| * native application) to register with IAM Identity Center. The service also enables the client to fetch the | ||
| * user’s access token upon successful authentication and authorization with IAM Identity Center.</p> | ||
| * <p> | ||
| * <b>Considerations for Using This Guide</b> | ||
| * <b>API namespaces</b> | ||
| * </p> | ||
| * <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces. IAM Identity Center | ||
| * OpenID Connect uses the <code>sso-oidc</code> namespace.</p> | ||
| * <p> | ||
| * <b>Considerations for using this guide</b> | ||
| * </p> | ||
| * <p>Before you begin using this guide, we recommend that you first review the following | ||
@@ -57,4 +58,4 @@ * important information about how the IAM Identity Center OIDC service works.</p> | ||
| * supports token refresh and doesn’t require re-authentication, update to the latest CLI | ||
| * version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh 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> | ||
| * version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh | ||
| * 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> | ||
| * </li> | ||
@@ -69,3 +70,3 @@ * <li> | ||
| * 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 | ||
| * Guide</i>.</p> | ||
| * Guide</i>.</p> | ||
| * </li> | ||
@@ -72,0 +73,0 @@ * </ul> |
@@ -176,12 +176,13 @@ import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header"; | ||
| /** | ||
| * <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI | ||
| * or a native application) to register with IAM Identity Center. The service also enables the client to | ||
| * fetch the user’s access token upon successful authentication and authorization with | ||
| * IAM Identity Center.</p> | ||
| * <note> | ||
| * <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p> | ||
| * </note> | ||
| * <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a | ||
| * native application) to register with IAM Identity Center. The service also enables the client to fetch the | ||
| * user’s access token upon successful authentication and authorization with IAM Identity Center.</p> | ||
| * <p> | ||
| * <b>Considerations for Using This Guide</b> | ||
| * <b>API namespaces</b> | ||
| * </p> | ||
| * <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces. IAM Identity Center | ||
| * OpenID Connect uses the <code>sso-oidc</code> namespace.</p> | ||
| * <p> | ||
| * <b>Considerations for using this guide</b> | ||
| * </p> | ||
| * <p>Before you begin using this guide, we recommend that you first review the following | ||
@@ -199,4 +200,4 @@ * important information about how the IAM Identity Center OIDC service works.</p> | ||
| * supports token refresh and doesn’t require re-authentication, update to the latest CLI | ||
| * version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh 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> | ||
| * version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh | ||
| * 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> | ||
| * </li> | ||
@@ -211,3 +212,3 @@ * <li> | ||
| * 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 | ||
| * Guide</i>.</p> | ||
| * Guide</i>.</p> | ||
| * </li> | ||
@@ -214,0 +215,0 @@ * </ul> |
| { | ||
| "name": "@aws-sdk/client-sso-oidc", | ||
| "description": "AWS SDK for JavaScript Sso Oidc Client for Node.js, Browser and React Native", | ||
| "version": "3.734.0", | ||
| "version": "3.735.0", | ||
| "scripts": { | ||
@@ -6,0 +6,0 @@ "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'", |
@@ -9,12 +9,13 @@ <!-- generated file, do not edit directly --> | ||
| <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI | ||
| or a native application) to register with IAM Identity Center. The service also enables the client to | ||
| fetch the user’s access token upon successful authentication and authorization with | ||
| IAM Identity Center.</p> | ||
| <note> | ||
| <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p> | ||
| </note> | ||
| <p>IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a | ||
| native application) to register with IAM Identity Center. The service also enables the client to fetch the | ||
| user’s access token upon successful authentication and authorization with IAM Identity Center.</p> | ||
| <p> | ||
| <b>Considerations for Using This Guide</b> | ||
| <b>API namespaces</b> | ||
| </p> | ||
| <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces. IAM Identity Center | ||
| OpenID Connect uses the <code>sso-oidc</code> namespace.</p> | ||
| <p> | ||
| <b>Considerations for using this guide</b> | ||
| </p> | ||
| <p>Before you begin using this guide, we recommend that you first review the following | ||
@@ -32,4 +33,4 @@ important information about how the IAM Identity Center OIDC service works.</p> | ||
| supports token refresh and doesn’t require re-authentication, update to the latest CLI | ||
| version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh 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> | ||
| version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh | ||
| 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> | ||
| </li> | ||
@@ -36,0 +37,0 @@ <li> |
No alert changes
Improved metrics
- Total package byte prevSize
- increased by0.21%
291962
- Number of lines in readme file
- increased by0.36%
276
Worsened metrics
- Lines of code
- decreased by-0.03%
6175
No dependency changes