@aws-sdk/client-sso-oidc 3.137.0 → 3.145.0

package/dist-types/models/models_0.d.ts

@@ -14,7 +14,8 @@ export declare class AccessDeniedException extends __BaseException {
     constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
 }
 /**
- * <p>Indicates that a request to authorize a client with an access user session token is pending.</p>
+ * <p>Indicates that a request to authorize a client with an access user session token is
+ *       pending.</p>
  */
 export declare class AuthorizationPendingException extends __BaseException {
     readonly name: "AuthorizationPendingException";
@@ -28,15 +29,25 @@ export declare class AuthorizationPendingException extends __BaseException {
 }
 export interface CreateTokenRequest {
     /**
-     * <p>The unique identifier string for each client. This value should come from the persisted result of the <a>RegisterClient</a> API.</p>
+     * <p>The unique identifier string for each client. This value should come from the persisted
+     *       result of the <a>RegisterClient</a> API.</p>
      */
     clientId: string | undefined;
     /**
-     * <p>A secret string generated for the client. This value should come from the persisted result of the <a>RegisterClient</a> API.</p>
+     * <p>A secret string generated for the client. This value should come from the persisted result
+     *       of the <a>RegisterClient</a> API.</p>
      */
     clientSecret: string | undefined;
     /**
-     * <p>Supports grant types for authorization code, refresh token, and device code request.</p>
+     * <p>Supports grant types for the authorization code, refresh token, and device code request.
+     *       For device code requests, specify the following value:</p>
+     *
+     *          <p>
+     *             <code>urn:ietf:params:oauth:grant-type:<i>device_code</i>
+     *             </code>
+     *          </p>
+     *
+     *          <p>For information about how to obtain the device code, see the <a>StartDeviceAuthorization</a> topic.</p>
      */
     grantType: string | undefined;
     /**
@@ -46,11 +57,17 @@ export interface CreateTokenRequest {
      */
     deviceCode: string | undefined;
     /**
-     * <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>
+     * <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>
      */
     code?: string;
     /**
-     * <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>
+     * <p>Currently, <code>refreshToken</code> is not yet implemented and is not supported. For more
+     *       information about the features and limitations of the current Amazon Web Services SSO OIDC implementation,
+     *       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
+     *         OIDC API Reference</a>.</p>
+     *          <p>The token used to obtain an access token in the event that the access token is invalid or
+     *       expired.</p>
      */
     refreshToken?: string;
     /**
@@ -66,7 +83,7 @@ export interface CreateTokenRequest {
 }
 export interface CreateTokenResponse {
     /**
-     * <p>An opaque token to access AWS SSO resources assigned to a user.</p>
+     * <p>An opaque token to access Amazon Web Services SSO resources assigned to a user.</p>
      */
     accessToken?: string;
     /**
@@ -79,12 +96,20 @@ export interface CreateTokenResponse {
      */
     expiresIn?: number;
     /**
-     * <p>A token that, if present, can be used to refresh a previously issued access token that
+     * <p>Currently, <code>refreshToken</code> is not yet implemented and is not supported. For more
+     *       information about the features and limitations of the current Amazon Web Services SSO OIDC implementation,
+     *       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
+     *         OIDC API Reference</a>.</p>
+     *          <p>A token that, if present, can be used to refresh a previously issued access token that
      *       might have expired.</p>
      */
     refreshToken?: string;
     /**
-     * <p>The identifier of the user that associated with the access token, if present.</p>
+     * <p>Currently, <code>idToken</code> is not yet implemented and is not supported. For more
+     *       information about the features and limitations of the current Amazon Web Services SSO OIDC implementation,
+     *       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
+     *         OIDC API Reference</a>.</p>
+     *          <p>The identifier of the user that associated with the access token, if present.</p>
      */
     idToken?: string;
 }
@@ -102,7 +127,8 @@ export declare class ExpiredTokenException extends __BaseException {
     constructor(opts: __ExceptionOptionType<ExpiredTokenException, __BaseException>);
 }
 /**
- * <p>Indicates that an error from the service occurred while trying to process a request.</p>
+ * <p>Indicates that an error from the service occurred while trying to process a
+ *       request.</p>
  */
 export declare class InternalServerException extends __BaseException {
     readonly name: "InternalServerException";
@@ -130,7 +156,8 @@ export declare class InvalidClientException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidClientException, __BaseException>);
 }
 /**
- * <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>
+ * <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>
  */
 export declare class InvalidGrantException extends __BaseException {
     readonly name: "InvalidGrantException";
@@ -170,7 +197,8 @@ export declare class InvalidScopeException extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidScopeException, __BaseException>);
 }
 /**
- * <p>Indicates that the client is making the request too frequently and is more than the service can handle. </p>
+ * <p>Indicates that the client is making the request too frequently and is more than the
+ *       service can handle. </p>
  */
 export declare class SlowDownException extends __BaseException {
     readonly name: "SlowDownException";
@@ -210,7 +238,8 @@ export declare class UnsupportedGrantTypeException extends __BaseException {
     constructor(opts: __ExceptionOptionType<UnsupportedGrantTypeException, __BaseException>);
 }
 /**
- * <p>Indicates that the client information sent in the request during registration is invalid.</p>
+ * <p>Indicates that the client information sent in the request during registration is
+ *       invalid.</p>
  */
 export declare class InvalidClientMetadataException extends __BaseException {
     readonly name: "InvalidClientMetadataException";
@@ -228,7 +257,8 @@ export interface RegisterClientRequest {
      */
     clientName: string | undefined;
     /**
-     * <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>
+     * <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>
      */
     clientType: string | undefined;
     /**
@@ -249,11 +279,13 @@ export interface RegisterClientResponse {
      */
     clientSecret?: string;
     /**
-     * <p>Indicates the time at which the <code>clientId</code> and <code>clientSecret</code> were issued.</p>
+     * <p>Indicates the time at which the <code>clientId</code> and <code>clientSecret</code> were
+     *       issued.</p>
      */
     clientIdIssuedAt?: number;
     /**
-     * <p>Indicates the time at which the <code>clientId</code> and <code>clientSecret</code> will become invalid.</p>
+     * <p>Indicates the time at which the <code>clientId</code> and <code>clientSecret</code> will
+     *       become invalid.</p>
      */
     clientSecretExpiresAt?: number;
     /**
@@ -267,7 +299,7 @@ export interface RegisterClientResponse {
 }
 export interface StartDeviceAuthorizationRequest {
     /**
-     * <p>The unique identifier string for the client that is registered with AWS SSO. This value
+     * <p>The unique identifier string for the client that is registered with Amazon Web Services SSO. This value
      *       should come from the persisted result of the <a>RegisterClient</a> API
      *       operation.</p>
      */
@@ -278,8 +310,8 @@ export interface StartDeviceAuthorizationRequest {
      */
     clientSecret: string | undefined;
     /**
-     * <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
-     *         the User Portal</a> in the <i>AWS Single Sign-On User Guide</i>.</p>
+     * <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
+     *       the AWS access portal</a> in the <i>Amazon Web Services SSO User Guide</i>.</p>
      */
     startUrl: string | undefined;
 }
@@ -293,7 +325,8 @@ export interface StartDeviceAuthorizationResponse {
      */
     userCode?: string;
     /**
-     * <p>The URI of the verification page that takes the <code>userCode</code> to authorize the device.</p>
+     * <p>The URI of the verification page that takes the <code>userCode</code> to authorize the
+     *       device.</p>
      */
     verificationUri?: string;
     /**
@@ -307,7 +340,8 @@ export interface StartDeviceAuthorizationResponse {
      */
     expiresIn?: number;
     /**
-     * <p>Indicates the number of seconds the client must wait between attempts when polling for a session.</p>
+     * <p>Indicates the number of seconds the client must wait between attempts when polling for a
+     *       session.</p>
      */
     interval?: number;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-sso-oidc",
   "description": "AWS SDK for JavaScript Sso Oidc Client for Node.js, Browser and React Native",
-  "version": "3.137.0",
+  "version": "3.145.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -33,15 +33,15 @@
     "@aws-sdk/node-config-provider": "3.127.0",
     "@aws-sdk/node-http-handler": "3.127.0",
     "@aws-sdk/protocol-http": "3.127.0",
-    "@aws-sdk/smithy-client": "3.137.0",
+    "@aws-sdk/smithy-client": "3.142.0",
     "@aws-sdk/types": "3.127.0",
     "@aws-sdk/url-parser": "3.127.0",
     "@aws-sdk/util-base64-browser": "3.109.0",
     "@aws-sdk/util-base64-node": "3.55.0",
     "@aws-sdk/util-body-length-browser": "3.55.0",
     "@aws-sdk/util-body-length-node": "3.55.0",
-    "@aws-sdk/util-defaults-mode-browser": "3.137.0",
-    "@aws-sdk/util-defaults-mode-node": "3.137.0",
+    "@aws-sdk/util-defaults-mode-browser": "3.142.0",
+    "@aws-sdk/util-defaults-mode-node": "3.142.0",
     "@aws-sdk/util-user-agent-browser": "3.127.0",
     "@aws-sdk/util-user-agent-node": "3.127.0",
     "@aws-sdk/util-utf8-browser": "3.109.0",
@@ -58,6 +58,11 @@
     "typedoc": "0.19.2",
     "typescript": "~4.6.2"
   },
+  "overrides": {
+    "typedoc": {
+      "typescript": "~4.6.2"
+    }
+  },
   "engines": {
     "node": ">=12.0.0"
   },