IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a\nnative application) to register with IAM Identity Center. The service also enables the client to fetch the\nuser’s access token upon successful authentication and authorization with IAM Identity Center.
\n\nAPI namespaces\n
\nIAM Identity Center uses the sso and identitystore API namespaces. IAM Identity Center\nOpenID Connect uses the sso-oauth namespace.
\nConsiderations for using this guide\n
\nBefore you begin using this guide, we recommend that you first review the following\nimportant information about how the IAM Identity Center OIDC service works.
\nThe IAM Identity Center OIDC service currently implements only the portions of the OAuth 2.0 Device\nAuthorization Grant standard (https://tools.ietf.org/html/rfc8628) that are necessary to enable single\nsign-on authentication with the CLI.
\nWith older versions of the CLI, the service only emits OIDC access tokens, so to\nobtain a new token, users must explicitly re-authenticate. To access the OIDC flow that\nsupports token refresh and doesn’t require re-authentication, update to the latest CLI\nversion (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh\nand configurable IAM Identity Center session durations. For more information, see Configure Amazon Web Services access portal session duration .
\nThe access tokens provided by this service grant access to all Amazon Web Services account\nentitlements assigned to an IAM Identity Center user, not just a particular application.
\nThe documentation in this guide does not describe the mechanism to convert the access\ntoken into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service\nendpoints. For more information, see GetRoleCredentials in the IAM Identity Center Portal API Reference\nGuide.
\nFor general information about IAM Identity Center, see What is\nIAM Identity Center? in the IAM Identity Center User Guide.
\n\n## Installing\n\nTo install this package, use the CLI of your favorite package manager:\n\n- `npm install @aws-sdk/client-sso-oidc`\n- `yarn add @aws-sdk/client-sso-oidc`\n- `pnpm add @aws-sdk/client-sso-oidc`\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands.\nTo send a request, you only need to import the `SSOOIDCClient` and\nthe commands you need, for example `CreateTokenCommand`:\n\n```js\n// ES5 example\nconst { SSOOIDCClient, CreateTokenCommand } = require(\"@aws-sdk/client-sso-oidc\");\n```\n\n```ts\n// ES6+ example\nimport { SSOOIDCClient, CreateTokenCommand } from \"@aws-sdk/client-sso-oidc\";\n```\n\n### Usage\n\nTo send a request:\n\n- Instantiate a client with configuration (e.g. credentials, region).\n - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.\n - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.\n- Instantiate a command with input parameters.\n- Call the `send` operation on the client, providing the command object as input.\n\n```js\nconst client = new SSOOIDCClient({ region: \"REGION\" });\n\nconst params = { /** input parameters */ };\nconst command = new CreateTokenCommand(params);\n```\n\n#### Async/await\n\nWe recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)\noperator to wait for the promise returned by send operation as follows:\n\n```js\n// async/await.\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n // error handling.\n} finally {\n // finally.\n}\n```\n\n#### Promises\n\nYou can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).\n\n```js\nclient\n .send(command)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n })\n .finally(() => {\n // finally.\n });\n```\n\n#### Aggregated client\n\nThe aggregated client class is exported from the same package, but without the \"Client\" suffix.\n\n`SSOOIDC` extends `SSOOIDCClient` and additionally supports all operations, waiters, and paginators as methods.\nThis style may be familiar to you from the AWS SDK for JavaScript v2.\n\nIf you are bundling the AWS SDK, we recommend using only the bare-bones client (`SSOOIDCClient`).\nMore details are in the blog post on\n[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).\n\n```ts\nimport { SSOOIDC } from \"@aws-sdk/client-sso-oidc\";\n\nconst client = new SSOOIDC({ region: \"REGION\" });\n\n// async/await.\ntry {\n const data = await client.createToken(params);\n // process data.\n} catch (error) {\n // error handling.\n}\n\n// Promises.\nclient\n .createToken(params)\n .then((data) => {\n // process data.\n })\n .catch((error) => {\n // error handling.\n });\n\n// callbacks (not recommended).\nclient.createToken(params, (err, data) => {\n // process err and data.\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information,\nas well as response metadata (e.g. request id).\n\n```js\ntry {\n const data = await client.send(command);\n // process data.\n} catch (error) {\n const { requestId, cfId, extendedRequestId } = error.$metadata;\n console.log({ requestId, cfId, extendedRequestId });\n /**\n * The keys within exceptions are also parsed.\n * You can access them by specifying exception names:\n * if (error.name === 'SomeServiceException') {\n * const value = error.specialKeyInException;\n * }\n */\n}\n```\n\nSee also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).\n\n## Getting Help\n\nPlease use these community resources for getting help.\nWe use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.\n\n- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)\n or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).\n- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)\n on AWS Developer Blog.\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`.\n- Join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3).\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues/new/choose).\n\nTo test your universal JavaScript code in Node.js, browser and react-native environments,\nvisit our [code samples repo](https://github.com/aws-samples/aws-sdk-js-tests).\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/client-sso-oidc` package is updated.\nTo contribute to client you can check our [generate clients scripts](https://github.com/aws/aws-sdk-js-v3/tree/main/scripts/generate-clients).\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n## Client Commands (Operations List)\n\n