@aws-sdk/client-sso-oidc 3.454.0 → 3.458.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.
Files changed (6) hide show
  1. package/README.md +4 -4
  2. package/dist-types/commands/CreateTokenCommand.d.ts +47 -0
  3. package/dist-types/commands/CreateTokenWithIAMCommand.d.ts +118 -0
  4. package/dist-types/commands/RegisterClientCommand.d.ts +24 -0
  5. package/dist-types/commands/StartDeviceAuthorizationCommand.d.ts +23 -0
  6. package/package.json +3 -3
package/README.md CHANGED
@@ -245,7 +245,7 @@ see LICENSE for more information.
245
245
  CreateToken
246
246
  </summary>
247
247
 
248
- [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sso-oidc/classes/createtokencommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sso-oidc/interfaces/createtokencommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sso-oidc/interfaces/createtokencommandoutput.html)
248
+ [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sso-oidc/command/CreateTokenCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sso-oidc/Interface/CreateTokenCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sso-oidc/Interface/CreateTokenCommandOutput/)
249
249
 
250
250
  </details>
251
251
  <details>
@@ -253,7 +253,7 @@ CreateToken
253
253
  CreateTokenWithIAM
254
254
  </summary>
255
255
 
256
- [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sso-oidc/classes/createtokenwithiamcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sso-oidc/interfaces/createtokenwithiamcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sso-oidc/interfaces/createtokenwithiamcommandoutput.html)
256
+ [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sso-oidc/command/CreateTokenWithIAMCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sso-oidc/Interface/CreateTokenWithIAMCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sso-oidc/Interface/CreateTokenWithIAMCommandOutput/)
257
257
 
258
258
  </details>
259
259
  <details>
@@ -261,7 +261,7 @@ CreateTokenWithIAM
261
261
  RegisterClient
262
262
  </summary>
263
263
 
264
- [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sso-oidc/classes/registerclientcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sso-oidc/interfaces/registerclientcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sso-oidc/interfaces/registerclientcommandoutput.html)
264
+ [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sso-oidc/command/RegisterClientCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sso-oidc/Interface/RegisterClientCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sso-oidc/Interface/RegisterClientCommandOutput/)
265
265
 
266
266
  </details>
267
267
  <details>
@@ -269,6 +269,6 @@ RegisterClient
269
269
  StartDeviceAuthorization
270
270
  </summary>
271
271
 
272
- [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sso-oidc/classes/startdeviceauthorizationcommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sso-oidc/interfaces/startdeviceauthorizationcommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-sso-oidc/interfaces/startdeviceauthorizationcommandoutput.html)
272
+ [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/sso-oidc/command/StartDeviceAuthorizationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sso-oidc/Interface/StartDeviceAuthorizationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-sso-oidc/Interface/StartDeviceAuthorizationCommandOutput/)
273
273
 
274
274
  </details>
package/dist-types/commands/CreateTokenCommand.d.ts CHANGED
@@ -106,6 +106,53 @@ export interface CreateTokenCommandOutput extends CreateTokenResponse, __Metadat
106
106
  * @throws {@link SSOOIDCServiceException}
107
107
  * <p>Base exception class for all service exceptions from SSOOIDC service.</p>
108
108
  *
109
+ * @example Call OAuth/OIDC /token endpoint for Device Code grant with Secret authentication
110
+ * ```javascript
111
+ * //
112
+ * const input = {
113
+ * "clientId": "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID",
114
+ * "clientSecret": "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0",
115
+ * "deviceCode": "yJraWQiOiJrZXktMTU2Njk2ODA4OCIsImFsZyI6IkhTMzIn0EXAMPLEDEVICECODE",
116
+ * "grantType": "urn:ietf:params:oauth:grant-type:device-code"
117
+ * };
118
+ * const command = new CreateTokenCommand(input);
119
+ * const response = await client.send(command);
120
+ * /* response ==
121
+ * {
122
+ * "accessToken": "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN",
123
+ * "expiresIn": 1579729529,
124
+ * "refreshToken": "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN",
125
+ * "tokenType": "Bearer"
126
+ * }
127
+ * *\/
128
+ * // example id: create-token-for-device-code
129
+ * ```
130
+ *
131
+ * @example Call OAuth/OIDC /token endpoint for Refresh Token grant with Secret authentication
132
+ * ```javascript
133
+ * //
134
+ * const input = {
135
+ * "clientId": "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID",
136
+ * "clientSecret": "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0",
137
+ * "grantType": "refresh_token",
138
+ * "refreshToken": "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN",
139
+ * "scope": [
140
+ * "codewhisperer:completions"
141
+ * ]
142
+ * };
143
+ * const command = new CreateTokenCommand(input);
144
+ * const response = await client.send(command);
145
+ * /* response ==
146
+ * {
147
+ * "accessToken": "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN",
148
+ * "expiresIn": 1579729529,
149
+ * "refreshToken": "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN",
150
+ * "tokenType": "Bearer"
151
+ * }
152
+ * *\/
153
+ * // example id: create-token-for-refresh-token
154
+ * ```
155
+ *
109
156
  */
110
157
  export declare class CreateTokenCommand extends $Command<CreateTokenCommandInput, CreateTokenCommandOutput, SSOOIDCClientResolvedConfig> {
111
158
  readonly input: CreateTokenCommandInput;
package/dist-types/commands/CreateTokenWithIAMCommand.d.ts CHANGED
@@ -117,6 +117,124 @@ export interface CreateTokenWithIAMCommandOutput extends CreateTokenWithIAMRespo
117
117
  * @throws {@link SSOOIDCServiceException}
118
118
  * <p>Base exception class for all service exceptions from SSOOIDC service.</p>
119
119
  *
120
+ * @example Call OAuth/OIDC /token endpoint for Authorization Code grant with IAM authentication
121
+ * ```javascript
122
+ * //
123
+ * const input = {
124
+ * "clientId": "arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222",
125
+ * "code": "yJraWQiOiJrZXktMTU2Njk2ODA4OCIsImFsZyI6IkhTMzg0In0EXAMPLEAUTHCODE",
126
+ * "grantType": "authorization_code",
127
+ * "redirectUri": "https://mywebapp.example/redirect",
128
+ * "scope": [
129
+ * "openid",
130
+ * "aws",
131
+ * "sts:identity_context"
132
+ * ]
133
+ * };
134
+ * const command = new CreateTokenWithIAMCommand(input);
135
+ * const response = await client.send(command);
136
+ * /* response ==
137
+ * {
138
+ * "accessToken": "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN",
139
+ * "expiresIn": 1579729529,
140
+ * "idToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhd3M6aWRlbnRpdHlfc3RvcmVfaWQiOiJkLTMzMzMzMzMzMzMiLCJzdWIiOiI3MzA0NDhmMi1lMGExLTcwYTctYzk1NC0wMDAwMDAwMDAwMDAiLCJhd3M6aW5zdGFuY2VfYWNjb3VudCI6IjExMTExMTExMTExMSIsInN0czppZGVudGl0eV9jb250ZXh0IjoiRVhBTVBMRUlERU5USVRZQ09OVEVYVCIsInN0czphdWRpdF9jb250ZXh0IjoiRVhBTVBMRUFVRElUQ09OVEVYVCIsImlzcyI6Imh0dHBzOi8vaWRlbnRpdHljZW50ZXIuYW1hem9uYXdzLmNvbS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmlkZW50aXR5X3N0b3JlX2FybiI6ImFybjphd3M6aWRlbnRpdHlzdG9yZTo6MTExMTExMTExMTExOmlkZW50aXR5c3RvcmUvZC0zMzMzMzMzMzMzIiwiYXVkIjoiYXJuOmF3czpzc286OjEyMzQ1Njc4OTAxMjphcHBsaWNhdGlvbi9zc29pbnMtMTExMTExMTExMTExL2FwbC0yMjIyMjIyMjIyMjIiLCJhd3M6aW5zdGFuY2VfYXJuIjoiYXJuOmF3czpzc286OjppbnN0YW5jZS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmNyZWRlbnRpYWxfaWQiOiJfWlIyTjZhVkJqMjdGUEtheWpfcEtwVjc3QVBERl80MXB4ZXRfWWpJdUpONlVJR2RBdkpFWEFNUExFQ1JFRElEIiwiYXV0aF90aW1lIjoiMjAyMC0wMS0yMlQxMjo0NToyOVoiLCJleHAiOjE1Nzk3Mjk1MjksImlhdCI6MTU3OTcyNTkyOX0.Xyah6qbk78qThzJ41iFU2yfGuRqqtKXHrJYwQ8L9Ip0",
141
+ * "issuedTokenType": "urn:ietf:params:oauth:token-type:refresh_token",
142
+ * "refreshToken": "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN",
143
+ * "scope": [
144
+ * "openid",
145
+ * "aws",
146
+ * "sts:identity_context"
147
+ * ],
148
+ * "tokenType": "Bearer"
149
+ * }
150
+ * *\/
151
+ * // example id: create-token-with-iam-for-auth-code
152
+ * ```
153
+ *
154
+ * @example Call OAuth/OIDC /token endpoint for Refresh Token grant with IAM authentication
155
+ * ```javascript
156
+ * //
157
+ * const input = {
158
+ * "clientId": "arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222",
159
+ * "grantType": "refresh_token",
160
+ * "refreshToken": "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN"
161
+ * };
162
+ * const command = new CreateTokenWithIAMCommand(input);
163
+ * const response = await client.send(command);
164
+ * /* response ==
165
+ * {
166
+ * "accessToken": "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN",
167
+ * "expiresIn": 1579729529,
168
+ * "issuedTokenType": "urn:ietf:params:oauth:token-type:refresh_token",
169
+ * "refreshToken": "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN",
170
+ * "scope": [
171
+ * "openid",
172
+ * "aws",
173
+ * "sts:identity_context"
174
+ * ],
175
+ * "tokenType": "Bearer"
176
+ * }
177
+ * *\/
178
+ * // example id: create-token-with-iam-for-refresh-token
179
+ * ```
180
+ *
181
+ * @example Call OAuth/OIDC /token endpoint for JWT Bearer grant with IAM authentication
182
+ * ```javascript
183
+ * //
184
+ * const input = {
185
+ * "assertion": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6IjFMVE16YWtpaGlSbGFfOHoyQkVKVlhlV01xbyJ9.eyJ2ZXIiOiIyLjAiLCJpc3MiOiJodHRwczovL2xvZ2luLm1pY3Jvc29mdG9ubGluZS5jb20vOTEyMjA0MGQtNmM2Ny00YzViLWIxMTItMzZhMzA0YjY2ZGFkL3YyLjAiLCJzdWIiOiJBQUFBQUFBQUFBQUFBQUFBQUFBQUFJa3pxRlZyU2FTYUZIeTc4MmJidGFRIiwiYXVkIjoiNmNiMDQwMTgtYTNmNS00NmE3LWI5OTUtOTQwYzc4ZjVhZWYzIiwiZXhwIjoxNTM2MzYxNDExLCJpYXQiOjE1MzYyNzQ3MTEsIm5iZiI6MTUzNjI3NDcxMSwibmFtZSI6IkFiZSBMaW5jb2xuIiwicHJlZmVycmVkX3VzZXJuYW1lIjoiQWJlTGlAbWljcm9zb2Z0LmNvbSIsIm9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC02NmYzLTMzMzJlY2E3ZWE4MSIsInRpZCI6IjkxMjIwNDBkLTZjNjctNGM1Yi1iMTEyLTM2YTMwNGI2NmRhZCIsIm5vbmNlIjoiMTIzNTIzIiwiYWlvIjoiRGYyVVZYTDFpeCFsTUNXTVNPSkJjRmF0emNHZnZGR2hqS3Y4cTVnMHg3MzJkUjVNQjVCaXN2R1FPN1lXQnlqZDhpUURMcSFlR2JJRGFreXA1bW5PcmNkcUhlWVNubHRlcFFtUnA2QUlaOGpZIn0.1AFWW-Ck5nROwSlltm7GzZvDwUkqvhSQpm55TQsmVo9Y59cLhRXpvB8n-55HCr9Z6G_31_UbeUkoz612I2j_Sm9FFShSDDjoaLQr54CreGIJvjtmS3EkK9a7SJBbcpL1MpUtlfygow39tFjY7EVNW9plWUvRrTgVk7lYLprvfzw-CIqw3gHC-T7IK_m_xkr08INERBtaecwhTeN4chPC4W3jdmw_lIxzC48YoQ0dB1L9-ImX98Egypfrlbm0IBL5spFzL6JDZIRRJOu8vecJvj1mq-IUhGt0MacxX8jdxYLP-KUu2d9MbNKpCKJuZ7p8gwTL5B7NlUdh_dmSviPWrw",
186
+ * "clientId": "arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222",
187
+ * "grantType": "urn:ietf:params:oauth:grant-type:jwt-bearer"
188
+ * };
189
+ * const command = new CreateTokenWithIAMCommand(input);
190
+ * const response = await client.send(command);
191
+ * /* response ==
192
+ * {
193
+ * "accessToken": "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN",
194
+ * "expiresIn": 1579729529,
195
+ * "idToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhd3M6aWRlbnRpdHlfc3RvcmVfaWQiOiJkLTMzMzMzMzMzMzMiLCJzdWIiOiI3MzA0NDhmMi1lMGExLTcwYTctYzk1NC0wMDAwMDAwMDAwMDAiLCJhd3M6aW5zdGFuY2VfYWNjb3VudCI6IjExMTExMTExMTExMSIsInN0czppZGVudGl0eV9jb250ZXh0IjoiRVhBTVBMRUlERU5USVRZQ09OVEVYVCIsInN0czphdWRpdF9jb250ZXh0IjoiRVhBTVBMRUFVRElUQ09OVEVYVCIsImlzcyI6Imh0dHBzOi8vaWRlbnRpdHljZW50ZXIuYW1hem9uYXdzLmNvbS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmlkZW50aXR5X3N0b3JlX2FybiI6ImFybjphd3M6aWRlbnRpdHlzdG9yZTo6MTExMTExMTExMTExOmlkZW50aXR5c3RvcmUvZC0zMzMzMzMzMzMzIiwiYXVkIjoiYXJuOmF3czpzc286OjEyMzQ1Njc4OTAxMjphcHBsaWNhdGlvbi9zc29pbnMtMTExMTExMTExMTExL2FwbC0yMjIyMjIyMjIyMjIiLCJhd3M6aW5zdGFuY2VfYXJuIjoiYXJuOmF3czpzc286OjppbnN0YW5jZS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmNyZWRlbnRpYWxfaWQiOiJfWlIyTjZhVkJqMjdGUEtheWpfcEtwVjc3QVBERl80MXB4ZXRfWWpJdUpONlVJR2RBdkpFWEFNUExFQ1JFRElEIiwiYXV0aF90aW1lIjoiMjAyMC0wMS0yMlQxMjo0NToyOVoiLCJleHAiOjE1Nzk3Mjk1MjksImlhdCI6MTU3OTcyNTkyOX0.Xyah6qbk78qThzJ41iFU2yfGuRqqtKXHrJYwQ8L9Ip0",
196
+ * "issuedTokenType": "urn:ietf:params:oauth:token-type:refresh_token",
197
+ * "refreshToken": "aorvJYubGpU6i91YnH7Mfo-AT2fIVa1zCfA_Rvq9yjVKIP3onFmmykuQ7E93y2I-9Nyj-A_sVvMufaLNL0bqnDRtgAkc0:MGUCMFrRsktMRVlWaOR70XGMFGLL0SlcCw4DiYveIiOVx1uK9BbD0gvAddsW3UTLozXKMgIxAJ3qxUvjpnlLIOaaKOoa/FuNgqJVvr9GMwDtnAtlh9iZzAkEXAMPLEREFRESHTOKEN",
198
+ * "scope": [
199
+ * "openid",
200
+ * "aws",
201
+ * "sts:identity_context"
202
+ * ],
203
+ * "tokenType": "Bearer"
204
+ * }
205
+ * *\/
206
+ * // example id: create-token-with-iam-for-jwt-bearer
207
+ * ```
208
+ *
209
+ * @example Call OAuth/OIDC /token endpoint for Token Exchange grant with IAM authentication
210
+ * ```javascript
211
+ * //
212
+ * const input = {
213
+ * "clientId": "arn:aws:sso::123456789012:application/ssoins-111111111111/apl-222222222222",
214
+ * "grantType": "urn:ietf:params:oauth:grant-type:token-exchange",
215
+ * "requestedTokenType": "urn:ietf:params:oauth:token-type:access_token",
216
+ * "subjectToken": "aoak-Hig8TUDPNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZDIFFERENTACCESSTOKEN",
217
+ * "subjectTokenType": "urn:ietf:params:oauth:token-type:access_token"
218
+ * };
219
+ * const command = new CreateTokenWithIAMCommand(input);
220
+ * const response = await client.send(command);
221
+ * /* response ==
222
+ * {
223
+ * "accessToken": "aoal-YigITUDiNX1xZwOMXM5MxOWDL0E0jg9P6_C_jKQPxS_SKCP6f0kh1Up4g7TtvQqkMnD-GJiU_S1gvug6SrggAkc0:MGYCMQD3IatVjV7jAJU91kK3PkS/SfA2wtgWzOgZWDOR7sDGN9t0phCZz5It/aes/3C1Zj0CMQCKWOgRaiz6AIhza3DSXQNMLjRKXC8F8ceCsHlgYLMZ7hZidEXAMPLEACCESSTOKEN",
224
+ * "expiresIn": 1579729529,
225
+ * "idToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhd3M6aWRlbnRpdHlfc3RvcmVfaWQiOiJkLTMzMzMzMzMzMzMiLCJzdWIiOiI3MzA0NDhmMi1lMGExLTcwYTctYzk1NC0wMDAwMDAwMDAwMDAiLCJhd3M6aW5zdGFuY2VfYWNjb3VudCI6IjExMTExMTExMTExMSIsInN0czppZGVudGl0eV9jb250ZXh0IjoiRVhBTVBMRUlERU5USVRZQ09OVEVYVCIsImlzcyI6Imh0dHBzOi8vaWRlbnRpdHljZW50ZXIuYW1hem9uYXdzLmNvbS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmlkZW50aXR5X3N0b3JlX2FybiI6ImFybjphd3M6aWRlbnRpdHlzdG9yZTo6MTExMTExMTExMTExOmlkZW50aXR5c3RvcmUvZC0zMzMzMzMzMzMzIiwiYXVkIjoiYXJuOmF3czpzc286OjEyMzQ1Njc4OTAxMjphcHBsaWNhdGlvbi9zc29pbnMtMTExMTExMTExMTExL2FwbC0yMjIyMjIyMjIyMjIiLCJhd3M6aW5zdGFuY2VfYXJuIjoiYXJuOmF3czpzc286OjppbnN0YW5jZS9zc29pbnMtMTExMTExMTExMTExIiwiYXdzOmNyZWRlbnRpYWxfaWQiOiJfWlIyTjZhVkJqMjdGUEtheWpfcEtwVjc3QVBERl80MXB4ZXRfWWpJdUpONlVJR2RBdkpFWEFNUExFQ1JFRElEIiwiYXV0aF90aW1lIjoiMjAyMC0wMS0yMlQxMjo0NToyOVoiLCJleHAiOjE1Nzk3Mjk1MjksImlhdCI6MTU3OTcyNTkyOX0.5SYiW1kMsuUr7nna-l5tlakM0GNbMHvIM2_n0QD23jM",
226
+ * "issuedTokenType": "urn:ietf:params:oauth:token-type:access_token",
227
+ * "scope": [
228
+ * "openid",
229
+ * "aws",
230
+ * "sts:identity_context"
231
+ * ],
232
+ * "tokenType": "Bearer"
233
+ * }
234
+ * *\/
235
+ * // example id: create-token-with-iam-for-token-exchange
236
+ * ```
237
+ *
120
238
  */
121
239
  export declare class CreateTokenWithIAMCommand extends $Command<CreateTokenWithIAMCommandInput, CreateTokenWithIAMCommandOutput, SSOOIDCClientResolvedConfig> {
122
240
  readonly input: CreateTokenWithIAMCommandInput;
package/dist-types/commands/RegisterClientCommand.d.ts CHANGED
@@ -75,6 +75,30 @@ export interface RegisterClientCommandOutput extends RegisterClientResponse, __M
75
75
  * @throws {@link SSOOIDCServiceException}
76
76
  * <p>Base exception class for all service exceptions from SSOOIDC service.</p>
77
77
  *
78
+ * @example Call OAuth/OIDC /register-client endpoint
79
+ * ```javascript
80
+ * //
81
+ * const input = {
82
+ * "clientName": "My IDE Plugin",
83
+ * "clientType": "public",
84
+ * "scopes": [
85
+ * "sso:account:access",
86
+ * "codewhisperer:completions"
87
+ * ]
88
+ * };
89
+ * const command = new RegisterClientCommand(input);
90
+ * const response = await client.send(command);
91
+ * /* response ==
92
+ * {
93
+ * "clientId": "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID",
94
+ * "clientIdIssuedAt": 1579725929,
95
+ * "clientSecret": "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0",
96
+ * "clientSecretExpiresAt": 1587584729
97
+ * }
98
+ * *\/
99
+ * // example id: register-client
100
+ * ```
101
+ *
78
102
  */
79
103
  export declare class RegisterClientCommand extends $Command<RegisterClientCommandInput, RegisterClientCommandOutput, SSOOIDCClientResolvedConfig> {
80
104
  readonly input: RegisterClientCommandInput;
package/dist-types/commands/StartDeviceAuthorizationCommand.d.ts CHANGED
@@ -79,6 +79,29 @@ export interface StartDeviceAuthorizationCommandOutput extends StartDeviceAuthor
79
79
  * @throws {@link SSOOIDCServiceException}
80
80
  * <p>Base exception class for all service exceptions from SSOOIDC service.</p>
81
81
  *
82
+ * @example Call OAuth/OIDC /start-device-authorization endpoint
83
+ * ```javascript
84
+ * //
85
+ * const input = {
86
+ * "clientId": "_yzkThXVzLWVhc3QtMQEXAMPLECLIENTID",
87
+ * "clientSecret": "VERYLONGSECRETeyJraWQiOiJrZXktMTU2NDAyODA5OSIsImFsZyI6IkhTMzg0In0",
88
+ * "startUrl": "https://identitycenter.amazonaws.com/ssoins-111111111111"
89
+ * };
90
+ * const command = new StartDeviceAuthorizationCommand(input);
91
+ * const response = await client.send(command);
92
+ * /* response ==
93
+ * {
94
+ * "deviceCode": "yJraWQiOiJrZXktMTU2Njk2ODA4OCIsImFsZyI6IkhTMzIn0EXAMPLEDEVICECODE",
95
+ * "expiresIn": 1579729529,
96
+ * "interval": 1,
97
+ * "userCode": "makdfsk83yJraWQiOiJrZXktMTU2Njk2sImFsZyI6IkhTMzIn0EXAMPLEUSERCODE",
98
+ * "verificationUri": "https://device.sso.us-west-2.amazonaws.com",
99
+ * "verificationUriComplete": "https://device.sso.us-west-2.amazonaws.com?user_code=makdfsk83yJraWQiOiJrZXktMTU2Njk2sImFsZyI6IkhTMzIn0EXAMPLEUSERCODE"
100
+ * }
101
+ * *\/
102
+ * // example id: start-device-authorization
103
+ * ```
104
+ *
82
105
  */
83
106
  export declare class StartDeviceAuthorizationCommand extends $Command<StartDeviceAuthorizationCommandInput, StartDeviceAuthorizationCommandOutput, SSOOIDCClientResolvedConfig> {
84
107
  readonly input: StartDeviceAuthorizationCommandInput;
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.454.0",
4
+ "version": "3.458.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",
@@ -21,9 +21,9 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.454.0",
24
+ "@aws-sdk/client-sts": "3.458.0",
25
25
  "@aws-sdk/core": "3.451.0",
26
- "@aws-sdk/credential-provider-node": "3.451.0",
26
+ "@aws-sdk/credential-provider-node": "3.458.0",
27
27
  "@aws-sdk/middleware-host-header": "3.451.0",
28
28
  "@aws-sdk/middleware-logger": "3.451.0",
29
29
  "@aws-sdk/middleware-recursion-detection": "3.451.0",