VictoriaMetrics/vendor/github.com/aws/aws-sdk-go-v2/service/ssooidc/doc.go

39 lines
2.5 KiB
Go
Raw Normal View History

// Code generated by smithy-go-codegen DO NOT EDIT.
2023-05-10 08:16:43 +02:00
// Package ssooidc provides the API client, operations, and parameter types for
// AWS SSO OIDC.
//
2023-12-11 09:48:36 +01:00
// IAM Identity Center OpenID Connect (OIDC) is a web service that enables a
// client (such as CLI or a native application) to register with IAM Identity
// Center. The service also enables the client to fetch the users access token
// upon successful authentication and authorization with IAM Identity Center. IAM
// Identity Center uses the sso and identitystore API namespaces. 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.
2023-05-10 08:16:43 +02:00
// - 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) )
2023-12-11 09:48:36 +01:00
// that are necessary to enable single sign-on authentication with the CLI.
// - With older versions of the CLI, the service only emits OIDC access tokens,
// so to obtain a new token, users must explicitly re-authenticate. To access the
// OIDC flow that supports token refresh and doesnt require re-authentication,
// update to the latest CLI version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with
// support for OIDC token refresh and configurable IAM Identity Center session
// durations. For more information, see Configure Amazon Web Services access
// portal session duration (https://docs.aws.amazon.com/singlesignon/latest/userguide/configure-user-session.html)
// .
// - The access tokens provided by this service grant access to all Amazon Web
// Services account entitlements assigned to an IAM Identity Center user, not just
// a particular application.
2023-05-10 08:16:43 +02:00
// - The documentation in this guide does not describe the mechanism to convert
2023-12-11 09:48:36 +01:00
// the access token into Amazon Web Services Auth (“sigv4”) credentials for use
// with IAM-protected Amazon Web Services service endpoints. For more information,
// see GetRoleCredentials (https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html)
2023-05-10 08:16:43 +02:00
// in the IAM Identity Center Portal API Reference Guide.
2022-10-01 16:18:50 +02:00
//
2023-05-10 08:16:43 +02:00
// 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