doc.go

 1// Code generated by smithy-go-codegen DO NOT EDIT.
 2
 3// Package ssooidc provides the API client, operations, and parameter types for
 4// AWS SSO OIDC.
 5//
 6// IAM Identity Center OpenID Connect (OIDC) is a web service that enables a
 7// client (such as CLI or a native application) to register with IAM Identity
 8// Center. The service also enables the client to fetch the user’s access token
 9// upon successful authentication and authorization with IAM Identity Center.
10//
11// IAM Identity Center uses the sso and identitystore API namespaces.
12//
13// # Considerations for Using This Guide
14//
15// Before you begin using this guide, we recommend that you first review the
16// following important information about how the IAM Identity Center OIDC service
17// works.
18//
19//   - The IAM Identity Center OIDC service currently implements only the portions
20//     of the OAuth 2.0 Device Authorization Grant standard ([https://tools.ietf.org/html/rfc8628] ) that are necessary to
21//     enable single sign-on authentication with the CLI.
22//
23//   - With older versions of the CLI, the service only emits OIDC access tokens,
24//     so to obtain a new token, users must explicitly re-authenticate. To access the
25//     OIDC flow that supports token refresh and doesn’t require re-authentication,
26//     update to the latest CLI version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with
27//     support for OIDC token refresh and configurable IAM Identity Center session
28//     durations. For more information, see [Configure Amazon Web Services access portal session duration].
29//
30//   - The access tokens provided by this service grant access to all Amazon Web
31//     Services account entitlements assigned to an IAM Identity Center user, not just
32//     a particular application.
33//
34//   - The documentation in this guide does not describe the mechanism to convert
35//     the access token into Amazon Web Services Auth (“sigv4”) credentials for use
36//     with IAM-protected Amazon Web Services service endpoints. For more information,
37//     see [GetRoleCredentials]in the IAM Identity Center Portal API Reference Guide.
38//
39// For general information about IAM Identity Center, see [What is IAM Identity Center?] in the IAM Identity
40// Center User Guide.
41//
42// [Configure Amazon Web Services access portal session duration]: https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html
43// [GetRoleCredentials]: https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html
44// [https://tools.ietf.org/html/rfc8628]: https://tools.ietf.org/html/rfc8628
45// [What is IAM Identity Center?]: https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html
46package ssooidc