AWS cognito documentation change
Summary
Restructured API documentation section, added hyperlinks to API references, and updated section titles
Security assessment
The changes improve documentation structure and navigation by adding API links but do not introduce new security content or address vulnerabilities. Security-related APIs (e.g., SetRiskConfiguration) were already documented and only received formatting updates.
Diff
diff --git a/cognito/latest/developerguide/authentication-flows-public-server-side.md b/cognito/latest/developerguide/authentication-flows-public-server-side.md index 869cfbd38..71cc2b259 100644 --- a//cognito/latest/developerguide/authentication-flows-public-server-side.md +++ b//cognito/latest/developerguide/authentication-flows-public-server-side.md @@ -5 +5 @@ -Server-side authentication optionsClient-side authentication optionsUsing the API and endpoints +Server-side authentication optionsClient-side authentication optionsUsing the API and endpointsList of operations by authorization model @@ -58,0 +59,2 @@ A user authenticates by answering successive challenges until authentication eit + * List of API operations grouped by authorization model + @@ -216 +218 @@ The user pools API and managed login pages support a variety of scenarios, descr -### Amazon Cognito user pools authenticated and unauthenticated API operations +## List of API operations grouped by authorization model @@ -230,49 +232,49 @@ IAM-authorized management operations -`AddCustomAttributes` -`CreateGroup` -`CreateIdentityProvider` -`CreateResourceServer` -`CreateUserImportJob` -`CreateUserPool` -`CreateUserPoolClient` -`CreateUserPoolDomain` -`DeleteGroup` -`DeleteIdentityProvider` -`DeleteResourceServer` -`DeleteUserPool` -`DeleteUserPoolClient` -`DeleteUserPoolDomain` -`DescribeIdentityProvider` -`DescribeResourceServer` -`DescribeRiskConfiguration` -`DescribeUserImportJob` -`DescribeUserPool` -`DescribeUserPoolClient` -`DescribeUserPoolDomain` -`GetCSVHeader` -`GetGroup` -`GetIdentityProviderByIdentifier` -`GetSigningCertificate` -`GetUICustomization` -`GetUserPoolMfaConfig` -`ListGroups` -`ListIdentityProviders` -`ListResourceServers` -`ListTagsForResource` -`ListUserImportJobs` -`ListUserPoolClients` -`ListUserPools` -`ListUsers` -`ListUsersInGroup` -`SetRiskConfiguration` -`SetUICustomization` -`SetUserPoolMfaConfig` -`StartUserImportJob` -`StopUserImportJob` -`TagResource` -`UntagResource` -`UpdateGroup` -`UpdateIdentityProvider` -`UpdateResourceServer` -`UpdateUserPool` -`UpdateUserPoolClient` -`UpdateUserPoolDomain` +[AddCustomAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AddCustomAttributes.html) +[CreateGroup](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateGroup.html) +[CreateIdentityProvider](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateIdentityProvider.html) +[CreateResourceServer](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateResourceServer.html) +[CreateUserImportJob](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserImportJob.html) +[CreateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html) +[CreateUserPoolClient](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPoolClient.html) +[CreateUserPoolDomain](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPoolDomain.html) +[DeleteGroup](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DeleteGroup.html) +[DeleteIdentityProvider](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DeleteIdentityProvider.html) +[DeleteResourceServer](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DeleteResourceServer.html) +[DeleteUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DeleteUserPool.html) +[DeleteUserPoolClient](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DeleteUserPoolClient.html) +[DeleteUserPoolDomain](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DeleteUserPoolDomain.html) +[DescribeIdentityProvider](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeIdentityProvider.html) +[DescribeResourceServer](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeResourceServer.html) +[DescribeRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html) +[DescribeUserImportJob](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserImportJob.html) +[DescribeUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html) +[DescribeUserPoolClient](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolClient.html) +[DescribeUserPoolDomain](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPoolDomain.html) +[GetCSVHeader](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetCSVHeader.html) +[GetGroup](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetGroup.html) +[GetIdentityProviderByIdentifier](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetIdentityProviderByIdentifier.html) +[GetSigningCertificate](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetSigningCertificate.html) +[GetUICustomization](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUICustomization.html) +[GetUserPoolMfaConfig](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html) +[ListGroups](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListGroups.html) +[ListIdentityProviders](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListIdentityProviders.html) +[ListResourceServers](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListResourceServers.html) +[ListTagsForResource](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListTagsForResource.html) +[ListUserImportJobs](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUserImportJobs.html) +[ListUserPoolClients](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUserPoolClients.html) +[ListUserPools](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUserPools.html) +[ListUsers](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUsers.html) +[ListUsersInGroup](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ListUsersInGroup.html) +[SetRiskConfiguration](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html) +[SetUICustomization](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUICustomization.html) +[SetUserPoolMfaConfig](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html) +[StartUserImportJob](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_StartUserImportJob.html) +[StopUserImportJob](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_StopUserImportJob.html) +[TagResource](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_TagResource.html) +[UntagResource](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UntagResource.html) +[UpdateGroup](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateGroup.html) +[UpdateIdentityProvider](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateIdentityProvider.html) +[UpdateResourceServer](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateResourceServer.html) +[UpdateUserPool](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html) +[UpdateUserPoolClient](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPoolClient.html) +[UpdateUserPoolDomain](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPoolDomain.html) @@ -290,26 +292,26 @@ IAM-authorized user operations -`AdminAddUserToGroup` -`AdminConfirmSignUp` -`AdminCreateUser` -`AdminDeleteUser` -`AdminDeleteUserAttributes` -`AdminDisableProviderForUser` -`AdminDisableUser` -`AdminEnableUser` -`AdminForgetDevice` -`AdminGetDevice` -`AdminGetUser` -`AdminInitiateAuth` -`AdminLinkProviderForUser` -`AdminListDevices` -`AdminListGroupsForUser` -`AdminListUserAuthEvents` -`AdminRemoveUserFromGroup` -`AdminResetUserPassword` -`AdminRespondToAuthChallenge` -`AdminSetUserMFAPreference` -`AdminSetUserPassword` -`AdminSetUserSettings` -`AdminUpdateAuthEventFeedback` -`AdminUpdateDeviceStatus` -`AdminUpdateUserAttributes` -`AdminUserGlobalSignOut` +[AdminAddUserToGroup](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminAddUserToGroup.html) +[AdminConfirmSignUp](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminConfirmSignUp.html) +[AdminCreateUser](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminCreateUser.html) +[AdminDeleteUser](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminDeleteUser.html) +[AdminDeleteUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminDeleteUserAttributes.html) +[AdminDisableProviderForUser](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminDisableProviderForUser.html) +[AdminDisableUser](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminDisableUser.html) +[AdminEnableUser](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminEnableUser.html) +[AdminForgetDevice](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminForgetDevice.html) +[AdminGetDevice](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminGetDevice.html) +[AdminGetUser](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminGetUser.html) +[AdminInitiateAuth](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminInitiateAuth.html) +[AdminLinkProviderForUser](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminLinkProviderForUser.html) +[AdminListDevices](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListDevices.html) +[AdminListGroupsForUser](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListGroupsForUser.html) +[AdminListUserAuthEvents](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminListUserAuthEvents.html) +[AdminRemoveUserFromGroup](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRemoveUserFromGroup.html) +[AdminResetUserPassword](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminResetUserPassword.html) +[AdminRespondToAuthChallenge](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminRespondToAuthChallenge.html) +[AdminSetUserMFAPreference](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserMFAPreference.html) +[AdminSetUserPassword](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserPassword.html) +[AdminSetUserSettings](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminSetUserSettings.html) +[AdminUpdateAuthEventFeedback](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateAuthEventFeedback.html) +[AdminUpdateDeviceStatus](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateDeviceStatus.html) +[AdminUpdateUserAttributes](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUpdateUserAttributes.html) +[AdminUserGlobalSignOut](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_AdminUserGlobalSignOut.html) @@ -327,6 +329,6 @@ Unauthenticated user operations -`SignUp` -`ConfirmSignUp` -`ResendConfirmationCode` -`ForgotPassword` -`ConfirmForgotPassword` -`InitiateAuth` +[SignUp](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SignUp.html) +[ConfirmSignUp](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmSignUp.html) +[ResendConfirmationCode](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ResendConfirmationCode.html) +[ForgotPassword](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ForgotPassword.html) +[ConfirmForgotPassword](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_ConfirmForgotPassword.html) +[InitiateAuth](https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_InitiateAuth.html) @@ -344,26 +346,27 @@ Token-authorized user operations | AccessToken | Session -`RespondToAuthChallenge` | | ✓ -`ChangePassword` | ✓ | -`GetUser` | ✓ | -`StartWebAuthnRegistration` | ✓ | -`CompleteWebAuthnRegistration` | ✓ | -`DeleteWebAuthnCredential` | ✓ | -`ListWebAuthnCredentials` | ✓ | -`UpdateUserAttributes` | ✓ | -`DeleteUserAttributes` | ✓ | -`DeleteUser` | ✓ | -`ConfirmDevice` | ✓ | -`ForgetDevice` | ✓ | -`GetDevice` | ✓ | -`ListDevices` | ✓ | -`UpdateDeviceStatus` | ✓ | -`GetUserAttributeVerificationCode` | ✓ | -`VerifyUserAttribute` | ✓ | -`SetUserSettings` | ✓ | -`SetUserMFAPreference` | ✓ | -`GlobalSignOut` | ✓ | -`UpdateAuthEventFeedback` | | ✓