AWS SSO OIDC Update: Documentation updates to reflect service rename - AWS IAM Identity Center (successor to AWS Single Sign-On)

Author: AWS

.changes/next-release/feature-AWSSSOOIDC-cc6f8e0.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AWS SSO OIDC",
+    "contributor": "",
+    "description": "Documentation updates to reflect service rename - AWS IAM Identity Center (successor to AWS Single Sign-On)"
+}

services/ssooidc/src/main/resources/codegen-resources/service-2.json

@@ -34,7 +34,7 @@
         {"shape":"ExpiredTokenException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<p>Creates and returns an access token for the authorized client. The access token issued will be used to fetch short-term credentials for the assigned roles in the AWS account.</p>",
+      "documentation":"<p>Creates and returns an access token for the authorized client. The access token issued will be used to fetch short-term credentials for the assigned roles in the Amazon Web Services account.</p>",
       "authtype":"none"
     },
     "RegisterClient":{
@@ -51,7 +51,7 @@
         {"shape":"InvalidClientMetadataException"},
         {"shape":"InternalServerException"}
       ],
-      "documentation":"<p>Registers a client with AWS SSO. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.</p>",
+      "documentation":"<p>Registers a client with Amazon Web Services SSO. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.</p>",
       "authtype":"none"
     },
     "StartDeviceAuthorization":{
@@ -119,7 +119,7 @@
         },
         "grantType":{
           "shape":"GrantType",
-          "documentation":"<p>Supports grant types for authorization code, refresh token, and device code request.</p>"
+          "documentation":"<p>Supports grant types for the authorization code, refresh token, and device code request. For device code requests, specify the following value:</p> <p> <code>urn:ietf:params:oauth:grant-type:<i>device_code</i> </code> </p> <p>For information about how to obtain the device code, see the <a>StartDeviceAuthorization</a> topic.</p>"
         },
         "deviceCode":{
           "shape":"DeviceCode",
@@ -131,7 +131,7 @@
         },
         "refreshToken":{
           "shape":"RefreshToken",
-          "documentation":"<p>The token used to obtain an access token in the event that the access token is invalid or expired. This token is not issued by the service.</p>"
+          "documentation":"<p>Currently, <code>refreshToken</code> is not yet implemented and is not supported. For more information about the features and limitations of the current Amazon Web Services SSO OIDC implementation, see <i>Considerations for Using this Guide</i> in the <a href=\"https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html\">Amazon Web Services SSO OIDC API Reference</a>.</p> <p>The token used to obtain an access token in the event that the access token is invalid or expired.</p>"
         },
         "scope":{
           "shape":"Scopes",
@@ -148,7 +148,7 @@
       "members":{
         "accessToken":{
           "shape":"AccessToken",
-          "documentation":"<p>An opaque token to access AWS SSO resources assigned to a user.</p>"
+          "documentation":"<p>An opaque token to access Amazon Web Services SSO resources assigned to a user.</p>"
         },
         "tokenType":{
           "shape":"TokenType",
@@ -160,11 +160,11 @@
         },
         "refreshToken":{
           "shape":"RefreshToken",
-          "documentation":"<p>A token that, if present, can be used to refresh a previously issued access token that might have expired.</p>"
+          "documentation":"<p>Currently, <code>refreshToken</code> is not yet implemented and is not supported. For more information about the features and limitations of the current Amazon Web Services SSO OIDC implementation, see <i>Considerations for Using this Guide</i> in the <a href=\"https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html\">Amazon Web Services SSO OIDC API Reference</a>.</p> <p>A token that, if present, can be used to refresh a previously issued access token that might have expired.</p>"
         },
         "idToken":{
           "shape":"IdToken",
-          "documentation":"<p>The identifier of the user that associated with the access token, if present.</p>"
+          "documentation":"<p>Currently, <code>idToken</code> is not yet implemented and is not supported. For more information about the features and limitations of the current Amazon Web Services SSO OIDC implementation, see <i>Considerations for Using this Guide</i> in the <a href=\"https://docs.aws.amazon.com/singlesignon/latest/OIDCAPIReference/Welcome.html\">Amazon Web Services SSO OIDC API Reference</a>.</p> <p>The identifier of the user that associated with the access token, if present.</p>"
         }
       }
     },
@@ -323,15 +323,15 @@
       "members":{
         "clientId":{
           "shape":"ClientId",
-          "documentation":"<p>The unique identifier string for the client that is registered with AWS SSO. This value should come from the persisted result of the <a>RegisterClient</a> API operation.</p>"
+          "documentation":"<p>The unique identifier string for the client that is registered with Amazon Web Services SSO. This value should come from the persisted result of the <a>RegisterClient</a> API operation.</p>"
         },
         "clientSecret":{
           "shape":"ClientSecret",
           "documentation":"<p>A secret string that is generated for the client. This value should come from the persisted result of the <a>RegisterClient</a> API operation.</p>"
         },
         "startUrl":{
           "shape":"URI",
-          "documentation":"<p>The URL for the AWS SSO user portal. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html\">Using the User Portal</a> in the <i>AWS Single Sign-On User Guide</i>.</p>"
+          "documentation":"<p>The URL for the AWS access portal. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/using-the-portal.html\">Using the AWS access portal</a> in the <i>Amazon Web Services SSO User Guide</i>.</p>"
         }
       }
     },
@@ -388,5 +388,5 @@
     },
     "UserCode":{"type":"string"}
   },
-  "documentation":"<p>AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client (such as AWS CLI or a native application) to register with AWS SSO. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of the device authorization grant standard (<a href=\"https://tools.ietf.org/html/rfc8628\">https://tools.ietf.org/html/rfc8628</a>).</p> <p>For general information about AWS SSO, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html\">What is AWS Single Sign-On?</a> in the <i>AWS SSO User Guide</i>.</p> <p>This API reference guide describes the AWS SSO OIDC operations that you can call programatically and includes detailed information on data types and errors.</p> <note> <p>AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a convenient way to create programmatic access to AWS SSO and other AWS services. For more information about the AWS SDKs, including how to download and install them, see <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a>.</p> </note>"
+  "documentation":"<p>Amazon Web Services Single Sign On OpenID Connect (OIDC) is a web service that enables a client (such as Amazon Web Services CLI or a native application) to register with Amazon Web Services SSO. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with Amazon Web Services SSO.</p> <note> <p>Although Amazon Web Services Single Sign-On was renamed, the <code>sso</code> and <code>identitystore</code> API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed\">Amazon Web Services SSO rename</a>.</p> </note> <p> <b>Considerations for Using This Guide</b> </p> <p>Before you begin using this guide, we recommend that you first review the following important information about how the Amazon Web Services SSO OIDC service works.</p> <ul> <li> <p>The Amazon Web Services SSO OIDC service currently implements only the portions of the OAuth 2.0 Device Authorization Grant standard (<a href=\"https://tools.ietf.org/html/rfc8628\">https://tools.ietf.org/html/rfc8628</a>) 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.</p> </li> <li> <p>The service emits only OIDC access tokens, such that obtaining a new token (For example, token refresh) requires explicit user re-authentication.</p> </li> <li> <p>The access tokens provided by this service grant access to all AWS account entitlements assigned to an Amazon Web Services SSO user, not just a particular application.</p> </li> <li> <p>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 <a href=\"https://docs.aws.amazon.com/singlesignon/latest/PortalAPIReference/API_GetRoleCredentials.html\">GetRoleCredentials</a> in the <i>Amazon Web Services SSO Portal API Reference Guide</i>.</p> </li> </ul> <p>For general information about Amazon Web Services SSO, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html\">What is Amazon Web Services SSO?</a> in the <i>Amazon Web Services SSO User Guide</i>.</p>"
 }