aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/github.com/aws/aws-sdk-go-v2/service/ssooidc/doc.go
blob: 2239427d8898b08cfa31934edab13ff8a1645899 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
// Code generated by smithy-go-codegen DO NOT EDIT.

// Package ssooidc provides the API client, operations, and parameter types for
// AWS SSO OIDC.
//
// AWS IAM Identity Center (successor to AWS Single Sign-On) OpenID Connect (OIDC)
// is a web service that enables a client (such as AWS 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. Although AWS Single Sign-On was renamed, the sso and
// identitystore API namespaces will continue to retain their original name for
// backward compatibility purposes. For more information, see IAM Identity Center
// rename (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed)
// . Considerations for Using This Guide Before you begin using this guide, we
// recommend that you first review the following important information about how
// the IAM Identity Center OIDC service works.
//   - The IAM Identity Center OIDC service currently implements only the portions
//     of the OAuth 2.0 Device Authorization Grant standard (
//     https://tools.ietf.org/html/rfc8628 (https://tools.ietf.org/html/rfc8628) )
//     that are necessary to enable single sign-on authentication with the AWS CLI.
//     Support for other OIDC flows frequently needed for native applications, such as
//     Authorization Code Flow (+ PKCE), will be addressed in future releases.
//   - The service emits only OIDC access tokens, such that obtaining a new token
//     (For example, token refresh) requires explicit user re-authentication.
//   - The access tokens provided by this service grant access to all AWS account
//     entitlements assigned to an IAM Identity Center user, not just a particular
//     application.
//   - The documentation in this guide does not describe the mechanism to convert
//     the access token into AWS Auth (“sigv4”) credentials for use with IAM-protected
//     AWS service endpoints. For more information, see GetRoleCredentials (https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html)
//     in the IAM Identity Center Portal API Reference Guide.
//
// For general information about IAM Identity Center, see What is IAM Identity
// Center? (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html)
// in the IAM Identity Center User Guide.
package ssooidc