Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.
Esempi di Amazon Cognito Identity Provider utilizzando AWS CLI
I seguenti esempi di codice mostrano come eseguire azioni e implementare scenari comuni utilizzando Amazon Cognito Identity Provider. AWS Command Line Interface
Le azioni sono estratti di codice da programmi più grandi e devono essere eseguite nel contesto. Sebbene le azioni mostrino come richiamare le singole funzioni del servizio, è possibile visualizzarle contestualizzate negli scenari correlati.
Ogni esempio include un link al codice sorgente completo, in cui vengono fornite le istruzioni su come configurare ed eseguire il codice nel contesto.
Argomenti
Azioni
Il seguente esempio di codice mostra come usareadd-custom-attributes.
- AWS CLI
-
Come aggiungere un attributo personalizzato
Questo esempio aggiunge un attributo personalizzato CustomAttr 1 a un pool di utenti. È un tipo stringa e richiede un minimo di 1 carattere e un massimo di 15. Non è obbligatorio.
Comando:
aws cognito-idp add-custom-attributes --user-pool-idus-west-2_aaaaaaaaa--custom-attributes Name="CustomAttr1",AttributeDataType="String",DeveloperOnlyAttribute=false,Required=false,StringAttributeConstraints="{MinLength=1,MaxLength=15}"-
Per i dettagli sull'API, vedere AddCustomAttributes
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-add-user-to-group.
- AWS CLI
-
Come aggiungere un utente a un gruppo
Questo esempio aggiunge l'utente Jane al gruppo MyGroup.
Comando:
aws cognito-idp admin-add-user-to-group --user-pool-idus-west-2_aaaaaaaaa--usernameJane--group-nameMyGroup-
Per i dettagli sull'API, consulta AdminAddUserToGroup AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-confirm-sign-up.
- AWS CLI
-
Come confermare la registrazione dell’utente
Questo esempio conferma l’utente jane@example.com.
Comando:
aws cognito-idp admin-confirm-sign-up --user-pool-idus-west-2_aaaaaaaaa--usernamejane@example.com-
Per i dettagli sull'API, consulta AdminConfirmSignUp AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-create-user.
- AWS CLI
-
Come creare un utente
L’esempio
admin-create-userseguente crea un utente con le impostazioni specificate per l’indirizzo e-mail e il numero di telefono.aws cognito-idp admin-create-user \ --user-pool-idus-west-2_aaaaaaaaa\ --usernamediego\ --user-attributesName=email,Value=diego@example.comName=phone_number,Value="+15555551212" \ --message-actionSUPPRESSOutput:
{ "User": { "Username": "diego", "Attributes": [ { "Name": "sub", "Value": "7325c1de-b05b-4f84-b321-9adc6e61f4a2" }, { "Name": "phone_number", "Value": "+15555551212" }, { "Name": "email", "Value": "diego@example.com" } ], "UserCreateDate": 1548099495.428, "UserLastModifiedDate": 1548099495.428, "Enabled": true, "UserStatus": "FORCE_CHANGE_PASSWORD" } }-
Per i dettagli sull'API, consulta AdminCreateUser AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-delete-user-attributes.
- AWS CLI
-
Come eliminare un attributo utente
Questo esempio elimina un attributo personalizzato CustomAttr 1 per l'utente diego@example.com.
Comando:
aws cognito-idp admin-delete-user-attributes --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com--user-attribute-names"custom:CustomAttr1"-
Per i dettagli sull'API, vedere AdminDeleteUserAttributes
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-delete-user.
- AWS CLI
-
Come eliminare un utente
Questo esempio elimina un utente.
Comando:
aws cognito-idp admin-delete-user --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com-
Per i dettagli sull'API, consulta AdminDeleteUser AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-disable-provider-for-user.
- AWS CLI
-
Come scollegare un utente federato da un profilo utente locale
L’esempio
admin-disable-provider-for-userseguente disconnette un utente Google dal profilo locale collegato.aws cognito-idp admin-disable-provider-for-user \ --user-pool-idus-west-2_EXAMPLE\ --userProviderAttributeName=Cognito_Subject,ProviderAttributeValue=0000000000000000,ProviderName=GooglePer ulteriori informazioni, consulta Collegamento di utenti federati a un profilo utente esistente nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta AdminDisableProviderForUser AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-disable-user.
- AWS CLI
-
Come impedire l’accesso da parte di un utente
L’esempio
admin-disable-userseguente impedisce l’accesso da parte dell’utentediego@example.com.aws cognito-idp admin-disable-user \ --user-pool-idus-west-2_EXAMPLE\ --usernamediego@example.comPer ulteriori informazioni, consulta Gestione degli utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta AdminDisableUser AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-enable-user.
- AWS CLI
-
Come abilitare l’accesso da parte di un utente
L’esempio
admin-enable-userseguente abilita l’accesso da parte dell’utente diego@example.com.aws cognito-idp admin-enable-user \ --user-pool-idus-west-2_EXAMPLE\ --usernamediego@example.comPer ulteriori informazioni, consulta Gestione degli utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta AdminEnableUser AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-forget-device.
- AWS CLI
-
Come dimenticare un dispositivo
Questo esempio mostra come dimenticare il dispositivo per il nome utente jane@example.com
Comando:
aws cognito-idp admin-forget-device --user-pool-idus-west-2_aaaaaaaaa--usernamejane@example.com--device-keyus-west-2_abcd_1234-5678-
Per i dettagli sull'API, consulta AdminForgetDevice AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-get-device.
- AWS CLI
-
Come ottenere un dispositivo
L’esempio
admin-get-deviceseguente visualizza un dispositivo per l’utentediego.aws cognito-idp admin-get-device \ --user-pool-idus-west-2_EXAMPLE\ --usernamediego\ --device-keyus-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111Output:
{ "Device": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceAttributes": [ { "Name": "device_status", "Value": "valid" }, { "Name": "device_name", "Value": "MyDevice" }, { "Name": "dev:device_arn", "Value": "arn:aws:cognito-idp:us-west-2:123456789012:owner/diego.us-west-2_EXAMPLE/device/us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, { "Name": "dev:device_owner", "Value": "diego.us-west-2_EXAMPLE" }, { "Name": "last_ip_used", "Value": "192.0.2.1" }, { "Name": "dev:device_remembered_status", "Value": "remembered" }, { "Name": "dev:device_sdk", "Value": "aws-sdk" } ], "DeviceCreateDate": 1715100742.022, "DeviceLastModifiedDate": 1723233651.167, "DeviceLastAuthenticatedDate": 1715100742.0 } }Per ulteriori informazioni, consulta Utilizzo dei dispositivi utente nel pool di utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta AdminGetDevice AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-get-user.
- AWS CLI
-
Come ottenere un utente
Questo esempio mostra come ottenere informazioni sul nome utente jane@example.com.
Comando:
aws cognito-idp admin-get-user --user-pool-idus-west-2_aaaaaaaaa--usernamejane@example.comOutput:
{ "Username": "4320de44-2322-4620-999b-5e2e1c8df013", "Enabled": true, "UserStatus": "FORCE_CHANGE_PASSWORD", "UserCreateDate": 1548108509.537, "UserAttributes": [ { "Name": "sub", "Value": "4320de44-2322-4620-999b-5e2e1c8df013" }, { "Name": "email_verified", "Value": "true" }, { "Name": "phone_number_verified", "Value": "true" }, { "Name": "phone_number", "Value": "+01115551212" }, { "Name": "email", "Value": "jane@example.com" } ], "UserLastModifiedDate": 1548108509.537 }-
Per i dettagli sull'API, consulta AdminGetUser AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-initiate-auth.
- AWS CLI
-
Come accedere come utente admin
L’esempio
admin-initiate-authseguente accede all’utente diego@example.com. Questo esempio include anche metadati per la protezione dalle minacce e ClientMetadata per i trigger Lambda. L’utente è configurato per l’autenticazione a più fattori (MFA) basata su password monouso e riceve una richiesta di verifica che richiede l’immissione di un codice nell’app di autenticazione in uso prima di poter completare l’autenticazione.aws cognito-idp admin-initiate-auth \ --user-pool-idus-west-2_EXAMPLE\ --client-id1example23456789\ --auth-flowADMIN_USER_PASSWORD_AUTH\ --auth-parameters USERNAME=diego@example.com,PASSWORD="My@Example$Password3!",SECRET_HASH=ExampleEncodedClientIdSecretAndUsername= \ --context-data="{\"EncodedData\":\"abc123example\",\"HttpHeaders\":[{\"headerName\":\"UserAgent\",\"headerValue\":\"Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:47.0) Gecko/20100101 Firefox/47.0\"}],\"IpAddress\":\"192.0.2.1\",\"ServerName\":\"example.com\",\"ServerPath\":\"/login\"}" \ --client-metadata="{\"MyExampleKey\": \"MyExampleValue\"}"Output:
{ "ChallengeName": "SOFTWARE_TOKEN_MFA", "Session": "AYABeExample...", "ChallengeParameters": { "FRIENDLY_DEVICE_NAME": "MyAuthenticatorApp", "USER_ID_FOR_SRP": "diego@example.com" } }Per ulteriori informazioni, consulta Flusso di autenticazione amministratore nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta Command AdminInitiateAuth
Reference AWS CLI .
-
Il seguente esempio di codice mostra come utilizzareadmin-link-provider-for-user.
- AWS CLI
-
Come collegare un utente locale a un utente federato
L’esempio
admin-link-provider-for-userseguente collega l’utente locale diego a un utente che eseguirà l’accesso federato con Google.aws cognito-idp admin-link-provider-for-user \ --user-pool-idus-west-2_EXAMPLE\ --destination-userProviderName=Cognito,ProviderAttributeValue=diego\ --source-userProviderAttributeName=Cognito_Subject,ProviderAttributeValue=0000000000000000,ProviderName=GooglePer ulteriori informazioni, consulta Collegamento di utenti federati a un profilo utente esistente nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta AdminLinkProviderForUser AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-list-devices.
- AWS CLI
-
Come elencare i dispositivi per un utente
L’esempio
admin-list-devicesseguente elenca i dispositivi per l’utente diego.aws cognito-idp admin-list-devices \ --user-pool-idus-west-2_EXAMPLE\ --usernamediego\ --limit1Output:
{ "Devices": [ { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceAttributes": [ { "Name": "device_status", "Value": "valid" }, { "Name": "device_name", "Value": "MyDevice" }, { "Name": "dev:device_arn", "Value": "arn:aws:cognito-idp:us-west-2:123456789012:owner/diego.us-west-2_EXAMPLE/device/us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, { "Name": "dev:device_owner", "Value": "diego.us-west-2_EXAMPLE" }, { "Name": "last_ip_used", "Value": "192.0.2.1" }, { "Name": "dev:device_remembered_status", "Value": "remembered" }, { "Name": "dev:device_sdk", "Value": "aws-sdk" } ], "DeviceCreateDate": 1715100742.022, "DeviceLastModifiedDate": 1723233651.167, "DeviceLastAuthenticatedDate": 1715100742.0 } ] }Per ulteriori informazioni, consulta Utilizzo dei dispositivi utente nel pool di utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta AdminListDevices AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-list-groups-for-user.
- AWS CLI
-
Come elencare i gruppi per un utente
Questo esempio elenca i gruppi per il nome utente jane@example.com.
Comando:
aws cognito-idp admin-list-groups-for-user --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.comOutput:
{ "Groups": [ { "Description": "Sample group", "Precedence": 1, "LastModifiedDate": 1548097827.125, "RoleArn": "arn:aws:iam::111111111111:role/SampleRole", "GroupName": "SampleGroup", "UserPoolId": "us-west-2_aaaaaaaaa", "CreationDate": 1548097827.125 } ] }-
Per i dettagli sull'API, consulta AdminListGroupsForUser AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-list-user-auth-events.
- AWS CLI
-
Come elencare gli eventi di autorizzazione per un utente
L’esempio
admin-list-user-auth-eventsseguente elenca l’evento del log delle attività dell’utente più recenti per l’utente diego.aws cognito-idp admin-list-user-auth-events \ --user-pool-idus-west-2_ywDJHlIfU\ --usernamebrcotter+050123\ --max-results1Output:
{ "AuthEvents": [ { "EventId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "EventType": "SignIn", "CreationDate": 1726694203.495, "EventResponse": "InProgress", "EventRisk": { "RiskDecision": "AccountTakeover", "RiskLevel": "Medium", "CompromisedCredentialsDetected": false }, "ChallengeResponses": [ { "ChallengeName": "Password", "ChallengeResponse": "Success" } ], "EventContextData": { "IpAddress": "192.0.2.1", "City": "Seattle", "Country": "United States" } } ], "NextToken": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222#2024-09-18T21:16:43.495Z" }Per ulteriori informazioni, consulta Visualizzazione ed esportazione della cronologia degli eventi dell’utente nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta AdminListUserAuthEvents AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-remove-user-from-group.
- AWS CLI
-
Come rimuovere un utente da un gruppo
Questo esempio rimuove jane@example.com da SampleGroup.
Comando:
aws cognito-idp admin-remove-user-from-group --user-pool-idus-west-2_aaaaaaaaa--usernamejane@example.com--group-nameSampleGroup-
Per i dettagli sull'API, consulta AdminRemoveUserFromGroup AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-reset-user-password.
- AWS CLI
-
Come reimpostare la password di un utente
Questo esempio reimposta la password per diego@example.com.
Comando:
aws cognito-idp admin-reset-user-password --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com-
Per i dettagli sull'API, consulta AdminResetUserPassword AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-respond-to-auth-challenge.
- AWS CLI
-
Come rispondere a una richiesta di autenticazione
Esistono molti modi per rispondere alle diverse richieste di autenticazione, a seconda del flusso di autenticazione, della configurazione del pool di utenti e delle impostazioni utente. L’esempio
admin-respond-to-auth-challengeseguente fornisce un codice MFA TOTP per diego@example.com e completa l’accesso. In questo pool di utenti è attivata la memorizzazione dei dispositivi, quindi il risultato dell’autenticazione restituisce anche una nuova chiave del dispositivo.aws cognito-idp admin-respond-to-auth-challenge \ --user-pool-idus-west-2_EXAMPLE\ --client-id1example23456789\ --challenge-nameSOFTWARE_TOKEN_MFA\ --challenge-responsesUSERNAME=diego@example.com,SOFTWARE_TOKEN_MFA_CODE=000000\ --sessionAYABeExample...Output:
{ "ChallengeParameters": {}, "AuthenticationResult": { "AccessToken": "eyJra456defEXAMPLE", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "eyJra123abcEXAMPLE", "IdToken": "eyJra789ghiEXAMPLE", "NewDeviceMetadata": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceGroupKey": "-ExAmPlE1" } } }Per ulteriori informazioni, consulta Flusso di autenticazione amministratore nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta AdminRespondToAuthChallenge AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-set-user-mfa-preference.
- AWS CLI
-
Come impostare la preferenza MFA dell’utente
Questo esempio imposta la preferenza SMS MFA per il nome utente diego@example.com.
Comando:
aws cognito-idp admin-set-user-mfa-preference --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com--sms-mfa-settingsEnabled=false,PreferredMfa=false-
Per i dettagli sull'API, consulta AdminSetUserMfaPreference AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-set-user-password.
- AWS CLI
-
Come impostare una password utente come amministratore
L’esempio
admin-set-user-passwordseguente imposta in modo permanente la password per diego@example.com.aws cognito-idp admin-set-user-password \ --user-pool-idus-west-2_EXAMPLE\ --usernamediego@example.com\ --passwordMyExamplePassword1!\ --permanentQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Password, recupero delle password e policy delle password nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta AdminSetUserPassword AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-set-user-settings.
- AWS CLI
-
Come configurare le impostazioni utente
Questo esempio imposta la preferenza di consegna MFA per il nome utente diego@example.com su EMAIL.
Comando:
aws cognito-idp admin-set-user-settings --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com--mfa-optionsDeliveryMedium=EMAIL-
Per i dettagli sull'API, consulta AdminSetUserSettings AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-update-auth-event-feedback.
- AWS CLI
-
Come fornire un feedback per un evento di autorizzazione
Questo esempio imposta il valore di feedback per un evento di autorizzazione identificato da event-id su Valido.
Comando:
aws cognito-idp admin-update-auth-event-feedback --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com--event-idc2c2cf89-c0d3-482d-aba6-99d78a5b0bfe--feedback-valueValid-
Per i dettagli sull'API, consulta AdminUpdateAuthEventFeedback AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-update-device-status.
- AWS CLI
-
Come aggiornare lo stato del dispositivo
Questo esempio imposta lo stato memorizzato del dispositivo per il dispositivo identificato da device-key su not_remembered.
Comando:
aws cognito-idp admin-update-device-status --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com--device-keyxxxx--device-remembered-statusnot_remembered-
Per i dettagli sull'API, consulta AdminUpdateDeviceStatus AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-update-user-attributes.
- AWS CLI
-
Come aggiornare gli attributi utente
Questo esempio aggiorna un attributo utente personalizzato CustomAttr 1 per l'utente diego@example.com.
Comando:
aws cognito-idp admin-update-user-attributes --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com--user-attributes Name="custom:CustomAttr1",Value="Purple"-
Per i dettagli sull'API, vedere AdminUpdateUserAttributes
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzareadmin-user-global-sign-out.
- AWS CLI
-
Come disconnettere un utente come amministratore
L’esempio
admin-user-global-sign-outseguente disconnette l’utente diego@example.com.aws cognito-idp admin-user-global-sign-out \ --user-pool-idus-west-2_EXAMPLE\ --usernamediego@example.comPer ulteriori informazioni, consulta Autenticazione con un pool di utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta AdminUserGlobalSignOut AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareassociate-software-token.
- AWS CLI
-
Come generare una chiave segreta per un’app di autenticazione MFA
L’esempio
associate-software-tokenseguente genera una chiave privata TOTP per un utente che ha effettuato l’accesso e ha ricevuto un token di accesso. La chiave privata risultante può essere immessa manualmente in un’app di autenticazione oppure le applicazioni possono visualizzarla come codice QR che l’utente può scansionare.aws cognito-idp associate-software-token \ --access-tokeneyJra456defEXAMPLEOutput:
{ "SecretCode": "QWERTYUIOP123456EXAMPLE" }Per ulteriori informazioni, consulta Autenticazione MFA con token di software TOTP nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta AssociateSoftwareToken AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarechange-password.
- AWS CLI
-
Come modificare una password
Questo esempio modifica una password.
Comando:
aws cognito-idp change-password --previous-passwordOldPassword--proposed-passwordNewPassword--access-tokenACCESS_TOKEN-
Per i dettagli sull'API, consulta ChangePassword AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareconfirm-device.
- AWS CLI
-
Come confermare un dispositivo utente
L’esempio
confirm-deviceseguente aggiunge un nuovo dispositivo memorizzato per l’utente corrente.aws cognito-idp confirm-device \ --access-tokeneyJra456defEXAMPLE\ --device-keyus-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111\ --device-secret-verifier-configPasswordVerifier=TXlWZXJpZmllclN0cmluZw,Salt=TXlTUlBTYWx0Output:
{ "UserConfirmationNecessary": false }Per ulteriori informazioni, consulta Utilizzo dei dispositivi utente nel pool di utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta ConfirmDevice AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareconfirm-forgot-password.
- AWS CLI
-
Come confermare una password dimenticata
Questo esempio conferma una password dimenticata per diego@example.com.
Comando:
aws cognito-idp confirm-forgot-password --client-id3n4b5urk1ft4fl3mg5e62d9ado--username=diego@example.com --passwordPASSWORD--confirmation-codeCONF_CODE-
Per i dettagli sull'API, consulta ConfirmForgotPassword AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareconfirm-sign-up.
- AWS CLI
-
Come confermare la registrazione
Questo esempio conferma la registrazione per il nome utente diego@example.com.
Comando:
aws cognito-idp confirm-sign-up --client-id3n4b5urk1ft4fl3mg5e62d9ado--username=diego@example.com --confirmation-codeCONF_CODE-
Per i dettagli sull'API, consulta ConfirmSignUp AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-group.
- AWS CLI
-
Come creare un gruppo
Questo esempio crea un gruppo con una descrizione.
Comando:
aws cognito-idp create-group --user-pool-idus-west-2_aaaaaaaaa--group-nameMyNewGroup--description"New group."Output:
{ "Group": { "GroupName": "MyNewGroup", "UserPoolId": "us-west-2_aaaaaaaaa", "Description": "New group.", "LastModifiedDate": 1548270073.795, "CreationDate": 1548270073.795 } }Come creare un gruppo con un ruolo e una precedenza
Questo esempio crea un gruppo con una descrizione. Include anche un ruolo e una precedenza.
Comando:
aws cognito-idp create-group --user-pool-idus-west-2_aaaaaaaaa--group-nameMyNewGroupWithRole--description"New group with a role."--role-arnarn:aws:iam::111111111111:role/MyNewGroupRole--precedence2Output:
{ "Group": { "GroupName": "MyNewGroupWithRole", "UserPoolId": "us-west-2_aaaaaaaaa", "Description": "New group with a role.", "RoleArn": "arn:aws:iam::111111111111:role/MyNewGroupRole", "Precedence": 2, "LastModifiedDate": 1548270211.761, "CreationDate": 1548270211.761 } }-
Per i dettagli sull'API, consulta CreateGroup AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-identity-provider.
- AWS CLI
-
Esempio 1: come creare un gestore dell’identità digitale SAML del pool di utenti con un URL dei metadati
L’esempio
create-identity-providerseguente crea un nuovo IdP SAML con metadati da un URL pubblico, mappatura degli attributi e due identificatori.aws cognito-idp create-identity-provider \ --user-pool-idus-west-2_EXAMPLE\ --provider-nameMySAML\ --provider-typeSAML\ --provider-detailsIDPInit=true,IDPSignout=true,EncryptedResponses=true,MetadataURL=https://auth.example.com/sso/saml/metadata,RequestSigningAlgorithm=rsa-sha256\ --attribute-mappingemail=emailaddress,phone_number=phone,custom:111=department\ --idp-identifiersCorpSAMLWestSAMLOutput:
{ "IdentityProvider": { "UserPoolId": "us-west-2_EXAMPLE", "ProviderName": "MySAML", "ProviderType": "SAML", "ProviderDetails": { "ActiveEncryptionCertificate": "MIICvTCCAaEXAMPLE", "EncryptedResponses": "true", "IDPInit": "true", "IDPSignout": "true", "MetadataURL": "https://auth.example.com/sso/saml/metadata", "RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI": "https://auth.example.com/slo/saml", "SSORedirectBindingURI": "https://auth.example.com/sso/saml" }, "AttributeMapping": { "custom:111": "department", "emailaddress": "email", "phone": "phone_number" }, "IdpIdentifiers": [ "CorpSAML", "WestSAML" ], "LastModifiedDate": 1726853833.977, "CreationDate": 1726853833.977 } }Per ulteriori informazioni, consulta Aggiunta di un accesso al pool di utenti tramite terze parti nella Guida per gli sviluppatori di Amazon Cognito.
Esempio 2: come creare un gestore dell’identità digitale SAML del pool di utenti con un file dei metadati
L’esempio
create-identity-providerseguente crea un nuovo IdP SAML con metadati da un file, mappatura degli attributi e due identificatori. La sintassi dei file può variare tra i diversi sistemi operativi nel parametro--provider-details. Il modo più semplice per eseguire questa operazione è creare un file di input JSON:aws cognito-idp create-identity-provider \ --cli-input-json file://.\SAML-identity-provider.jsonContenuto di
SAML-identity-provider.json:{ "AttributeMapping": { "email" : "idp_email", "email_verified" : "idp_email_verified" }, "IdpIdentifiers": [ "platform" ], "ProviderDetails": { "MetadataFile": "<md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" entityID=\"http://www.example.com/sso\"><md:IDPSSODescriptor WantAuthnRequestsSigned=\"false\" protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\"><md:KeyDescriptor use=\"signing\"><ds:KeyInfo xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\"><ds:X509Data><ds:X509Certificate>[IDP_CERTIFICATE_DATA]</ds:X509Certificate></ds:X509Data></ds:KeyInfo></md:KeyDescriptor><md:SingleLogoutService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://www.example.com/slo/saml\"/><md:SingleLogoutService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"https://www.example.com/slo/saml\"/><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat><md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://www.example.com/sso/saml\"/><md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"https://www.example.com/sso/saml\"/></md:IDPSSODescriptor></md:EntityDescriptor>", "IDPSignout" : "true", "RequestSigningAlgorithm" : "rsa-sha256", "EncryptedResponses" : "true", "IDPInit" : "true" }, "ProviderName": "MySAML2", "ProviderType": "SAML", "UserPoolId": "us-west-2_EXAMPLE" }Output:
{ "IdentityProvider": { "UserPoolId": "us-west-2_EXAMPLE", "ProviderName": "MySAML2", "ProviderType": "SAML", "ProviderDetails": { "ActiveEncryptionCertificate": "[USER_POOL_ENCRYPTION_CERTIFICATE_DATA]", "EncryptedResponses": "true", "IDPInit": "true", "IDPSignout": "true", "MetadataFile": "<md:EntityDescriptor xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\" entityID=\"http://www.example.com/sso\"><md:IDPSSODescriptor WantAuthnRequestsSigned=\"false\" protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\"><md:KeyDescriptor use=\"signing\"><ds:KeyInfo xmlns:ds=\"http://www.w3.org/2000/09/xmldsig#\"><ds:X509Data><ds:X509Certificate>[IDP_CERTIFICATE_DATA]</ds:X509Certificate></ds:X509Data></ds:KeyInfo></md:KeyDescriptor><md:SingleLogoutService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://www.example.com/slo/saml\"/><md:SingleLogoutService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"https://www.example.com/slo/saml\"/><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</md:NameIDFormat><md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat><md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\" Location=\"https://www.example.com/sso/saml\"/><md:SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\" Location=\"https://www.example.com/sso/saml\"/></md:IDPSSODescriptor></md:EntityDescriptor>", "RequestSigningAlgorithm": "rsa-sha256", "SLORedirectBindingURI": "https://www.example.com/slo/saml", "SSORedirectBindingURI": "https://www.example.com/sso/saml" }, "AttributeMapping": { "email": "idp_email", "email_verified": "idp_email_verified" }, "IdpIdentifiers": [ "platform" ], "LastModifiedDate": 1726855290.731, "CreationDate": 1726855290.731 } }Per ulteriori informazioni, consulta Aggiunta di un accesso al pool di utenti tramite terze parti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta CreateIdentityProvider AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-resource-server.
- AWS CLI
-
Come creare un client del pool di utenti
L’esempio
create-resource-serverseguente crea un nuovo server di risorse con ambiti personalizzati.aws cognito-idp create-resource-server \ --user-pool-idus-west-2_EXAMPLE\ --identifiersolar-system-data\ --name"Solar system object tracker"\ --scopes ScopeName=sunproximity.read,ScopeDescription="Distance in AU from Sol" ScopeName=asteroids.add,ScopeDescription="Enter a new asteroid"Output:
{ "ResourceServer": { "UserPoolId": "us-west-2_EXAMPLE", "Identifier": "solar-system-data", "Name": "Solar system object tracker", "Scopes": [ { "ScopeName": "sunproximity.read", "ScopeDescription": "Distance in AU from Sol" }, { "ScopeName": "asteroids.add", "ScopeDescription": "Enter a new asteroid" } ] } }Per ulteriori informazioni, consulta Scopes, M2M e APIs with resource servers nella Amazon Cognito Developer Guide.
-
Per i dettagli sull'API, consulta Command CreateResourceServer
Reference AWS CLI .
-
Il seguente esempio di codice mostra come utilizzarecreate-user-import-job.
- AWS CLI
-
Come creare il processo di importazione degli utenti
Questo esempio crea un processo di importazione utente denominato MyImportJob.
Per ulteriori informazioni sull’importazione di utenti, consulta Importazione di utenti nel pool di utenti da un file CSV.
Comando:
aws cognito-idp create-user-import-job --user-pool-idus-west-2_aaaaaaaaa--job-nameMyImportJob--cloud-watch-logs-role-arnarn:aws:iam::111111111111:role/CognitoCloudWatchLogsRoleOutput:
{ "UserImportJob": { "JobName": "MyImportJob", "JobId": "import-qQ0DCt2fRh", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED_URL", "CreationDate": 1548271795.471, "Status": "Created", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 0 } }Caricare il file .csv con curl utilizzando l’URL pre-firmato:
Comando:
curl -v -T "PATH_TO_CSV_FILE" -H "x-amz-server-side-encryption:aws:kms" "PRE_SIGNED_URL"-
Per i dettagli sull'API, vedere CreateUserImportJob
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-user-pool-client.
- AWS CLI
-
Come creare un client del pool di utenti
L'
create-user-pool-clientesempio seguente crea un nuovo client con pool di utenti con un client secret, attributi di lettura e scrittura espliciti, accesso con flussi username-password e SRP, accesso con tre, accesso a un sottoinsieme di OAuth ambiti IdPs, PinPoint analisi e una validità estesa della sessione di autenticazione.aws cognito-idp create-user-pool-client \ --user-pool-idus-west-2_EXAMPLE\ --client-nameMyTestClient\ --generate-secret \ --refresh-token-validity10\ --access-token-validity60\ --id-token-validity60\ --token-validity-unitsAccessToken=minutes,IdToken=minutes,RefreshToken=days\ --read-attributesemailphone_numberemail_verifiedphone_number_verified\ --write-attributesemailphone_number\ --explicit-auth-flowsALLOW_USER_PASSWORD_AUTHALLOW_USER_SRP_AUTHALLOW_REFRESH_TOKEN_AUTH\ --supported-identity-providersGoogleFacebookMyOIDC\ --callback-urlshttps://www.amazon.comhttps://example.comhttp://localhost:8001myapp://example\ --allowed-o-auth-flowscodeimplicit\ --allowed-o-auth-scopesopenidprofileaws.cognito.signin.user.adminsolar-system-data/asteroids.add\ --allowed-o-auth-flows-user-pool-client \ --analytics-configurationApplicationArn=arn:aws:mobiletargeting:us-west-2:767671399759:apps/thisisanexamplepinpointapplicationid,UserDataShared=TRUE\ --prevent-user-existence-errorsENABLED\ --enable-token-revocation \ --enable-propagate-additional-user-context-data \ --auth-session-validity4Output:
{ "UserPoolClient": { "UserPoolId": "us-west-2_EXAMPLE", "ClientName": "MyTestClient", "ClientId": "123abc456defEXAMPLE", "ClientSecret": "this1234is5678my91011example1213client1415secret", "LastModifiedDate": 1726788459.464, "CreationDate": 1726788459.464, "RefreshTokenValidity": 10, "AccessTokenValidity": 60, "IdTokenValidity": 60, "TokenValidityUnits": { "AccessToken": "minutes", "IdToken": "minutes", "RefreshToken": "days" }, "ReadAttributes": [ "email_verified", "phone_number_verified", "phone_number", "email" ], "WriteAttributes": [ "phone_number", "email" ], "ExplicitAuthFlows": [ "ALLOW_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH" ], "SupportedIdentityProviders": [ "Google", "MyOIDC", "Facebook" ], "CallbackURLs": [ "https://example.com", "https://www.amazon.com", "myapp://example", "http://localhost:8001" ], "AllowedOAuthFlows": [ "implicit", "code" ], "AllowedOAuthScopes": [ "aws.cognito.signin.user.admin", "openid", "profile", "solar-system-data/asteroids.add" ], "AllowedOAuthFlowsUserPoolClient": true, "AnalyticsConfiguration": { "ApplicationArn": "arn:aws:mobiletargeting:us-west-2:123456789012:apps/thisisanexamplepinpointapplicationid", "RoleArn": "arn:aws:iam::123456789012:role/aws-service-role/cognito-idp.amazonaws.com/AWSServiceRoleForAmazonCognitoIdp", "UserDataShared": true }, "PreventUserExistenceErrors": "ENABLED", "EnableTokenRevocation": true, "EnablePropagateAdditionalUserContextData": true, "AuthSessionValidity": 4 } }Per ulteriori informazioni, consulta Impostazioni specifiche dell’applicazione con i client dell’app nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta Command Reference. CreateUserPoolClient
AWS CLI
-
Il seguente esempio di codice mostra come utilizzarecreate-user-pool-domain.
- AWS CLI
-
Esempio 1: come creare un dominio del pool di utenti
L’esempio
create-user-pool-domainseguente crea un nuovo dominio personalizzato.aws cognito-idp create-user-pool-domain \ --user-pool-idus-west-2_EXAMPLE\ --domainauth.example.com\ --custom-domain-configCertificateArn=arn:aws:acm:us-east-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222Output:
{ "CloudFrontDomain": "example1domain.cloudfront.net" }Per ulteriori informazioni, consulta Configurazione di un dominio del pool di utenti nella Guida per gli sviluppatori di Amazon Cognito.
Esempio 2: come creare un dominio del pool di utenti
L’esempio
create-user-pool-domainseguente crea un nuovo dominio con un prefisso di proprietà del servizio.aws cognito-idp create-user-pool-domain \ --user-pool-idus-west-2_EXAMPLE2\ --domainmydomainprefixPer ulteriori informazioni, consulta Configurazione di un dominio del pool di utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta CreateUserPoolDomain AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarecreate-user-pool.
- AWS CLI
-
Come creare un pool di utenti con configurazione minima
Questo esempio crea un pool di utenti denominato MyUserPool utilizzando valori predefiniti. Non ci sono attributi obbligatori né client di applicazioni. MFA e sicurezza avanzata sono disattivate.
Comando:
aws cognito-idp create-user-pool --pool-nameMyUserPoolOutput:
{ "UserPool": { "SchemaAttributes": [ { "Name": "sub", "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": true, "AttributeDataType": "String", "Mutable": false }, { "Name": "name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "given_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "family_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "middle_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "nickname", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "preferred_username", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "profile", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "picture", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "website", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "email", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "email_verified", "Mutable": true }, { "Name": "gender", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "birthdate", "StringAttributeConstraints": { "MinLength": "10", "MaxLength": "10" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "zoneinfo", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "locale", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "phone_number", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "phone_number_verified", "Mutable": true }, { "Name": "address", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "updated_at", "NumberAttributeConstraints": { "MinValue": "0" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "Number", "Mutable": true } ], "MfaConfiguration": "OFF", "Name": "MyUserPool", "LastModifiedDate": 1547833345.777, "AdminCreateUserConfig": { "UnusedAccountValidityDays": 7, "AllowAdminCreateUserOnly": false }, "EmailConfiguration": {}, "Policies": { "PasswordPolicy": { "RequireLowercase": true, "RequireSymbols": true, "RequireNumbers": true, "MinimumLength": 8, "RequireUppercase": true } }, "CreationDate": 1547833345.777, "EstimatedNumberOfUsers": 0, "Id": "us-west-2_aaaaaaaaa", "LambdaConfig": {} } }Come creare un pool di utenti con due attributi richiesti
Questo esempio crea un pool di utenti MyUserPool. Il pool è configurato per accettare l’e-mail come attributo del nome utente. Inoltre, imposta l’indirizzo e-mail di origine su un indirizzo convalidato utilizzando Amazon Simple Email Service (Amazon SES).
Comando:
aws cognito-idp create-user-pool --pool-nameMyUserPool--username-attributes"email"--email-configuration=SourceArn="arn:aws:ses:us-east-1:111111111111:identity/jane@example.com",ReplyToEmailAddress="jane@example.com"Output:
{ "UserPool": { "SchemaAttributes": [ { "Name": "sub", "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": true, "AttributeDataType": "String", "Mutable": false }, { "Name": "name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "given_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "family_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "middle_name", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "nickname", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "preferred_username", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "profile", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "picture", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "website", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "email", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "email_verified", "Mutable": true }, { "Name": "gender", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "birthdate", "StringAttributeConstraints": { "MinLength": "10", "MaxLength": "10" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "zoneinfo", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "locale", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "phone_number", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Required": false, "Name": "phone_number_verified", "Mutable": true }, { "Name": "address", "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "String", "Mutable": true }, { "Name": "updated_at", "NumberAttributeConstraints": { "MinValue": "0" }, "DeveloperOnlyAttribute": false, "Required": false, "AttributeDataType": "Number", "Mutable": true } ], "MfaConfiguration": "OFF", "Name": "MyUserPool", "LastModifiedDate": 1547837788.189, "AdminCreateUserConfig": { "UnusedAccountValidityDays": 7, "AllowAdminCreateUserOnly": false }, "EmailConfiguration": { "ReplyToEmailAddress": "jane@example.com", "SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/jane@example.com" }, "Policies": { "PasswordPolicy": { "RequireLowercase": true, "RequireSymbols": true, "RequireNumbers": true, "MinimumLength": 8, "RequireUppercase": true } }, "UsernameAttributes": [ "email" ], "CreationDate": 1547837788.189, "EstimatedNumberOfUsers": 0, "Id": "us-west-2_aaaaaaaaa", "LambdaConfig": {} } }-
Per i dettagli sull'API, consulta CreateUserPool AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-group.
- AWS CLI
-
Come eliminare un gruppo
Questo esempio elimina un gruppo.
Comando:
aws cognito-idp delete-group --user-pool-idus-west-2_aaaaaaaaa--group-nameMyGroupName-
Per i dettagli sull'API, consulta DeleteGroup AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-identity-provider.
- AWS CLI
-
Come eliminare un gestore dell’identità
Questo esempio elimina un gestore dell’identità digitale.
Comando:
aws cognito-idp delete-identity-provider --user-pool-idus-west-2_aaaaaaaaa--provider-nameFacebook-
Per i dettagli sull'API, consulta DeleteIdentityProvider AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-resource-server.
- AWS CLI
-
Come eliminare un server di risorse
Questo esempio elimina un server di risorse denominato weather.example.com.
Comando:
aws cognito-idp delete-resource-server --user-pool-idus-west-2_aaaaaaaaa--identifierweather.example.com-
Per i dettagli sull'API, consulta DeleteResourceServer AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-user-attributes.
- AWS CLI
-
Come eliminare un attributo utente
L’esempio
delete-user-attributesseguente elimina l’attributo personalizzato “custom:attribute” dall’utente che ha effettuato l’accesso.aws cognito-idp delete-user-attributes \ --access-tokenACCESS_TOKEN\ --user-attribute-names"custom:department"Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Utilizzo degli attributi utente nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta DeleteUserAttributes AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-user-pool-client.
- AWS CLI
-
Come eliminare un client del pool di utenti
Questo esempio elimina un client del pool di utenti.
Comando:
aws cognito-idp delete-user-pool-client --user-pool-idus-west-2_aaaaaaaaa--client-id38fjsnc484p94kpqsnet7mpld0-
Per i dettagli sull'API, consulta DeleteUserPoolClient AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-user-pool-domain.
- AWS CLI
-
Come eliminare un dominio del pool di utenti
L’esempio
delete-user-pool-domainseguente elimina un dominio del pool di utenti denominatomy-domainaws cognito-idp delete-user-pool-domain \ --user-pool-idus-west-2_aaaaaaaaa\ --domainmy-domain-
Per i dettagli sull'API, consulta DeleteUserPoolDomain AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-user-pool.
- AWS CLI
-
Come eliminare un pool di utenti
Questo esempio elimina un pool di utenti utilizzando l’ID del pool di utenti us-west-2_aaaaaaaaa.
Comando:
aws cognito-idp delete-user-pool --user-pool-idus-west-2_aaaaaaaaa-
Per i dettagli sull'API, consulta DeleteUserPool AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredelete-user.
- AWS CLI
-
Come eliminare un utente
Questo esempio elimina un utente.
Comando:
aws cognito-idp delete-user --access-tokenACCESS_TOKEN-
Per i dettagli sull'API, consulta DeleteUser AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-identity-provider.
- AWS CLI
-
Come descrivere un gestore dell’identità
Questo esempio descrive un gestore dell’identità digitale denominato Facebook.
Comando:
aws cognito-idp describe-identity-provider --user-pool-idus-west-2_aaaaaaaaa--provider-nameFacebookOutput:
{ "IdentityProvider": { "UserPoolId": "us-west-2_aaaaaaaaa", "ProviderName": "Facebook", "ProviderType": "Facebook", "ProviderDetails": { "attributes_url": "https://graph.facebook.com/me?fields=", "attributes_url_add_attributes": "true", "authorize_scopes": myscope", "authorize_url": "https://www.facebook.com/v2.9/dialog/oauth", "client_id": "11111", "client_secret": "11111", "token_request_method": "GET", "token_url": "https://graph.facebook.com/v2.9/oauth/access_token" }, "AttributeMapping": { "username": "id" }, "IdpIdentifiers": [], "LastModifiedDate": 1548105901.736, "CreationDate": 1548105901.736 } }-
Per i dettagli sull'API, consulta DescribeIdentityProvider AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-resource-server.
- AWS CLI
-
Come descrivere un server di risorse
Questo esempio descrive il server di risorse weather.example.com.
Comando:
aws cognito-idp describe-resource-server --user-pool-idus-west-2_aaaaaaaaa--identifierweather.example.comOutput:
{ "ResourceServer": { "UserPoolId": "us-west-2_aaaaaaaaa", "Identifier": "weather.example.com", "Name": "Weather", "Scopes": [ { "ScopeName": "weather.update", "ScopeDescription": "Update weather forecast" }, { "ScopeName": "weather.read", "ScopeDescription": "Read weather forecasts" }, { "ScopeName": "weather.delete", "ScopeDescription": "Delete a weather forecast" } ] } }-
Per i dettagli sull'API, consulta DescribeResourceServer AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-risk-configuration.
- AWS CLI
-
Come descrivere una configurazione di rischio
Questo esempio descrive la configurazione di rischio associata al pool us-west-2_aaaaaaaaa.
Comando:
aws cognito-idp describe-risk-configuration --user-pool-idus-west-2_aaaaaaaaaOutput:
{ "RiskConfiguration": { "UserPoolId": "us-west-2_aaaaaaaaa", "CompromisedCredentialsRiskConfiguration": { "EventFilter": [ "SIGN_IN", "SIGN_UP", "PASSWORD_CHANGE" ], "Actions": { "EventAction": "BLOCK" } }, "AccountTakeoverRiskConfiguration": { "NotifyConfiguration": { "From": "diego@example.com", "ReplyTo": "diego@example.com", "SourceArn": "arn:aws:ses:us-east-1:111111111111:identity/diego@example.com", "BlockEmail": { "Subject": "Blocked sign-in attempt", "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We blocked an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "NoActionEmail": { "Subject": "New sign-in attempt", "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We observed an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "MfaEmail": { "Subject": "New sign-in attempt", "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We required you to use multi-factor authentication for the following sign-in attempt:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" } }, "Actions": { "LowAction": { "Notify": true, "EventAction": "NO_ACTION" }, "MediumAction": { "Notify": true, "EventAction": "MFA_IF_CONFIGURED" }, "HighAction": { "Notify": true, "EventAction": "MFA_IF_CONFIGURED" } } } } }-
Per i dettagli sull'API, consulta DescribeRiskConfiguration AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-user-import-job.
- AWS CLI
-
Come descrivere il processo di importazione degli utenti
Questo esempio descrive un processo di importazione degli utenti.
Per ulteriori informazioni sull’importazione di utenti, consulta Importazione di utenti nel pool di utenti da un file CSV.
Comando:
aws cognito-idp describe-user-import-job --user-pool-idus-west-2_aaaaaaaaa--job-idimport-TZqNQvDRnWOutput:
{ "UserImportJob": { "JobName": "import-Test1", "JobId": "import-TZqNQvDRnW", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED URL", "CreationDate": 1548271708.512, "Status": "Created", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 0 } }-
Per i dettagli sull'API, consulta DescribeUserImportJob AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-user-pool-client.
- AWS CLI
-
Come descrivere un client del pool di utenti
Questo esempio descrive un client del pool di utenti.
Comando:
aws cognito-idp describe-user-pool-client --user-pool-idus-west-2_aaaaaaaaa--client-id38fjsnc484p94kpqsnet7mpld0Output:
{ "UserPoolClient": { "UserPoolId": "us-west-2_aaaaaaaaa", "ClientName": "MyApp", "ClientId": "38fjsnc484p94kpqsnet7mpld0", "ClientSecret": "CLIENT_SECRET", "LastModifiedDate": 1548108676.163, "CreationDate": 1548108676.163, "RefreshTokenValidity": 30, "ReadAttributes": [ "address", "birthdate", "custom:CustomAttr1", "custom:CustomAttr2", "email", "email_verified", "family_name", "gender", "given_name", "locale", "middle_name", "name", "nickname", "phone_number", "phone_number_verified", "picture", "preferred_username", "profile", "updated_at", "website", "zoneinfo" ], "WriteAttributes": [ "address", "birthdate", "custom:CustomAttr1", "custom:CustomAttr2", "email", "family_name", "gender", "given_name", "locale", "middle_name", "name", "nickname", "phone_number", "picture", "preferred_username", "profile", "updated_at", "website", "zoneinfo" ], "ExplicitAuthFlows": [ "ADMIN_NO_SRP_AUTH", "USER_PASSWORD_AUTH" ], "AllowedOAuthFlowsUserPoolClient": false } }-
Per i dettagli sull'API, consulta DescribeUserPoolClient AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-user-pool-domain.
- AWS CLI
-
Come descrivere un client del pool di utenti
Questo esempio descrive un dominio del pool di utenti denominato my-domain.
Comando:
aws cognito-idp describe-user-pool-domain --domainmy-domainOutput:
{ "DomainDescription": { "UserPoolId": "us-west-2_aaaaaaaaa", "AWSAccountId": "111111111111", "Domain": "my-domain", "S3Bucket": "aws-cognito-prod-pdx-assets", "CloudFrontDistribution": "aaaaaaaaaaaaa.cloudfront.net", "Version": "20190128175402", "Status": "ACTIVE", "CustomDomainConfig": {} } }-
Per i dettagli sull'API, consulta DescribeUserPoolDomain AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaredescribe-user-pool.
- AWS CLI
-
Come descrivere un pool di utenti
L’esempio seguente descrive un pool di utenti con l’ID del pool di utenti US-West-2_example.
aws cognito-idp describe-user-pool \ --user-pool-idus-west-2_EXAMPLEOutput:
{ "UserPool": { "Id": "us-west-2_EXAMPLE", "Name": "MyUserPool", "Policies": { "PasswordPolicy": { "MinimumLength": 8, "RequireUppercase": true, "RequireLowercase": true, "RequireNumbers": true, "RequireSymbols": true, "TemporaryPasswordValidityDays": 1 } }, "DeletionProtection": "ACTIVE", "LambdaConfig": { "PreSignUp": "arn:aws:lambda:us-west-2:123456789012:function:MyPreSignUpFunction", "CustomMessage": "arn:aws:lambda:us-west-2:123456789012:function:MyCustomMessageFunction", "PostConfirmation": "arn:aws:lambda:us-west-2:123456789012:function:MyPostConfirmationFunction", "PreAuthentication": "arn:aws:lambda:us-west-2:123456789012:function:MyPreAuthenticationFunction", "PostAuthentication": "arn:aws:lambda:us-west-2:123456789012:function:MyPostAuthenticationFunction", "DefineAuthChallenge": "arn:aws:lambda:us-west-2:123456789012:function:MyDefineAuthChallengeFunction", "CreateAuthChallenge": "arn:aws:lambda:us-west-2:123456789012:function:MyCreateAuthChallengeFunction", "VerifyAuthChallengeResponse": "arn:aws:lambda:us-west-2:123456789012:function:MyVerifyAuthChallengeFunction", "PreTokenGeneration": "arn:aws:lambda:us-west-2:123456789012:function:MyPreTokenGenerationFunction", "UserMigration": "arn:aws:lambda:us-west-2:123456789012:function:MyMigrateUserFunction", "PreTokenGenerationConfig": { "LambdaVersion": "V2_0", "LambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:MyPreTokenGenerationFunction" }, "CustomSMSSender": { "LambdaVersion": "V1_0", "LambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:MyCustomSMSSenderFunction" }, "CustomEmailSender": { "LambdaVersion": "V1_0", "LambdaArn": "arn:aws:lambda:us-west-2:123456789012:function:MyCustomEmailSenderFunction" }, "KMSKeyID": "arn:aws:kms:us-west-2:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" }, "LastModifiedDate": 1726784814.598, "CreationDate": 1602103465.273, "SchemaAttributes": [ { "Name": "sub", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": false, "Required": true, "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "2048" } }, { "Name": "name", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "given_name", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "family_name", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "middle_name", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "nickname", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "preferred_username", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "profile", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "picture", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "website", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "email", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": true, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "email_verified", "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false }, { "Name": "gender", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "birthdate", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "10", "MaxLength": "10" } }, { "Name": "zoneinfo", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "locale", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "phone_number", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "phone_number_verified", "AttributeDataType": "Boolean", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false }, { "Name": "address", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "0", "MaxLength": "2048" } }, { "Name": "updated_at", "AttributeDataType": "Number", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "NumberAttributeConstraints": { "MinValue": "0" } }, { "Name": "identities", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": {} }, { "Name": "custom:111", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "256" } }, { "Name": "dev:custom:222", "AttributeDataType": "String", "DeveloperOnlyAttribute": true, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MinLength": "1", "MaxLength": "421" } }, { "Name": "custom:accesstoken", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MaxLength": "2048" } }, { "Name": "custom:idtoken", "AttributeDataType": "String", "DeveloperOnlyAttribute": false, "Mutable": true, "Required": false, "StringAttributeConstraints": { "MaxLength": "2048" } } ], "AutoVerifiedAttributes": [ "email" ], "SmsVerificationMessage": "Your verification code is {####}. ", "EmailVerificationMessage": "Your verification code is {####}. ", "EmailVerificationSubject": "Your verification code", "VerificationMessageTemplate": { "SmsMessage": "Your verification code is {####}. ", "EmailMessage": "Your verification code is {####}. ", "EmailSubject": "Your verification code", "EmailMessageByLink": "Please click the link below to verify your email address. <b>{##Verify Your Email##}</b>\n this is from us-west-2_ywDJHlIfU", "EmailSubjectByLink": "Your verification link", "DefaultEmailOption": "CONFIRM_WITH_LINK" }, "SmsAuthenticationMessage": "Your verification code is {####}. ", "UserAttributeUpdateSettings": { "AttributesRequireVerificationBeforeUpdate": [] }, "MfaConfiguration": "OPTIONAL", "DeviceConfiguration": { "ChallengeRequiredOnNewDevice": true, "DeviceOnlyRememberedOnUserPrompt": false }, "EstimatedNumberOfUsers": 166, "EmailConfiguration": { "SourceArn": "arn:aws:ses:us-west-2:123456789012:identity/admin@example.com", "EmailSendingAccount": "DEVELOPER" }, "SmsConfiguration": { "SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/userpool-SMS-Role", "ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "SnsRegion": "us-west-2" }, "UserPoolTags": {}, "Domain": "myCustomDomain", "CustomDomain": "auth.example.com", "AdminCreateUserConfig": { "AllowAdminCreateUserOnly": false, "UnusedAccountValidityDays": 1, "InviteMessageTemplate": { "SMSMessage": "Your username is {username} and temporary password is {####}. ", "EmailMessage": "Your username is {username} and temporary password is {####}. ", "EmailSubject": "Your temporary password" } }, "UserPoolAddOns": { "AdvancedSecurityMode": "ENFORCED", "AdvancedSecurityAdditionalFlows": {} }, "Arn": "arn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_EXAMPLE", "AccountRecoverySetting": { "RecoveryMechanisms": [ { "Priority": 1, "Name": "verified_email" } ] } } }Per ulteriori informazioni, consulta Pool di utenti di Amazon Cognito nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta DescribeUserPool AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareforget-device.
- AWS CLI
-
Come dimenticare un dispositivo
Questo esempio mostra come dimenticare un dispositivo.
Comando:
aws cognito-idp forget-device --device-keyus-west-2_abcd_1234-5678-
Per i dettagli sull'API, consulta ForgetDevice AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareforgot-password.
- AWS CLI
-
Come forzare la modifica della password
L’esempio
forgot-passwordseguente invia un messaggio a jane@example.com per la modifica della password.aws cognito-idp forgot-password --client-id38fjsnc484p94kpqsnet7mpld0--usernamejane@example.comOutput:
{ "CodeDeliveryDetails": { "Destination": "j***@e***.com", "DeliveryMedium": "EMAIL", "AttributeName": "email" } }-
Per i dettagli sull'API, consulta ForgotPassword AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-csv-header.
- AWS CLI
-
Come creare un’intestazione CSV
Questo esempio crea un’intestazione CSV.
Per ulteriori informazioni sull’importazione di utenti, consulta Importazione di utenti nel pool di utenti da un file CSV.
Comando:
aws cognito-idp get-csv-header --user-pool-idus-west-2_aaaaaaaaaOutput:
{ "UserPoolId": "us-west-2_aaaaaaaaa", "CSVHeader": [ "name", "given_name", "family_name", "middle_name", "nickname", "preferred_username", "profile", "picture", "website", "email", "email_verified", "gender", "birthdate", "zoneinfo", "locale", "phone_number", "phone_number_verified", "address", "updated_at", "cognito:mfa_enabled", "cognito:username" ] }... Importazione di utenti in pool di utenti da un file CSV: https://docs.aws.amazon.com/cognito/ latest/developerguide/cognito - -tool.html user-pools-using-import
-
Per i dettagli sull'API, consulta AWS CLI Command GetCsvHeader
Reference.
-
Il seguente esempio di codice mostra come utilizzareget-device.
- AWS CLI
-
Come ottenere un dispositivo
L’esempio
get-deviceseguente visualizza un dispositivo per l’utente che ha effettuato l’accesso.aws cognito-idp get-device \ --access-tokeneyJra456defEXAMPLE\ --device-keyus-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111Output:
{ "Device": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceAttributes": [ { "Name": "device_status", "Value": "valid" }, { "Name": "device_name", "Value": "MyDevice" }, { "Name": "dev:device_arn", "Value": "arn:aws:cognito-idp:us-west-2:123456789012:owner/diego.us-west-2_EXAMPLE/device/us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, { "Name": "dev:device_owner", "Value": "diego.us-west-2_EXAMPLE" }, { "Name": "last_ip_used", "Value": "192.0.2.1" }, { "Name": "dev:device_remembered_status", "Value": "remembered" }, { "Name": "dev:device_sdk", "Value": "aws-sdk" } ], "DeviceCreateDate": 1715100742.022, "DeviceLastModifiedDate": 1723233651.167, "DeviceLastAuthenticatedDate": 1715100742.0 } }Per ulteriori informazioni, consulta Utilizzo dei dispositivi utente nel pool di utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta GetDevice AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-group.
- AWS CLI
-
Come ottenere informazioni relative a un gruppo
L’esempio
get-groupseguente elenca le proprietà del gruppo di utenti denominatoMyGroup. A questo gruppo sono associati una precedenza e un ruolo IAM.aws cognito-idp get-group \ --user-pool-idus-west-2_EXAMPLE\ --group-nameMyGroupOutput:
{ "Group": { "GroupName": "MyGroup", "UserPoolId": "us-west-2_EXAMPLE", "RoleArn": "arn:aws:iam::123456789012:role/example-cognito-role", "Precedence": 7, "LastModifiedDate": 1697211218.305, "CreationDate": 1611685503.954 } }Per ulteriori informazioni, consulta Aggiunta di gruppi a un pool di utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta GetGroup AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-identity-provider-by-identifier.
- AWS CLI
-
Come ottenere la configurazione di un gestore dell’identità dall’identificatore IdP
L’esempio
get-identity-provider-by-identifierseguente restituisce la configurazione del gestore dell’identità digitale con l’identificatoremysso.aws cognito-idp get-identity-provider-by-identifier \ --user-pool-idus-west-2_EXAMPLE\ --idp-identifiermyssoOutput:
{ "IdentityProvider": { "UserPoolId": "us-west-2_EXAMPLE", "ProviderName": "MYSAML", "ProviderType": "SAML", "ProviderDetails": { "ActiveEncryptionCertificate": "[Certificate contents]", "IDPSignout": "false", "MetadataURL": "https://auth.example.com/saml/metadata/", "SLORedirectBindingURI": "https://auth.example.com/saml/logout/", "SSORedirectBindingURI": "https://auth.example.com/saml/assertion/" }, "AttributeMapping": { "email": "email" }, "IdpIdentifiers": [ "mysso", "mysamlsso" ], "LastModifiedDate": 1705616729.188, "CreationDate": 1643734622.919 } }Per ulteriori informazioni, consulta Accesso tramite IdP di terze parti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta GetIdentityProviderByIdentifier AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-log-delivery-configuration.
- AWS CLI
-
Come visualizzare la configurazione di consegna dei log
L’esempio
get-log-delivery-configurationseguente visualizza le impostazioni di esportazione log del pool di utenti richiesto.aws cognito-idp get-log-delivery-configuration \ --user-pool-idus-west-2_EXAMPLEOutput:
{ "LogDeliveryConfiguration": { "UserPoolId": "us-west-2_EXAMPLE", "LogConfigurations": [ { "LogLevel": "INFO", "EventSource": "userAuthEvents", "FirehoseConfiguration": { "StreamArn": "arn:aws:firehose:us-west-2:123456789012:deliverystream/my-test-deliverystream" } }, { "LogLevel": "ERROR", "EventSource": "userNotification", "CloudWatchLogsConfiguration": { "LogGroupArn": "arn:aws:logs:us-west-2:123456789012:log-group:my-message-delivery-logs" } } ] } }Per ulteriori informazioni, consulta Esportazione dei log dei pool di utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta GetLogDeliveryConfiguration AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-signing-certificate.
- AWS CLI
-
Come visualizzare il certificato di firma SAML
L’esempio
get-signing-certificateseguente visualizza il certificato di firma SAML 2.0 per il pool di utenti della richiesta.aws cognito-idp get-signing-certificate \ --user-pool-idus-west-2_EXAMPLEOutput:
{ "Certificate": "[Certificate content]" }Per ulteriori informazioni, consulta Firma e crittografia SAML nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta GetSigningCertificate AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-ui-customization.
- AWS CLI
-
Come visualizzare le impostazioni di personalizzazione dell’interfaccia utente ospitata classica per un client dell’app
L’esempio
get-ui-customizationseguente mostra le impostazioni di personalizzazione dell’interfaccia utente ospitata classica per un client dell’app che non eredita le impostazioni dal pool di utenti.aws cognito-idp get-ui-customization \ --user-pool-idus-west-2_EXAMPLE\ --client-id1example23456789Output:
{ "UICustomization": { "UserPoolId": "us-west-2_EXAMPLE", "ClientId": "1example23456789", "ImageUrl": "https://example.cloudfront.net/us-west-2_EXAMPLE/1example23456789/20250115191928/assets/images/image.jpg", "CSS": "\n.logo-customizable {\n max-width: 80%;\n max-height: 30%;\n}\n\n.banner-customizable {\n padding: 25px 0px 25px 0px;\n background-color: lightgray;\n}\n\n.label-customizable {\n font-weight: 400;\n}\n\n.textDescription-customizable {\n padding-top: 100px;\n padding-bottom: 10px;\n display: block;\n font-size: 12px;\n}\n\n.idpDescription-customizable {\n padding-top: 10px;\n padding-bottom: 10px;\n display: block;\n font-size: 16px;\n}\n\n.legalText-customizable {\n color: #747474;\n font-size: 11px;\n}\n\n.submitButton-customizable {\n font-size: 14px;\n font-weight: bold;\n margin: 20px 0px 10px 0px;\n height: 50px;\n width: 100%;\n color: #fff;\n background-color: #337ab7;\n}\n\n.submitButton-customizable:hover {\n color: #fff;\n background-color: #286090;\n}\n\n.errorMessage-customizable {\n padding: 5px;\n font-size: 12px;\n width: 100%;\n background: #F5F5F5;\n border: 2px solid #D64958;\n color: #D64958;\n}\n\n.inputField-customizable {\n width: 100%;\n height: 34px;\n color: #555;\n background-color: #fff;\n border: 1px solid #ccc;\n}\n\n.inputField-customizable:focus {\n border-color: #66afe9;\n outline: 0;\n}\n\n.idpButton-customizable {\n height: 40px;\n width: 100%;\n width: 100%;\n text-align: center;\n margin-bottom: 15px;\n color: #fff;\n background-color: #5bc0de;\n border-color: #46b8da;\n}\n\n.idpButton-customizable:hover {\n color: #fff;\n background-color: #31b0d5;\n}\n\n.socialButton-customizable {\n border-radius: 2px;\n height: 60px;\n margin-bottom: 15px;\n padding: 1px;\n text-align: left;\n width: 100%;\n}\n\n.redirect-customizable {\n text-align: center;\n}\n\n.passwordCheck-notValid-customizable {\n color: #DF3312;\n}\n\n.passwordCheck-valid-customizable {\n color: #19BF00;\n}\n\n.background-customizable {\n background-color: #fff;\n}\n", "CSSVersion": "20250115191928" } }Per ulteriori informazioni, consulta Branding dell’interfaccia utente ospitata (classica) nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta GetUiCustomization AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-user-attribute-verification-code.
- AWS CLI
-
Come inviare un codice di verifica degli attributi all’utente corrente
L’esempio
get-user-attribute-verification-codeseguente invia un codice di verifica degli attributi all’indirizzo e-mail dell’utente che ha effettuato l’accesso.aws cognito-idp get-user-attribute-verification-code \ --access-tokeneyJra456defEXAMPLE\ --attribute-nameemailOutput:
{ "CodeDeliveryDetails": { "Destination": "a***@e***", "DeliveryMedium": "EMAIL", "AttributeName": "email" } }Per ulteriori informazioni, consulta Registrazione e conferma degli account utente nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta GetUserAttributeVerificationCode AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-user-auth-factors.
- AWS CLI
-
Come elencare i fattori di autenticazione disponibili per l’utente corrente
L’esempio
get-user-auth-factorsseguente elenca i fattori di autenticazione disponibili per l’utente che ha effettuato l’accesso.aws cognito-idp get-user-auth-factors \ --access-tokeneyJra456defEXAMPLEOutput:
{ "Username": "testuser", "ConfiguredUserAuthFactors": [ "PASSWORD", "EMAIL_OTP", "SMS_OTP", "WEB_AUTHN" ] }Per ulteriori informazioni, consulta Autenticazione nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta GetUserAuthFactors AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-user-pool-mfa-config.
- AWS CLI
-
Per visualizzare l'autenticazione a più fattori e WebAuthn le impostazioni di un pool di utenti
L'
get-user-pool-mfa-configesempio seguente visualizza l'MFA e la WebAuthn configurazione del pool di utenti richiesto.aws cognito-idp get-user-pool-mfa-config \ --user-pool-idus-west-2_EXAMPLEOutput:
{ "SmsMfaConfiguration": { "SmsAuthenticationMessage": "Your OTP for MFA or sign-in: use {####}.", "SmsConfiguration": { "SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/my-SMS-Role", "ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "SnsRegion": "us-west-2" } }, "SoftwareTokenMfaConfiguration": { "Enabled": true }, "EmailMfaConfiguration": { "Message": "Your OTP for MFA or sign-in: use {####}", "Subject": "OTP test" }, "MfaConfiguration": "OPTIONAL", "WebAuthnConfiguration": { "RelyingPartyId": "auth.example.com", "UserVerification": "preferred" } }Per ulteriori informazioni, consulta Aggiunta di MFA nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, vedere GetUserPoolMfaConfig
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzareget-user.
- AWS CLI
-
Come ottenere i dettagli dell’utente corrente
L’esempio
get-userseguente mostra il profilo dell’utente che ha effettuato l’accesso.aws cognito-idp get-user \ --access-tokeneyJra456defEXAMPLEOutput:
{ "Username": "johndoe", "UserAttributes": [ { "Name": "sub", "Value": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" }, { "Name": "identities", "Value": "[{\"userId\":\"a1b2c3d4-5678-90ab-cdef-EXAMPLE22222\",\"providerName\":\"SignInWithApple\",\"providerType\":\"SignInWithApple\",\"issuer\":null,\"primary\":false,\"dateCreated\":1701125599632}]" }, { "Name": "email_verified", "Value": "true" }, { "Name": "custom:state", "Value": "Maine" }, { "Name": "name", "Value": "John Doe" }, { "Name": "phone_number_verified", "Value": "true" }, { "Name": "phone_number", "Value": "+12065551212" }, { "Name": "preferred_username", "Value": "jamesdoe" }, { "Name": "locale", "Value": "EMEA" }, { "Name": "email", "Value": "jamesdoe@example.com" } ] }Per ulteriori informazioni, consulta Gestione degli utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta GetUser AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareglobal-sign-out.
- AWS CLI
-
Come disconnettere l’utente corrente
L’esempio
global-sign-outseguente disconnette l’utente corrente.aws cognito-idp global-sign-out \ --access-tokeneyJra456defEXAMPLEQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Gestione degli utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta GlobalSignOut AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareinitiate-auth.
- AWS CLI
-
Come effettuare l’accesso per un utente
L’esempio
initiate-authseguente accede a un utente con il flusso nome utente-password di base e senza richieste di verifica aggiuntive.aws cognito-idp initiate-auth \ --auth-flowUSER_PASSWORD_AUTH\ --client-id1example23456789\ --analytics-metadataAnalyticsEndpointId=d70b2ba36a8c4dc5a04a0451aEXAMPLE\ --auth-parametersUSERNAME=testuser,PASSWORD=[Password]--user-context-dataEncodedData=mycontextdata--client-metadataMyTestKey=MyTestValueOutput:
{ "AuthenticationResult": { "AccessToken": "eyJra456defEXAMPLE", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "eyJra123abcEXAMPLE", "IdToken": "eyJra789ghiEXAMPLE", "NewDeviceMetadata": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceGroupKey": "-v7w9UcY6" } } }Per ulteriori informazioni, consulta Autenticazione nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta InitiateAuth AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-devices.
- AWS CLI
-
Come elencare i dispositivi di un utente
L’esempio
list-devicesseguente elenca i dispositivi che sono stati registrati dall’utente corrente.aws cognito-idp list-devices \ --access-tokeneyJra456defEXAMPLEOutput:
{ "Devices": [ { "DeviceAttributes": [ { "Name": "device_status", "Value": "valid" }, { "Name": "device_name", "Value": "Dart-device" }, { "Name": "last_ip_used", "Value": "192.0.2.1" } ], "DeviceCreateDate": 1715100742.022, "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceLastAuthenticatedDate": 1715100742.0, "DeviceLastModifiedDate": 1723233651.167 }, { "DeviceAttributes": [ { "Name": "device_status", "Value": "valid" }, { "Name": "last_ip_used", "Value": "192.0.2.2" } ], "DeviceCreateDate": 1726856147.993, "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "DeviceLastAuthenticatedDate": 1726856147.0, "DeviceLastModifiedDate": 1726856147.993 } ] }Per ulteriori informazioni, consulta Utilizzo dei dispositivi nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta ListDevices AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-groups.
- AWS CLI
-
Come elencare i gruppi in un pool di utenti
L’esempio
list-groupsseguente elenca i primi due gruppi del pool di utenti richiesto.aws cognito-idp list-groups \ --user-pool-idus-west-2_EXAMPLE\ --max-items2Output:
{ "Groups": [ { "CreationDate": 1681760899.633, "Description": "My test group", "GroupName": "testgroup", "LastModifiedDate": 1681760899.633, "Precedence": 1, "UserPoolId": "us-west-2_EXAMPLE" }, { "CreationDate": 1642632749.051, "Description": "Autogenerated group for users who sign in using Facebook", "GroupName": "us-west-2_EXAMPLE_Facebook", "LastModifiedDate": 1642632749.051, "UserPoolId": "us-west-2_EXAMPLE" } ], "NextToken": "[Pagination token]" }Per ulteriori informazioni, consulta Aggiunta di gruppi a un pool di utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta ListGroups AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-identity-providers.
- AWS CLI
-
Come elencare gestore dell’identità
L’esempio
list-identity-providersseguente elenca i primi due gestori dell’identità digitale nel pool di utenti richiesto.aws cognito-idp list-identity-providers \ --user-pool-idus-west-2_EXAMPLE\ --max-items2Output:
{ "Providers": [ { "CreationDate": 1619477386.504, "LastModifiedDate": 1703798328.142, "ProviderName": "Azure", "ProviderType": "SAML" }, { "CreationDate": 1642698776.175, "LastModifiedDate": 1642699086.453, "ProviderName": "LoginWithAmazon", "ProviderType": "LoginWithAmazon" } ], "NextToken": "[Pagination token]" }Per ulteriori informazioni, consulta Accesso tramite IdP di terze parti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta ListIdentityProviders AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-resource-servers.
- AWS CLI
-
Come elencare i server di risorse
L’esempio
list-resource-serversseguente elenca i primi due server di risorse nel pool di utenti richiesto.aws cognito-idp list-resource-servers \ --user-pool-idus-west-2_EXAMPLE\ --max-results2Output:
{ "ResourceServers": [ { "Identifier": "myapi.example.com", "Name": "Example API with custom access control scopes", "Scopes": [ { "ScopeDescription": "International customers", "ScopeName": "international.read" }, { "ScopeDescription": "Domestic customers", "ScopeName": "domestic.read" } ], "UserPoolId": "us-west-2_EXAMPLE" }, { "Identifier": "myapi2.example.com", "Name": "Another example API for access control", "Scopes": [ { "ScopeDescription": "B2B customers", "ScopeName": "b2b.read" } ], "UserPoolId": "us-west-2_EXAMPLE" } ], "NextToken": "[Pagination token]" }Per ulteriori informazioni, consulta Controllo dell’accesso con i server delle risorse nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta ListResourceServers AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-tags-for-resource.
- AWS CLI
-
Come elencare i tag del pool di utenti
L’esempio
list-tags-for-resourceseguente elenca i tag assegnati al pool di utenti con l’ARN richiesto.aws cognito-idp list-tags-for-resource \ --resource-arnarn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_EXAMPLEOutput:
{ "Tags": { "administrator": "Jie", "tenant": "ExampleCorp" } }Per ulteriori informazioni, consulta Assegnazione di tag alle risorse Amazon Cognito nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta ListTagsForResource AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-user-import-jobs.
- AWS CLI
-
Come elencare i processi e gli stati di importazione degli utenti
L’esempio
list-user-import-jobsseguente elenca i primi tre processi di importazione utente e i relativi dettagli nel pool di utenti richiesto.aws cognito-idp list-user-import-jobs \ --user-pool-idus-west-2_EXAMPLE\ --max-results3Output:
{ "PaginationToken": "us-west-2_EXAMPLE#import-example3#1667948397084", "UserImportJobs": [ { "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/service-role/Cognito-UserImport-Role", "CompletionDate": 1735329786.142, "CompletionMessage": "The user import job has expired.", "CreationDate": 1735241621.022, "FailedUsers": 0, "ImportedUsers": 0, "JobId": "import-example1", "JobName": "Test-import-job-1", "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]", "SkippedUsers": 0, "Status": "Expired", "UserPoolId": "us-west-2_EXAMPLE" }, { "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/service-role/Cognito-UserImport-Role", "CompletionDate": 1681509058.408, "CompletionMessage": "Too many users have failed or been skipped during the import.", "CreationDate": 1681509001.477, "FailedUsers": 1, "ImportedUsers": 0, "JobId": "import-example2", "JobName": "Test-import-job-2", "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]", "SkippedUsers": 0, "StartDate": 1681509057.965, "Status": "Failed", "UserPoolId": "us-west-2_EXAMPLE" }, { "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/service-role/Cognito-UserImport-Role", "CompletionDate": 1.667864578676E9, "CompletionMessage": "Import Job Completed Successfully.", "CreationDate": 1.667864480281E9, "FailedUsers": 0, "ImportedUsers": 6, "JobId": "import-example3", "JobName": "Test-import-job-3", "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]", "SkippedUsers": 0, "StartDate": 1.667864578167E9, "Status": "Succeeded", "UserPoolId": "us-west-2_EXAMPLE" } ] }Per ulteriori informazioni, consulta Importazione di utenti da un file CSV nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta ListUserImportJobs AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-user-pool-clients.
- AWS CLI
-
Come elencare i client dell’app
L’esempio
list-user-pool-clientsseguente elenca i primi tre client dell’app nel pool di utenti richiesto.aws cognito-idp list-user-pool-clients \ --user-pool-idus-west-2_EXAMPLE\ --max-results3Output:
{ "NextToken": "[Pagination token]", "UserPoolClients": [ { "ClientId": "1example23456789", "ClientName": "app-client-1", "UserPoolId": "us-west-2_EXAMPLE" }, { "ClientId": "2example34567890", "ClientName": "app-client-2", "UserPoolId": "us-west-2_EXAMPLE" }, { "ClientId": "3example45678901", "ClientName": "app-client-3", "UserPoolId": "us-west-2_EXAMPLE" } ] }Per ulteriori informazioni, consulta Client dell’app nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta ListUserPoolClients AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-user-pools.
- AWS CLI
-
Come elencare i pool di utenti
L'
list-user-poolsesempio seguente elenca 3 dei pool di utenti disponibili nell' AWS account delle credenziali CLI correnti.aws cognito-idp list-user-pools \ --max-results3Output:
{ "NextToken": "[Pagination token]", "UserPools": [ { "CreationDate": 1681502497.741, "Id": "us-west-2_EXAMPLE1", "LambdaConfig": { "CustomMessage": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "PreSignUp": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "PreTokenGeneration": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "PreTokenGenerationConfig": { "LambdaArn": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction", "LambdaVersion": "V1_0" } }, "LastModifiedDate": 1681502497.741, "Name": "user pool 1" }, { "CreationDate": 1686064178.717, "Id": "us-west-2_EXAMPLE2", "LambdaConfig": { }, "LastModifiedDate": 1686064178.873, "Name": "user pool 2" }, { "CreationDate": 1627681712.237, "Id": "us-west-2_EXAMPLE3", "LambdaConfig": { "UserMigration": "arn:aws:lambda:us-east-1:123456789012:function:MyFunction" }, "LastModifiedDate": 1678486942.479, "Name": "user pool 3" } ] }Per ulteriori informazioni, consulta Pool di utenti di Amazon Cognito nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, vedere ListUserPools
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-users-in-group.
- AWS CLI
-
Come elencare gli utenti in un gruppo
Questo esempio elenca gli utenti in gruppo MyGroup.
Comando:
aws cognito-idp list-users-in-group --user-pool-idus-west-2_aaaaaaaaa--group-nameMyGroupOutput:
{ "Users": [ { "Username": "acf10624-80bb-401a-ac61-607bee2110ec", "Attributes": [ { "Name": "sub", "Value": "acf10624-80bb-401a-ac61-607bee2110ec" }, { "Name": "custom:CustomAttr1", "Value": "New Value!" }, { "Name": "email", "Value": "jane@example.com" } ], "UserCreateDate": 1548102770.284, "UserLastModifiedDate": 1548103204.893, "Enabled": true, "UserStatus": "CONFIRMED" }, { "Username": "22704aa3-fc10-479a-97eb-2af5806bd327", "Attributes": [ { "Name": "sub", "Value": "22704aa3-fc10-479a-97eb-2af5806bd327" }, { "Name": "email_verified", "Value": "true" }, { "Name": "email", "Value": "diego@example.com" } ], "UserCreateDate": 1548089817.683, "UserLastModifiedDate": 1548089817.683, "Enabled": true, "UserStatus": "FORCE_CHANGE_PASSWORD" } ] }-
Per i dettagli sull'API, consulta ListUsersInGroup AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-users.
- AWS CLI
-
Esempio 1: come restituire l’elenco degli utenti con un filtro lato server
L’esempio
list-usersseguente elenca 3 utenti nel pool di utenti richiesto i cui indirizzi e-mail iniziano contestuser.aws cognito-idp list-users \ --user-pool-idus-west-2_EXAMPLE\ --filter email^=\"testuser\" \ --max-items3Output:
{ "PaginationToken": "efgh5678EXAMPLE", "Users": [ { "Attributes": [ { "Name": "sub", "Value": "eaad0219-2117-439f-8d46-4db20e59268f" }, { "Name": "email", "Value": "testuser@example.com" } ], "Enabled": true, "UserCreateDate": 1682955829.578, "UserLastModifiedDate": 1689030181.63, "UserStatus": "CONFIRMED", "Username": "testuser" }, { "Attributes": [ { "Name": "sub", "Value": "3b994cfd-0b07-4581-be46-3c82f9a70c90" }, { "Name": "email", "Value": "testuser2@example.com" } ], "Enabled": true, "UserCreateDate": 1684427979.201, "UserLastModifiedDate": 1684427979.201, "UserStatus": "UNCONFIRMED", "Username": "testuser2" }, { "Attributes": [ { "Name": "sub", "Value": "5929e0d1-4c34-42d1-9b79-a5ecacfe66f7" }, { "Name": "email", "Value": "testuser3@example.com" } ], "Enabled": true, "UserCreateDate": 1684427823.641, "UserLastModifiedDate": 1684427823.641, "UserStatus": "UNCONFIRMED", "Username": "testuser3@example.com" } ] }Per ulteriori informazioni, consulta Gestione e ricerca degli utenti nella Guida per gli sviluppatori di Amazon Cognito.
Esempio 2: come restituire l’elenco degli utenti con un filtro lato client
L’esempio
list-usersseguente elenca gli attributi di tre utenti che dispongono di un attributo (in questo caso l’indirizzo e-mail contenente il dominio e-mail “@example .com”). Verranno visualizzati anche eventuali altri attributi contenuti in questa stringa. Il secondo utente non dispone di attributi corrispondenti alla query e pertanto è escluso dall’output visualizzato, ma non dalla risposta del server.aws cognito-idp list-users \ --user-pool-idus-west-2_EXAMPLE\ --max-items3--query Users\[\*\].Attributes\[\?Value\.contains\(\@\,\'@example.com\'\)\]Output:
[ [ { "Name": "email", "Value": "admin@example.com" } ], [], [ { "Name": "email", "Value": "operator@example.com" } ] ]Per ulteriori informazioni, consulta Gestione e ricerca degli utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta ListUsers AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarelist-web-authn-credentials.
- AWS CLI
-
Come elencare le credenziali passkey
L'
list-web-authn-credentialsesempio seguente elenca la passkey, o le credenziali WebAuthn, per l'utente corrente. Hanno un dispositivo registrato.aws cognito-idp list-web-authn-credentials \ --access-tokeneyJra456defEXAMPLEOutput:
{ "Credentials": [ { "AuthenticatorAttachment": "cross-platform", "CreatedAt": 1736293876.115, "CredentialId": "8LApgk4-lNUFHbhm2w6Und7-uxcc8coJGsPxiogvHoItc64xWQc3r4CEXAMPLE", "FriendlyCredentialName": "Roaming passkey", "RelyingPartyId": "auth.example.com" } ] }Per ulteriori informazioni, consulta Accesso con passkey nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, vedere ListWebAuthnCredentials
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzareresend-confirmation-code.
- AWS CLI
-
Come inviare nuovamente un codice di conferma
L’esempio
resend-confirmation-codeseguente invia un codice di conferma all’utentejane.aws cognito-idp resend-confirmation-code \ --client-id12a3b456c7de890f11g123hijk\ --usernamejaneOutput:
{ "CodeDeliveryDetails": { "Destination": "j***@e***.com", "DeliveryMedium": "EMAIL", "AttributeName": "email" } }Per ulteriori informazioni, consulta Registrazione e conferma degli account utente nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta ResendConfirmationCode AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarerespond-to-auth-challenge.
- AWS CLI
-
Esempio 1: come rispondere a una richiesta di verifica NEW_PASSWORD_REQUIRED
L’esempio
respond-to-auth-challengeseguente risponde alla richiesta di verifica NEW_PASSWORD_REQUIRED restituita da initiate-auth. Imposta una password per l’utentejane@example.com.aws cognito-idp respond-to-auth-challenge \ --client-id1example23456789\ --challenge-nameNEW_PASSWORD_REQUIRED\ --challenge-responsesUSERNAME=jane@example.com,NEW_PASSWORD=[Password]\ --sessionAYABeEv5HklEXAMPLEOutput:
{ "ChallengeParameters": {}, "AuthenticationResult": { "AccessToken": "ACCESS_TOKEN", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "REFRESH_TOKEN", "IdToken": "ID_TOKEN", "NewDeviceMetadata": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceGroupKey": "-wt2ha1Zd" } } }Per ulteriori informazioni, consulta Autenticazione nella Guida per gli sviluppatori di Amazon Cognito.
Esempio 2: come rispondere a una richiesta di verifica SELECT_MFA_TYPE
L’esempio
respond-to-auth-challengeseguente sceglie TOTP MFA come opzione MFA per l’utente corrente. All’utente viene richiesto di selezionare un tipo di autenticazione MFA e quindi di inserire il proprio codice MFA.aws cognito-idp respond-to-auth-challenge \ --client-id1example23456789--sessionAYABeEv5HklEXAMPLE--challenge-nameSELECT_MFA_TYPE--challenge-responsesUSERNAME=testuser,ANSWER=SOFTWARE_TOKEN_MFAOutput:
{ "ChallengeName": "SOFTWARE_TOKEN_MFA", "Session": "AYABeEv5HklEXAMPLE", "ChallengeParameters": { "FRIENDLY_DEVICE_NAME": "transparent" } }Per ulteriori informazioni, consulta Aggiunta di MFA nella Guida per gli sviluppatori di Amazon Cognito.
Esempio 3: come rispondere a una richiesta di verifica SOFTWARE_TOKEN_MFA
L’esempio
respond-to-auth-challengeseguente fornisce un codice MFA TOTP e completa l’accesso.aws cognito-idp respond-to-auth-challenge \ --client-id1example23456789\ --sessionAYABeEv5HklEXAMPLE\ --challenge-nameSOFTWARE_TOKEN_MFA\ --challenge-responsesUSERNAME=testuser,SOFTWARE_TOKEN_MFA_CODE=123456Output:
{ "AuthenticationResult": { "AccessToken": "eyJra456defEXAMPLE", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "eyJra123abcEXAMPLE", "IdToken": "eyJra789ghiEXAMPLE", "NewDeviceMetadata": { "DeviceKey": "us-west-2_a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "DeviceGroupKey": "-v7w9UcY6" } } }Per ulteriori informazioni, consulta Aggiunta di MFA nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta RespondToAuthChallenge AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarerevoke-token.
- AWS CLI
-
Come revocare un token di aggiornamento
L’esempio
revoke-tokenseguente revoca il token di aggiornamento richiesto e i token di accesso associati.aws cognito-idp revoke-token \ --tokeneyJjd123abcEXAMPLE\ --client-id1example23456789Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Revoca dei token nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta RevokeToken AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareset-log-delivery-configuration.
- AWS CLI
-
Come configurare l’esportazione di log da un pool di utenti
L’esempio
set-log-delivery-configurationseguente configura il pool di utenti richiesto con la registrazione degli errori di notifica utente in un gruppo di log e la registrazione delle informazioni di autenticazione utente in un bucket S3.aws cognito-idp set-log-delivery-configuration \ --user-pool-idus-west-2_EXAMPLE\ --log-configurationsLogLevel=ERROR,EventSource=userNotification,CloudWatchLogsConfiguration={LogGroupArn=arn:aws:logs:us-west-2:123456789012:log-group:cognito-exported}LogLevel=INFO,EventSource=userAuthEvents,S3Configuration={BucketArn=arn:aws:s3:::amzn-s3-demo-bucket1}Output:
{ "LogDeliveryConfiguration": { "LogConfigurations": [ { "CloudWatchLogsConfiguration": { "LogGroupArn": "arn:aws:logs:us-west-2:123456789012:log-group:cognito-exported" }, "EventSource": "userNotification", "LogLevel": "ERROR" }, { "EventSource": "userAuthEvents", "LogLevel": "INFO", "S3Configuration": { "BucketArn": "arn:aws:s3:::amzn-s3-demo-bucket1" } } ], "UserPoolId": "us-west-2_EXAMPLE" } }Per ulteriori informazioni, consulta Esportazione dei log dei pool di utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta SetLogDeliveryConfiguration AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareset-risk-configuration.
- AWS CLI
-
Come impostare la configurazione del rischio di protezione dalle minacce
L’esempio
set-risk-configurationseguente configura i messaggi e le azioni di protezione dalle minacce, le credenziali compromesse e le eccezioni degli indirizzi IP nel client dell’app richiesto. A causa della complessità dell' NotifyConfiguration oggetto, l'input JSON è una procedura consigliata per questo comando.aws cognito-idp set-risk-configuration \ --cli-input-jsonfile://set-risk-configuration.jsonContenuto di
set-risk-configuration.json:{ "AccountTakeoverRiskConfiguration": { "Actions": { "HighAction": { "EventAction": "MFA_REQUIRED", "Notify": true }, "LowAction": { "EventAction": "NO_ACTION", "Notify": true }, "MediumAction": { "EventAction": "MFA_IF_CONFIGURED", "Notify": true } }, "NotifyConfiguration": { "BlockEmail": { "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We blocked an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "Subject": "Blocked sign-in attempt", "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "From": "admin@example.com", "MfaEmail": { "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We required you to use multi-factor authentication for the following sign-in attempt:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "Subject": "New sign-in attempt", "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "NoActionEmail": { "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We observed an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "Subject": "New sign-in attempt", "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "ReplyTo": "admin@example.com", "SourceArn": "arn:aws:ses:us-west-2:123456789012:identity/admin@example.com" } }, "ClientId": "1example23456789", "CompromisedCredentialsRiskConfiguration": { "Actions": { "EventAction": "BLOCK" }, "EventFilter": [ "PASSWORD_CHANGE", "SIGN_UP", "SIGN_IN" ] }, "RiskExceptionConfiguration": { "BlockedIPRangeList": [ "192.0.2.1/32", "192.0.2.2/32" ], "SkippedIPRangeList": [ "203.0.113.1/32", "203.0.113.2/32" ] }, "UserPoolId": "us-west-2_EXAMPLE" }Output:
{ "RiskConfiguration": { "AccountTakeoverRiskConfiguration": { "Actions": { "HighAction": { "EventAction": "MFA_REQUIRED", "Notify": true }, "LowAction": { "EventAction": "NO_ACTION", "Notify": true }, "MediumAction": { "EventAction": "MFA_IF_CONFIGURED", "Notify": true } }, "NotifyConfiguration": { "BlockEmail": { "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We blocked an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "Subject": "Blocked sign-in attempt", "TextBody": "We blocked an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "From": "admin@example.com", "MfaEmail": { "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We required you to use multi-factor authentication for the following sign-in attempt:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "Subject": "New sign-in attempt", "TextBody": "We required you to use multi-factor authentication for the following sign-in attempt:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "NoActionEmail": { "HtmlBody": "<!DOCTYPE html>\n<html>\n<head>\n\t<title>HTML email context</title>\n\t<meta charset=\"utf-8\">\n</head>\n<body>\n<pre>We observed an unrecognized sign-in to your account with this information:\n<ul>\n<li>Time: {login-time}</li>\n<li>Device: {device-name}</li>\n<li>Location: {city}, {country}</li>\n</ul>\nIf this sign-in was not by you, you should change your password and notify us by clicking on <a href={one-click-link-invalid}>this link</a>\nIf this sign-in was by you, you can follow <a href={one-click-link-valid}>this link</a> to let us know</pre>\n</body>\n</html>", "Subject": "New sign-in attempt", "TextBody": "We observed an unrecognized sign-in to your account with this information:\nTime: {login-time}\nDevice: {device-name}\nLocation: {city}, {country}\nIf this sign-in was not by you, you should change your password and notify us by clicking on {one-click-link-invalid}\nIf this sign-in was by you, you can follow {one-click-link-valid} to let us know" }, "ReplyTo": "admin@example.com", "SourceArn": "arn:aws:ses:us-west-2:123456789012:identity/admin@example.com" } }, "ClientId": "1example23456789", "CompromisedCredentialsRiskConfiguration": { "Actions": { "EventAction": "BLOCK" }, "EventFilter": [ "PASSWORD_CHANGE", "SIGN_UP", "SIGN_IN" ] }, "RiskExceptionConfiguration": { "BlockedIPRangeList": [ "192.0.2.1/32", "192.0.2.2/32" ], "SkippedIPRangeList": [ "203.0.113.1/32", "203.0.113.2/32" ] }, "UserPoolId": "us-west-2_EXAMPLE" } }Per ulteriori informazioni, consulta Protezione dalle minacce nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta SetRiskConfiguration AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareset-ui-customization.
- AWS CLI
-
Esempio 1: come personalizzare l’interfaccia utente ospitata classica per un client dell’app
L’esempio
set-ui-customizationseguente configura il client dell’app richiesto con alcuni CSS personalizzati e con il logo Amazon Cognito come logo dell’applicazione.aws cognito-idp set-ui-customization \ --user-pool-idus-west-2_ywDJHlIfU\ --client-id14pq32c5q2uq2q7keorloqvb23\ --css".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n"\ --image-fileiVBORw0KGgoAAAANSUhEUgAAAFAAAABQCAMAAAC5zwKfAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAA2UExURd00TN9BV/Cmsfvm6f3y9P////fM0uqAj+yNmu6ZpvnZ3eNabuFNYuZneehzhPKzvPTAxwAAAOiMMlkAAAASdFJOU///////////////////////AOK/vxIAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAKDSURBVFhH7ZfpkoMgEISDHKuEw/d/2u2BQWMiBrG29o+fVsKatdPMAeZxc3Nz8w+ISekzmB++sYIw/I/tjHzrPpO2Tx62EbR2PNxFac+jVuKxRaV50IzXkUe76NOCoUuwlvnQKei02gNF0ykotOLRBq/nboeWRxAISx2EbsHFoRhK6Igk2JJlwScfQjgt06dOaWWiTbEDAe/iq8N9kqCw2uCbHkHlYkaXEF8EYeL9RDqT4FhC6XMIIEifdcUwCc4leNyhabadWU6OlKYJE1Oac3NSPhB5rlaXlSgmr/1lww4nPaU/1ylfLGxX1r6Y66ZZkCqvnOlqKWws59ELj7fULc2CubwySYkdDuuiY0/F0L6Q5pZiSG0SfZTSTCOUhxOCH1AdIoCpTTIjtd+VpEjUDDytQH/0Fpc661Aisas/4qmyUItD557pSCOSQQzlx27J+meyDGc5zZgfhWuXE1lGgmVOMwmWdeGdzhjqZV14x5vSj7vsC5JDz/Cl0Vhp56n2NQt1wQIpury1EPbwyaYm+IhmAQKoajkH51wg4cMZ1wQ3QG9efKWWOaDhYWnU6jXjCMdRmm21PArI+Pb5DYoH93hq0ZCPlxeGJho/DI15C6sQc/L2sTC47UFBKZGHT6k+zlXg7WebA0Nr0HTcLMfk/Y4Rc65D3iG6WDd7YLSlVqk87bVhUwhnClrx11RsVQwlAA818Mn+QEs71BhSFU6orsUfKhHp72XMGYXi4q9c64RXRvzkWurRfG2vI2be/VaNcNgpX0Evb/vio7nPMmj5qujkpQgSaPd1UcVqciHFDNZpOcGlcOPyi+AamCbIL9fitxAGeFN2Dl+3vZubm5u/4fH4Bd14HhIPdwZPAAAAAElFTkSuQmCCOutput:
{ "UICustomization": { "UserPoolId": "us-west-2_ywDJHlIfU", "ClientId": "14pq32c5q2uq2q7keorloqvb23", "ImageUrl": "https://cf.thewrong.club/14pq32c5q2uq2q7keorloqvb23/20250117005911/assets/images/image.jpg", "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n", "CSSVersion": "20250117005911" } }Esempio 2: come impostare la personalizzazione dell’interfaccia utente predefinita per tutti i client dell’app
L’esempio
set-ui-customizationseguente configura il pool di utenti richiesto per tutti i client dell’app che non dispongono di una configurazione specifica per il client. Il comando applica alcuni CSS personalizzati e utilizza il logo Amazon Cognito come logo dell’applicazione.aws cognito-idp set-ui-customization \ --user-pool-idus-west-2_ywDJHlIfU\ --client-idALL\ --css".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n"\ --image-fileiVBORw0KGgoAAAANSUhEUgAAAFAAAABQCAMAAAC5zwKfAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAA2UExURd00TN9BV/Cmsfvm6f3y9P////fM0uqAj+yNmu6ZpvnZ3eNabuFNYuZneehzhPKzvPTAxwAAAOiMMlkAAAASdFJOU///////////////////////AOK/vxIAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAKDSURBVFhH7ZfpkoMgEISDHKuEw/d/2u2BQWMiBrG29o+fVsKatdPMAeZxc3Nz8w+ISekzmB++sYIw/I/tjHzrPpO2Tx62EbR2PNxFac+jVuKxRaV50IzXkUe76NOCoUuwlvnQKei02gNF0ykotOLRBq/nboeWRxAISx2EbsHFoRhK6Igk2JJlwScfQjgt06dOaWWiTbEDAe/iq8N9kqCw2uCbHkHlYkaXEF8EYeL9RDqT4FhC6XMIIEifdcUwCc4leNyhabadWU6OlKYJE1Oac3NSPhB5rlaXlSgmr/1lww4nPaU/1ylfLGxX1r6Y66ZZkCqvnOlqKWws59ELj7fULc2CubwySYkdDuuiY0/F0L6Q5pZiSG0SfZTSTCOUhxOCH1AdIoCpTTIjtd+VpEjUDDytQH/0Fpc661Aisas/4qmyUItD557pSCOSQQzlx27J+meyDGc5zZgfhWuXE1lGgmVOMwmWdeGdzhjqZV14x5vSj7vsC5JDz/Cl0Vhp56n2NQt1wQIpury1EPbwyaYm+IhmAQKoajkH51wg4cMZ1wQ3QG9efKWWOaDhYWnU6jXjCMdRmm21PArI+Pb5DYoH93hq0ZCPlxeGJho/DI15C6sQc/L2sTC47UFBKZGHT6k+zlXg7WebA0Nr0HTcLMfk/Y4Rc65D3iG6WDd7YLSlVqk87bVhUwhnClrx11RsVQwlAA818Mn+QEs71BhSFU6orsUfKhHp72XMGYXi4q9c64RXRvzkWurRfG2vI2be/VaNcNgpX0Evb/vio7nPMmj5qujkpQgSaPd1UcVqciHFDNZpOcGlcOPyi+AamCbIL9fitxAGeFN2Dl+3vZubm5u/4fH4Bd14HhIPdwZPAAAAAElFTkSuQmCCOutput:
{ "UICustomization": { "UserPoolId": "us-west-2_ywDJHlIfU", "ClientId": "14pq32c5q2uq2q7keorloqvb23", "ImageUrl": "https://cf.thewrong.club/14pq32c5q2uq2q7keorloqvb23/20250117005911/assets/images/image.jpg", "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 0px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 400;\n}\n.textDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.idpDescription-customizable {\n\tpadding-top: 10px;\n\tpadding-bottom: 10px;\n\tdisplay: block;\n\tfont-size: 16px;\n}\n.legalText-customizable {\n\tcolor: #747474;\n\tfont-size: 11px;\n}\n.submitButton-customizable {\n\tfont-size: 11px;\n\tfont-weight: normal;\n\tmargin: 20px -15px 10px -13px;\n\theight: 40px;\n\twidth: 108%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\n\ttext-align: center;\n}\n.submitButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #286090;\n}\n.errorMessage-customizable {\n\tpadding: 5px;\n\tfont-size: 14px;\n\twidth: 100%;\n\tbackground: #F5F5F5;\n\tborder: 2px solid #D64958;\n\tcolor: #D64958;\n}\n.inputField-customizable {\n\twidth: 100%;\n\theight: 34px;\n\tcolor: #555;\n\tbackground-color: #fff;\n\tborder: 1px solid #ccc;\n\tborder-radius: 0px;\n}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\n\twidth: 100%;\n\twidth: 100%;\n\ttext-align: center;\n\tmargin-bottom: 15px;\n\tcolor: #fff;\n\tbackground-color: #5bc0de;\n\tborder-color: #46b8da;\n}\n.idpButton-customizable:hover {\n\tcolor: #fff;\n\tbackground-color: #31b0d5;\n}\n.socialButton-customizable {\n\tborder-radius: 2px;\n\theight: 40px;\n\tmargin-bottom: 15px;\n\tpadding: 1px;\n\ttext-align: left;\n\twidth: 100%;\n}\n.redirect-customizable {\n\ttext-align: center;\n}\n.passwordCheck-notValid-customizable {\n\tcolor: #DF3312;\n}\n.passwordCheck-valid-customizable {\n\tcolor: #19BF00;\n}\n.background-customizable {\n\tbackground-color: #fff;\n}\n", "CSSVersion": "20250117005911" } }Per ulteriori informazioni, consulta Branding dell’interfaccia utente ospitata (classica) nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta SetUiCustomization AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareset-user-mfa-preference.
- AWS CLI
-
Come impostare la preferenza MFA di un utente
L’esempio
set-user-mfa-preferenceseguente configura l’utente corrente per utilizzare MFA TOTP e disabilita tutti gli altri fattori MFA.aws cognito-idp set-user-mfa-preference \ --access-tokeneyJra456defEXAMPLE\ --software-token-mfa-settingsEnabled=true,PreferredMfa=true\ --sms-mfa-settingsEnabled=false,PreferredMfa=false\ --email-mfa-settingsEnabled=false,PreferredMfa=falseQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Aggiunta di MFA nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta SetUserMfaPreference AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareset-user-pool-mfa-config.
- AWS CLI
-
Per configurare l'MFA del pool di utenti e WebAuthn
L'
set-user-pool-mfa-configesempio seguente configura il pool di utenti richiesto con l'MFA opzionale con tutti i metodi MFA disponibili e imposta la configurazione. WebAuthnaws cognito-idp set-user-pool-mfa-config \ --user-pool-idus-west-2_EXAMPLE\ --sms-mfa-configuration "SmsAuthenticationMessage=\"Your OTP for MFA or sign-in: use {####}.\",SmsConfiguration={SnsCallerArn=arn:aws:iam::123456789012:role/service-role/test-SMS-Role,ExternalId=a1b2c3d4-5678-90ab-cdef-EXAMPLE11111,SnsRegion=us-west-2}" \ --software-token-mfa-configurationEnabled=true\ --email-mfa-configuration "Message=\"Your OTP for MFA or sign-in: use {####}\",Subject=\"OTP test\"" \ --mfa-configurationOPTIONAL\ --web-authn-configurationRelyingPartyId=auth.example.com,UserVerification=preferredOutput:
{ "EmailMfaConfiguration": { "Message": "Your OTP for MFA or sign-in: use {####}", "Subject": "OTP test" }, "MfaConfiguration": "OPTIONAL", "SmsMfaConfiguration": { "SmsAuthenticationMessage": "Your OTP for MFA or sign-in: use {####}.", "SmsConfiguration": { "ExternalId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "SnsCallerArn": "arn:aws:iam::123456789012:role/service-role/test-SMS-Role", "SnsRegion": "us-west-2" } }, "SoftwareTokenMfaConfiguration": { "Enabled": true }, "WebAuthnConfiguration": { "RelyingPartyId": "auth.example.com", "UserVerification": "preferred" } }Per ulteriori informazioni, consulta Aggiunta di MFA e Accesso passkey nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, vedere SetUserPoolMfaConfig
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzareset-user-settings.
- AWS CLI
-
Come configurare le impostazioni utente
Questo esempio imposta la preferenza di consegna MFA su EMAIL.
Comando:
aws cognito-idp set-user-settings --access-tokenACCESS_TOKEN--mfa-optionsDeliveryMedium=EMAIL-
Per i dettagli sull'API, consulta SetUserSettings AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaresign-up.
- AWS CLI
-
Come registrare un utente
In questo esempio viene registrato jane@example.com.
Comando:
aws cognito-idp sign-up --client-id3n4b5urk1ft4fl3mg5e62d9ado--usernamejane@example.com--passwordPASSWORD--user-attributes Name="email",Value="jane@example.com" Name="name",Value="Jane"Output:
{ "UserConfirmed": false, "UserSub": "e04d60a6-45dc-441c-a40b-e25a787d4862" }-
Per i dettagli sull'API, consulta SignUp AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarestart-user-import-job.
- AWS CLI
-
Come avviare un processo di importazione
L’esempio
start-user-import-jobseguente avvia il processo di importazione richiesto nel pool di utenti richiesto.aws cognito-idp start-user-import-job \ --user-pool-idus-west-2_EXAMPLE\ --job-idimport-mAgUtd8PMmOutput:
{ "UserImportJob": { "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/example-cloudwatch-logs-role", "CreationDate": 1736442975.904, "FailedUsers": 0, "ImportedUsers": 0, "JobId": "import-mAgUtd8PMm", "JobName": "Customer import", "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]", "SkippedUsers": 0, "StartDate": 1736443020.081, "Status": "Pending", "UserPoolId": "us-west-2_EXAMPLE" } }Per ulteriori informazioni, consulta Importazione di utenti in un pool di utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta StartUserImportJob AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzarestart-web-authn-registration.
- AWS CLI
-
Come ottenere informazioni sulla registrazione della passkey per un utente che ha effettuato l’accesso
L'
start-web-authn-registrationesempio seguente genera opzioni di WebAuthn registrazione per l'utente corrente.aws cognito-idp start-web-authn-registration \ --access-tokeneyJra456defEXAMPLEOutput:
{ "CredentialCreationOptions": { "authenticatorSelection": { "requireResidentKey": true, "residentKey": "required", "userVerification": "preferred" }, "challenge": "wxvbDicyqQqvF2EXAMPLE", "excludeCredentials": [ { "id": "8LApgk4-lNUFHbhm2w6Und7-uxcc8coJGsPxiogvHoItc64xWQc3r4CEXAMPLE", "type": "public-key" } ], "pubKeyCredParams": [ { "alg": -7, "type": "public-key" }, { "alg": -257, "type": "public-key" } ], "rp": { "id": "auth.example.com", "name": "auth.example.com" }, "timeout": 60000, "user": { "displayName": "testuser", "id": "ZWFhZDAyMTktMjExNy00MzlmLThkNDYtNGRiMjBlNEXAMPLE", "name": "testuser" } } }Per ulteriori informazioni, consulta Accesso con passkey nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, vedere StartWebAuthnRegistration
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzarestop-user-import-job.
- AWS CLI
-
Come interrompere un processo di importazione
L’esempio
stop-user-import-jobseguente interrompe il processo di importazione degli utenti richiesto nel pool di utenti richiesto.aws cognito-idp stop-user-import-job \ --user-pool-idus-west-2_EXAMPLE\ --job-idimport-mAgUtd8PMmOutput:
{ "UserImportJob": { "CloudWatchLogsRoleArn": "arn:aws:iam::123456789012:role/example-cloudwatch-logs-role", "CompletionDate": 1736443496.379, "CompletionMessage": "The Import Job was stopped by the developer.", "CreationDate": 1736443471.781, "FailedUsers": 0, "ImportedUsers": 0, "JobId": "import-mAgUtd8PMm", "JobName": "Customer import", "PreSignedUrl": "https://aws-cognito-idp-user-import-pdx.s3.us-west-2.amazonaws.com/123456789012/us-west-2_EXAMPLE/import-mAgUtd8PMm?X-Amz-Security-Token=[token]&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20241226T193341Z&X-Amz-SignedHeaders=host%3Bx-amz-server-side-encryption&X-Amz-Expires=899&X-Amz-Credential=[credential]&X-Amz-Signature=[signature]", "SkippedUsers": 0, "StartDate": 1736443494.154, "Status": "Stopped", "UserPoolId": "us-west-2_EXAMPLE" } }Per ulteriori informazioni, consulta Importazione di utenti in un pool di utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta StopUserImportJob AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzaretag-resource.
- AWS CLI
-
Come applicare tag a un pool di utenti
L’esempio
tag-resourceseguente applica i tagadministratoredepartmental pool di utenti richiesto.aws cognito-idp tag-resource \ --resource-arnarn:aws:cognito-idp:us-west-2:123456789012:userpool/us-west-2_EXAMPLE\ --tagsadministrator=Jie,tenant=ExampleCorpQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Assegnazione di tag alle risorse Amazon Cognito nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta TagResource AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareuntag-resource.
- AWS CLI
-
Come rimuovere i tag da un pool di utenti
L’esempio
untag-resourceseguente rimuove i tagadministratoredepartmentdal pool di utenti richiesto.aws cognito-idp untag-resource \ --resource-arnarn:aws:cognito-idp:us-west-2:767671399759:userpool/us-west-2_l5cxwdm2K\ --tag-keysadministratortenantQuesto comando non produce alcun output.
Per ulteriori informazioni, consulta Assegnazione di tag alle risorse Amazon Cognito nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta UntagResource AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-auth-event-feedback.
- AWS CLI
-
Come aggiornare il feedback sugli eventi di autenticazione
Questo esempio aggiorna il feedback sugli eventi di autorizzazione. L’evento viene contrassegnato come “Valido”.
Comando:
aws cognito-idp update-auth-event-feedback --user-pool-idus-west-2_aaaaaaaaa--usernamediego@example.com--event-idEVENT_ID--feedback-tokenFEEDBACK_TOKEN--feedback-value"Valid"-
Per i dettagli sull'API, consulta UpdateAuthEventFeedback AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-device-status.
- AWS CLI
-
Come aggiornare lo stato del dispositivo
Questo esempio aggiorna lo stato di un dispositivo a “not_remembered”.
Comando:
aws cognito-idp update-device-status --access-tokenACCESS_TOKEN--device-keyDEVICE_KEY--device-remembered-status"not_remembered"-
Per i dettagli sull'API, consulta UpdateDeviceStatus AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-group.
- AWS CLI
-
Come aggiornare un gruppo
Questo esempio aggiorna la descrizione e la precedenza di MyGroup.
Comando:
aws cognito-idp update-group --user-pool-idus-west-2_aaaaaaaaa--group-nameMyGroup--description"New description"--precedence2Output:
{ "Group": { "GroupName": "MyGroup", "UserPoolId": "us-west-2_aaaaaaaaa", "Description": "New description", "RoleArn": "arn:aws:iam::111111111111:role/MyRole", "Precedence": 2, "LastModifiedDate": 1548800862.812, "CreationDate": 1548097827.125 } }-
Per i dettagli sull'API, vedere UpdateGroup
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-identity-provider.
- AWS CLI
-
Come aggiornare un gestore dell’identità del pool di utenti
L'
update-identity-provideresempio seguente aggiorna il provider OIDC «My OIDCId P» nel pool di utenti richiesto.aws cognito-idp update-identity-provider \ --cli-input-jsonfile://update-identity-provider.jsonContenuto di
update-identity-provider.json:{ "AttributeMapping": { "email": "idp_email", "email_verified": "idp_email_verified", "username": "sub" }, "CreationDate": 1.701129701653E9, "IdpIdentifiers": [ "corp", "dev" ], "LastModifiedDate": 1.701129701653E9, "ProviderDetails": { "attributes_request_method": "GET", "attributes_url": "https://example.com/userInfo", "attributes_url_add_attributes": "false", "authorize_scopes": "openid profile", "authorize_url": "https://example.com/authorize", "client_id": "idpexampleclient123", "client_secret": "idpexamplesecret456", "jwks_uri": "https://example.com/.well-known/jwks.json", "oidc_issuer": "https://example.com", "token_url": "https://example.com/token" }, "ProviderName": "MyOIDCIdP", "UserPoolId": "us-west-2_EXAMPLE" }Output:
{ "IdentityProvider": { "AttributeMapping": { "email": "idp_email", "email_verified": "idp_email_verified", "username": "sub" }, "CreationDate": 1701129701.653, "IdpIdentifiers": [ "corp", "dev" ], "LastModifiedDate": 1736444278.211, "ProviderDetails": { "attributes_request_method": "GET", "attributes_url": "https://example.com/userInfo", "attributes_url_add_attributes": "false", "authorize_scopes": "openid profile", "authorize_url": "https://example.com/authorize", "client_id": "idpexampleclient123", "client_secret": "idpexamplesecret456", "jwks_uri": "https://example.com/.well-known/jwks.json", "oidc_issuer": "https://example.com", "token_url": "https://example.com/token" }, "ProviderName": "MyOIDCIdP", "ProviderType": "OIDC", "UserPoolId": "us-west-2_EXAMPLE" } }Per ulteriori informazioni, consulta Configurazione di un dominio nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, vedere UpdateIdentityProvider
in AWS CLI Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-managed-login-branding.
- AWS CLI
-
Come aggiornare lo stile di branding dell’accesso gestito
L’esempio
update-managed-login-brandingseguente aggiorna lo stile di branding del client dell’app richiesto.aws cognito-idp update-managed-login-branding \ --cli-input-jsonfile://update-managed-login-branding.jsonContenuto di
update-managed-login-branding.json:{ "Assets": [ { "Bytes": "PHN2ZyB3aWR0aD0iMjAwMDAiIGhlaWdodD0iNDAwIiB2aWV3Qm94PSIwIDAgMjAwMDAgNDAwIiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8ZyBjbGlwLXBhdGg9InVybCgjY2xpcDBfMTcyNTlfMjM2Njc0KSI+CjxyZWN0IHdpZHRoPSIyMDAwMCIgaGVpZ2h0PSI0MDAiIGZpbGw9InVybCgjcGFpbnQwX2xpbmVhcl8xNzI1OV8yMzY2NzQpIi8+CjxwYXRoIGQ9Ik0wIDBIMjAwMDBWNDAwSDBWMFoiIGZpbGw9IiMxMjIwMzciIGZpbGwtb3BhY2l0eT0iMC41Ii8+CjwvZz4KPGRlZnM+CjxsaW5lYXJHcmFkaWVudCBpZD0icGFpbnQwX2xpbmVhcl8xNzI1OV8yMzY2NzQiIHgxPSItODk0LjI0OSIgeTE9IjE5OS45MzEiIHgyPSIxODAzNC41IiB5Mj0iLTU4OTkuNTciIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj4KPHN0b3Agc3RvcC1jb2xvcj0iI0JGODBGRiIvPgo8c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IiNGRjhGQUIiLz4KPC9saW5lYXJHcmFkaWVudD4KPGNsaXBQYXRoIGlkPSJjbGlwMF8xNzI1OV8yMzY2NzQiPgo8cmVjdCB3aWR0aD0iMjAwMDAiIGhlaWdodD0iNDAwIiBmaWxsPSJ3aGl0ZSIvPgo8L2NsaXBQYXRoPgo8L2RlZnM+Cjwvc3ZnPgo=", "Category": "PAGE_FOOTER_BACKGROUND", "ColorMode": "DARK", "Extension": "SVG" } ], "ManagedLoginBrandingId": "63f30090-6b1f-4278-b885-2bbb81f8e545", "Settings": { "categories": { "auth": { "authMethodOrder": [ [ { "display": "BUTTON", "type": "FEDERATED" }, { "display": "INPUT", "type": "USERNAME_PASSWORD" } ] ], "federation": { "interfaceStyle": "BUTTON_LIST", "order": [ ] } }, "form": { "displayGraphics": true, "instructions": { "enabled": false }, "languageSelector": { "enabled": false }, "location": { "horizontal": "CENTER", "vertical": "CENTER" }, "sessionTimerDisplay": "NONE" }, "global": { "colorSchemeMode": "LIGHT", "pageFooter": { "enabled": false }, "pageHeader": { "enabled": false }, "spacingDensity": "REGULAR" }, "signUp": { "acceptanceElements": [ { "enforcement": "NONE", "textKey": "en" } ] } }, "componentClasses": { "buttons": { "borderRadius": 8.0 }, "divider": { "darkMode": { "borderColor": "232b37ff" }, "lightMode": { "borderColor": "ebebf0ff" } }, "dropDown": { "borderRadius": 8.0, "darkMode": { "defaults": { "itemBackgroundColor": "192534ff" }, "hover": { "itemBackgroundColor": "081120ff", "itemBorderColor": "5f6b7aff", "itemTextColor": "e9ebedff" }, "match": { "itemBackgroundColor": "d1d5dbff", "itemTextColor": "89bdeeff" } }, "lightMode": { "defaults": { "itemBackgroundColor": "ffffffff" }, "hover": { "itemBackgroundColor": "f4f4f4ff", "itemBorderColor": "7d8998ff", "itemTextColor": "000716ff" }, "match": { "itemBackgroundColor": "414d5cff", "itemTextColor": "0972d3ff" } } }, "focusState": { "darkMode": { "borderColor": "539fe5ff" }, "lightMode": { "borderColor": "0972d3ff" } }, "idpButtons": { "icons": { "enabled": true } }, "input": { "borderRadius": 8.0, "darkMode": { "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "5f6b7aff" }, "placeholderColor": "8d99a8ff" }, "lightMode": { "defaults": { "backgroundColor": "ffffffff", "borderColor": "7d8998ff" }, "placeholderColor": "5f6b7aff" } }, "inputDescription": { "darkMode": { "textColor": "8d99a8ff" }, "lightMode": { "textColor": "5f6b7aff" } }, "inputLabel": { "darkMode": { "textColor": "d1d5dbff" }, "lightMode": { "textColor": "000716ff" } }, "link": { "darkMode": { "defaults": { "textColor": "539fe5ff" }, "hover": { "textColor": "89bdeeff" } }, "lightMode": { "defaults": { "textColor": "0972d3ff" }, "hover": { "textColor": "033160ff" } } }, "optionControls": { "darkMode": { "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "7d8998ff" }, "selected": { "backgroundColor": "539fe5ff", "foregroundColor": "000716ff" } }, "lightMode": { "defaults": { "backgroundColor": "ffffffff", "borderColor": "7d8998ff" }, "selected": { "backgroundColor": "0972d3ff", "foregroundColor": "ffffffff" } } }, "statusIndicator": { "darkMode": { "error": { "backgroundColor": "1a0000ff", "borderColor": "eb6f6fff", "indicatorColor": "eb6f6fff" }, "pending": { "indicatorColor": "AAAAAAAA" }, "success": { "backgroundColor": "001a02ff", "borderColor": "29ad32ff", "indicatorColor": "29ad32ff" }, "warning": { "backgroundColor": "1d1906ff", "borderColor": "e0ca57ff", "indicatorColor": "e0ca57ff" } }, "lightMode": { "error": { "backgroundColor": "fff7f7ff", "borderColor": "d91515ff", "indicatorColor": "d91515ff" }, "pending": { "indicatorColor": "AAAAAAAA" }, "success": { "backgroundColor": "f2fcf3ff", "borderColor": "037f0cff", "indicatorColor": "037f0cff" }, "warning": { "backgroundColor": "fffce9ff", "borderColor": "8d6605ff", "indicatorColor": "8d6605ff" } } } }, "components": { "alert": { "borderRadius": 12.0, "darkMode": { "error": { "backgroundColor": "1a0000ff", "borderColor": "eb6f6fff" } }, "lightMode": { "error": { "backgroundColor": "fff7f7ff", "borderColor": "d91515ff" } } }, "favicon": { "enabledTypes": [ "ICO", "SVG" ] }, "form": { "backgroundImage": { "enabled": false }, "borderRadius": 8.0, "darkMode": { "backgroundColor": "0f1b2aff", "borderColor": "424650ff" }, "lightMode": { "backgroundColor": "ffffffff", "borderColor": "c6c6cdff" }, "logo": { "enabled": false, "formInclusion": "IN", "location": "CENTER", "position": "TOP" } }, "idpButton": { "custom": { }, "standard": { "darkMode": { "active": { "backgroundColor": "354150ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" }, "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "c6c6cdff", "textColor": "c6c6cdff" }, "hover": { "backgroundColor": "192534ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" } }, "lightMode": { "active": { "backgroundColor": "d3e7f9ff", "borderColor": "033160ff", "textColor": "033160ff" }, "defaults": { "backgroundColor": "ffffffff", "borderColor": "424650ff", "textColor": "424650ff" }, "hover": { "backgroundColor": "f2f8fdff", "borderColor": "033160ff", "textColor": "033160ff" } } } }, "pageBackground": { "darkMode": { "color": "0f1b2aff" }, "image": { "enabled": true }, "lightMode": { "color": "ffffffff" } }, "pageFooter": { "backgroundImage": { "enabled": false }, "darkMode": { "background": { "color": "0f141aff" }, "borderColor": "424650ff" }, "lightMode": { "background": { "color": "fafafaff" }, "borderColor": "d5dbdbff" }, "logo": { "enabled": false, "location": "START" } }, "pageHeader": { "backgroundImage": { "enabled": false }, "darkMode": { "background": { "color": "0f141aff" }, "borderColor": "424650ff" }, "lightMode": { "background": { "color": "fafafaff" }, "borderColor": "d5dbdbff" }, "logo": { "enabled": false, "location": "START" } }, "pageText": { "darkMode": { "bodyColor": "b6bec9ff", "descriptionColor": "b6bec9ff", "headingColor": "d1d5dbff" }, "lightMode": { "bodyColor": "414d5cff", "descriptionColor": "414d5cff", "headingColor": "000716ff" } }, "phoneNumberSelector": { "displayType": "TEXT" }, "primaryButton": { "darkMode": { "active": { "backgroundColor": "539fe5ff", "textColor": "000716ff" }, "defaults": { "backgroundColor": "539fe5ff", "textColor": "000716ff" }, "disabled": { "backgroundColor": "ffffffff", "borderColor": "ffffffff" }, "hover": { "backgroundColor": "89bdeeff", "textColor": "000716ff" } }, "lightMode": { "active": { "backgroundColor": "033160ff", "textColor": "ffffffff" }, "defaults": { "backgroundColor": "0972d3ff", "textColor": "ffffffff" }, "disabled": { "backgroundColor": "ffffffff", "borderColor": "ffffffff" }, "hover": { "backgroundColor": "033160ff", "textColor": "ffffffff" } } }, "secondaryButton": { "darkMode": { "active": { "backgroundColor": "354150ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" }, "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "539fe5ff", "textColor": "539fe5ff" }, "hover": { "backgroundColor": "192534ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" } }, "lightMode": { "active": { "backgroundColor": "d3e7f9ff", "borderColor": "033160ff", "textColor": "033160ff" }, "defaults": { "backgroundColor": "ffffffff", "borderColor": "0972d3ff", "textColor": "0972d3ff" }, "hover": { "backgroundColor": "f2f8fdff", "borderColor": "033160ff", "textColor": "033160ff" } } } } }, "UseCognitoProvidedValues": false, "UserPoolId": "ca-central-1_EXAMPLE" }Output:
{ "ManagedLoginBranding": { "Assets": [ { "Bytes": "PHN2ZyB3aWR0aD0iMjAwMDAiIGhlaWdodD0iNDAwIiB2aWV3Qm94PSIwIDAgMjAwMDAgNDAwIiBmaWxsPSJub25lIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgo8ZyBjbGlwLXBhdGg9InVybCgjY2xpcDBfMTcyNTlfMjM2Njc0KSI+CjxyZWN0IHdpZHRoPSIyMDAwMCIgaGVpZ2h0PSI0MDAiIGZpbGw9InVybCgjcGFpbnQwX2xpbmVhcl8xNzI1OV8yMzY2NzQpIi8+CjxwYXRoIGQ9Ik0wIDBIMjAwMDBWNDAwSDBWMFoiIGZpbGw9IiMxMjIwMzciIGZpbGwtb3BhY2l0eT0iMC41Ii8+CjwvZz4KPGRlZnM+CjxsaW5lYXJHcmFkaWVudCBpZD0icGFpbnQwX2xpbmVhcl8xNzI1OV8yMzY2NzQiIHgxPSItODk0LjI0OSIgeTE9IjE5OS45MzEiIHgyPSIxODAzNC41IiB5Mj0iLTU4OTkuNTciIGdyYWRpZW50VW5pdHM9InVzZXJTcGFjZU9uVXNlIj4KPHN0b3Agc3RvcC1jb2xvcj0iI0JGODBGRiIvPgo8c3RvcCBvZmZzZXQ9IjEiIHN0b3AtY29sb3I9IiNGRjhGQUIiLz4KPC9saW5lYXJHcmFkaWVudD4KPGNsaXBQYXRoIGlkPSJjbGlwMF8xNzI1OV8yMzY2NzQiPgo8cmVjdCB3aWR0aD0iMjAwMDAiIGhlaWdodD0iNDAwIiBmaWxsPSJ3aGl0ZSIvPgo8L2NsaXBQYXRoPgo8L2RlZnM+Cjwvc3ZnPgo=", "Category": "PAGE_FOOTER_BACKGROUND", "ColorMode": "DARK", "Extension": "SVG" } ], "CreationDate": 1732138490.642, "LastModifiedDate": 1732140420.301, "ManagedLoginBrandingId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "Settings": { "categories": { "auth": { "authMethodOrder": [ [ { "display": "BUTTON", "type": "FEDERATED" }, { "display": "INPUT", "type": "USERNAME_PASSWORD" } ] ], "federation": { "interfaceStyle": "BUTTON_LIST", "order": [ ] } }, "form": { "displayGraphics": true, "instructions": { "enabled": false }, "languageSelector": { "enabled": false }, "location": { "horizontal": "CENTER", "vertical": "CENTER" }, "sessionTimerDisplay": "NONE" }, "global": { "colorSchemeMode": "LIGHT", "pageFooter": { "enabled": false }, "pageHeader": { "enabled": false }, "spacingDensity": "REGULAR" }, "signUp": { "acceptanceElements": [ { "enforcement": "NONE", "textKey": "en" } ] } }, "componentClasses": { "buttons": { "borderRadius": 8.0 }, "divider": { "darkMode": { "borderColor": "232b37ff" }, "lightMode": { "borderColor": "ebebf0ff" } }, "dropDown": { "borderRadius": 8.0, "darkMode": { "defaults": { "itemBackgroundColor": "192534ff" }, "hover": { "itemBackgroundColor": "081120ff", "itemBorderColor": "5f6b7aff", "itemTextColor": "e9ebedff" }, "match": { "itemBackgroundColor": "d1d5dbff", "itemTextColor": "89bdeeff" } }, "lightMode": { "defaults": { "itemBackgroundColor": "ffffffff" }, "hover": { "itemBackgroundColor": "f4f4f4ff", "itemBorderColor": "7d8998ff", "itemTextColor": "000716ff" }, "match": { "itemBackgroundColor": "414d5cff", "itemTextColor": "0972d3ff" } } }, "focusState": { "darkMode": { "borderColor": "539fe5ff" }, "lightMode": { "borderColor": "0972d3ff" } }, "idpButtons": { "icons": { "enabled": true } }, "input": { "borderRadius": 8.0, "darkMode": { "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "5f6b7aff" }, "placeholderColor": "8d99a8ff" }, "lightMode": { "defaults": { "backgroundColor": "ffffffff", "borderColor": "7d8998ff" }, "placeholderColor": "5f6b7aff" } }, "inputDescription": { "darkMode": { "textColor": "8d99a8ff" }, "lightMode": { "textColor": "5f6b7aff" } }, "inputLabel": { "darkMode": { "textColor": "d1d5dbff" }, "lightMode": { "textColor": "000716ff" } }, "link": { "darkMode": { "defaults": { "textColor": "539fe5ff" }, "hover": { "textColor": "89bdeeff" } }, "lightMode": { "defaults": { "textColor": "0972d3ff" }, "hover": { "textColor": "033160ff" } } }, "optionControls": { "darkMode": { "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "7d8998ff" }, "selected": { "backgroundColor": "539fe5ff", "foregroundColor": "000716ff" } }, "lightMode": { "defaults": { "backgroundColor": "ffffffff", "borderColor": "7d8998ff" }, "selected": { "backgroundColor": "0972d3ff", "foregroundColor": "ffffffff" } } }, "statusIndicator": { "darkMode": { "error": { "backgroundColor": "1a0000ff", "borderColor": "eb6f6fff", "indicatorColor": "eb6f6fff" }, "pending": { "indicatorColor": "AAAAAAAA" }, "success": { "backgroundColor": "001a02ff", "borderColor": "29ad32ff", "indicatorColor": "29ad32ff" }, "warning": { "backgroundColor": "1d1906ff", "borderColor": "e0ca57ff", "indicatorColor": "e0ca57ff" } }, "lightMode": { "error": { "backgroundColor": "fff7f7ff", "borderColor": "d91515ff", "indicatorColor": "d91515ff" }, "pending": { "indicatorColor": "AAAAAAAA" }, "success": { "backgroundColor": "f2fcf3ff", "borderColor": "037f0cff", "indicatorColor": "037f0cff" }, "warning": { "backgroundColor": "fffce9ff", "borderColor": "8d6605ff", "indicatorColor": "8d6605ff" } } } }, "components": { "alert": { "borderRadius": 12.0, "darkMode": { "error": { "backgroundColor": "1a0000ff", "borderColor": "eb6f6fff" } }, "lightMode": { "error": { "backgroundColor": "fff7f7ff", "borderColor": "d91515ff" } } }, "favicon": { "enabledTypes": [ "ICO", "SVG" ] }, "form": { "backgroundImage": { "enabled": false }, "borderRadius": 8.0, "darkMode": { "backgroundColor": "0f1b2aff", "borderColor": "424650ff" }, "lightMode": { "backgroundColor": "ffffffff", "borderColor": "c6c6cdff" }, "logo": { "enabled": false, "formInclusion": "IN", "location": "CENTER", "position": "TOP" } }, "idpButton": { "custom": { }, "standard": { "darkMode": { "active": { "backgroundColor": "354150ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" }, "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "c6c6cdff", "textColor": "c6c6cdff" }, "hover": { "backgroundColor": "192534ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" } }, "lightMode": { "active": { "backgroundColor": "d3e7f9ff", "borderColor": "033160ff", "textColor": "033160ff" }, "defaults": { "backgroundColor": "ffffffff", "borderColor": "424650ff", "textColor": "424650ff" }, "hover": { "backgroundColor": "f2f8fdff", "borderColor": "033160ff", "textColor": "033160ff" } } } }, "pageBackground": { "darkMode": { "color": "0f1b2aff" }, "image": { "enabled": true }, "lightMode": { "color": "ffffffff" } }, "pageFooter": { "backgroundImage": { "enabled": false }, "darkMode": { "background": { "color": "0f141aff" }, "borderColor": "424650ff" }, "lightMode": { "background": { "color": "fafafaff" }, "borderColor": "d5dbdbff" }, "logo": { "enabled": false, "location": "START" } }, "pageHeader": { "backgroundImage": { "enabled": false }, "darkMode": { "background": { "color": "0f141aff" }, "borderColor": "424650ff" }, "lightMode": { "background": { "color": "fafafaff" }, "borderColor": "d5dbdbff" }, "logo": { "enabled": false, "location": "START" } }, "pageText": { "darkMode": { "bodyColor": "b6bec9ff", "descriptionColor": "b6bec9ff", "headingColor": "d1d5dbff" }, "lightMode": { "bodyColor": "414d5cff", "descriptionColor": "414d5cff", "headingColor": "000716ff" } }, "phoneNumberSelector": { "displayType": "TEXT" }, "primaryButton": { "darkMode": { "active": { "backgroundColor": "539fe5ff", "textColor": "000716ff" }, "defaults": { "backgroundColor": "539fe5ff", "textColor": "000716ff" }, "disabled": { "backgroundColor": "ffffffff", "borderColor": "ffffffff" }, "hover": { "backgroundColor": "89bdeeff", "textColor": "000716ff" } }, "lightMode": { "active": { "backgroundColor": "033160ff", "textColor": "ffffffff" }, "defaults": { "backgroundColor": "0972d3ff", "textColor": "ffffffff" }, "disabled": { "backgroundColor": "ffffffff", "borderColor": "ffffffff" }, "hover": { "backgroundColor": "033160ff", "textColor": "ffffffff" } } }, "secondaryButton": { "darkMode": { "active": { "backgroundColor": "354150ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" }, "defaults": { "backgroundColor": "0f1b2aff", "borderColor": "539fe5ff", "textColor": "539fe5ff" }, "hover": { "backgroundColor": "192534ff", "borderColor": "89bdeeff", "textColor": "89bdeeff" } }, "lightMode": { "active": { "backgroundColor": "d3e7f9ff", "borderColor": "033160ff", "textColor": "033160ff" }, "defaults": { "backgroundColor": "ffffffff", "borderColor": "0972d3ff", "textColor": "0972d3ff" }, "hover": { "backgroundColor": "f2f8fdff", "borderColor": "033160ff", "textColor": "033160ff" } } } } }, "UseCognitoProvidedValues": false, "UserPoolId": "ca-central-1_EXAMPLE" } }Per ulteriori informazioni, consulta Applicare il branding alle pagine di accesso gestite nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta UpdateManagedLoginBranding AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-resource-server.
- AWS CLI
-
Come aggiornare un server di risorse
Questo esempio aggiorna il server di risorse Weather. Aggiunge un nuovo ambito.
Comando:
aws cognito-idp update-resource-server --user-pool-idus-west-2_aaaaaaaaa--identifierweather.example.com--nameWeather--scopes ScopeName=NewScope,ScopeDescription="New scope description"Output:
{ "ResourceServer": { "UserPoolId": "us-west-2_aaaaaaaaa", "Identifier": "weather.example.com", "Name": "Happy", "Scopes": [ { "ScopeName": "NewScope", "ScopeDescription": "New scope description" } ] } }-
Per i dettagli sull'API, consulta UpdateResourceServer AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-user-attributes.
- AWS CLI
-
Come aggiornare gli attributi utente
Questo esempio aggiorna l’attributo utente “nickname”.
Comando:
aws cognito-idp update-user-attributes --access-tokenACCESS_TOKEN--user-attributes Name="nickname",Value="Dan"-
Per i dettagli sull'API, consulta UpdateUserAttributes AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-user-pool-client.
- AWS CLI
-
Come aggiornare un client dell’app
L’esempio
update-user-pool-clientseguente aggiorna la configurazione del client dell’app richiesto.aws cognito-idp update-user-pool-client \ --user-pool-idus-west-2_EXAMPLE\ --client-id1example23456789\ --client-namemy-test-app\ --refresh-token-validity30\ --access-token-validity60\ --id-token-validity60\ --token-validity-unitsAccessToken=minutes,IdToken=minutes,RefreshToken=days\ --read-attributes"address""birthdate""email""email_verified""family_name""gender""locale""middle_name""name""nickname""phone_number""phone_number_verified""picture""preferred_username""profile""updated_at""website""zoneinfo"\ --write-attributes"address""birthdate""email""family_name""gender""locale""middle_name""name""nickname""phone_number""picture""preferred_username""profile""updated_at""website""zoneinfo"\ --explicit-auth-flows"ALLOW_ADMIN_USER_PASSWORD_AUTH""ALLOW_CUSTOM_AUTH""ALLOW_REFRESH_TOKEN_AUTH""ALLOW_USER_PASSWORD_AUTH""ALLOW_USER_SRP_AUTH"\ --supported-identity-providers"MySAML""COGNITO""Google"\ --callback-urls"https://www.example.com""https://app2.example.com"\ --logout-urls"https://auth.example.com/login?client_id=1example23456789&response_type=code&redirect_uri=https%3A%2F%2Fwww.example.com""https://example.com/logout"\ --default-redirect-uri"https://www.example.com"\ --allowed-o-auth-flows"code""implicit"\ --allowed-o-auth-scopes"openid""profile""aws.cognito.signin.user.admin"\ --allowed-o-auth-flows-user-pool-client \ --prevent-user-existence-errorsENABLED\ --enable-token-revocation \ --no-enable-propagate-additional-user-context-data \ --auth-session-validity3Output:
{ "UserPoolClient": { "UserPoolId": "us-west-2_EXAMPLE", "ClientName": "my-test-app", "ClientId": "1example23456789", "LastModifiedDate": "2025-01-31T14:40:12.498000-08:00", "CreationDate": "2023-09-13T16:26:34.408000-07:00", "RefreshTokenValidity": 30, "AccessTokenValidity": 60, "IdTokenValidity": 60, "TokenValidityUnits": { "AccessToken": "minutes", "IdToken": "minutes", "RefreshToken": "days" }, "ReadAttributes": [ "website", "zoneinfo", "address", "birthdate", "email_verified", "gender", "profile", "phone_number_verified", "preferred_username", "locale", "middle_name", "picture", "updated_at", "name", "nickname", "phone_number", "family_name", "email" ], "WriteAttributes": [ "website", "zoneinfo", "address", "birthdate", "gender", "profile", "preferred_username", "locale", "middle_name", "picture", "updated_at", "name", "nickname", "phone_number", "family_name", "email" ], "ExplicitAuthFlows": [ "ALLOW_CUSTOM_AUTH", "ALLOW_USER_PASSWORD_AUTH", "ALLOW_ADMIN_USER_PASSWORD_AUTH", "ALLOW_USER_SRP_AUTH", "ALLOW_REFRESH_TOKEN_AUTH" ], "SupportedIdentityProviders": [ "Google", "COGNITO", "MySAML" ], "CallbackURLs": [ "https://www.example.com", "https://app2.example.com" ], "LogoutURLs": [ "https://example.com/logout", "https://auth.example.com/login?client_id=1example23456789&response_type=code&redirect_uri=https%3A%2F%2Fwww.example.com" ], "DefaultRedirectURI": "https://www.example.com", "AllowedOAuthFlows": [ "implicit", "code" ], "AllowedOAuthScopes": [ "aws.cognito.signin.user.admin", "openid", "profile" ], "AllowedOAuthFlowsUserPoolClient": true, "PreventUserExistenceErrors": "ENABLED", "EnableTokenRevocation": true, "EnablePropagateAdditionalUserContextData": false, "AuthSessionValidity": 3 } }Per ulteriori informazioni, consulta Impostazioni specifiche dell’applicazione con i client dell’app nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta UpdateUserPoolClient AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-user-pool-domain.
- AWS CLI
-
Come aggiornare un dominio personalizzato
L’esempio
update-user-pool-domainseguente configura la versione di branding e il certificato per il dominio personalizzato del pool di utenti richiesto.aws cognito-idp update-user-pool-domain \ --user-pool-idca-central-1_EXAMPLE\ --domainauth.example.com\ --managed-login-version2\ --custom-domain-configCertificateArn=arn:aws:acm:us-east-1:123456789012:certificate/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111Output:
{ "CloudFrontDomain": "example.cloudfront.net", "ManagedLoginVersion": 2 }Per ulteriori informazioni, consulta Accesso gestito e Configurazione di un dominio nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta UpdateUserPoolDomain AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareupdate-user-pool.
- AWS CLI
-
Come aggiornare un pool di utenti
L’esempio
update-user-poolseguente modifica un pool di utenti con una sintassi di esempio per ciascuna delle opzioni di configurazione disponibili. Per aggiornare un pool di utenti, è necessario specificare tutte le opzioni configurate in precedenza. In caso contrario, verrà ripristinato il relativo valore predefinito.aws cognito-idp update-user-pool --user-pool-idus-west-2_EXAMPLE\ --policies PasswordPolicy=\{MinimumLength=6,RequireUppercase=true,RequireLowercase=true,RequireNumbers=true,RequireSymbols=true,TemporaryPasswordValidityDays=7\} \ --deletion-protectionACTIVE\ --lambda-config PreSignUp="arn:aws:lambda:us-west-2:123456789012:function:cognito-test-presignup-function",PreTokenGeneration="arn:aws:lambda:us-west-2:123456789012:function:cognito-test-pretoken-function" \ --auto-verified-attributes"phone_number""email"\ --verification-message-template \{\"SmsMessage\":\""Your code is {####}"\",\"EmailMessage\":\""Your code is {####}"\",\"EmailSubject\":\""Your verification code"\",\"EmailMessageByLink\":\""Click {##here##} to verify your email address."\",\"EmailSubjectByLink\":\""Your verification link"\",\"DefaultEmailOption\":\"CONFIRM_WITH_LINK\"\} \ --sms-authentication-message "Your code is {####}" \ --user-attribute-update-settings AttributesRequireVerificationBeforeUpdate="email","phone_number" \ --mfa-configuration"OPTIONAL"\ --device-configurationChallengeRequiredOnNewDevice=true,DeviceOnlyRememberedOnUserPrompt=true\ --email-configuration SourceArn="arn:aws:ses:us-west-2:123456789012:identity/admin@example.com",ReplyToEmailAddress="amdin+noreply@example.com",EmailSendingAccount=DEVELOPER,From="admin@amazon.com",ConfigurationSet="test-configuration-set" \ --sms-configuration SnsCallerArn="arn:aws:iam::123456789012:role/service-role/SNS-SMS-Role",ExternalId="12345",SnsRegion="us-west-2" \ --admin-create-user-config AllowAdminCreateUserOnly=false,InviteMessageTemplate=\{SMSMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailSubject=\""Welcome to MyMobileGame"\"\} \ --user-pool-tags "Function"="MyMobileGame","Developers"="Berlin" \ --admin-create-user-config AllowAdminCreateUserOnly=false,InviteMessageTemplate=\{SMSMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailMessage=\""Welcome {username}. Your confirmation code is {####}"\",EmailSubject=\""Welcome to MyMobileGame"\"\} \ --user-pool-add-ons AdvancedSecurityMode="AUDIT" \ --account-recovery-setting RecoveryMechanisms=\[\{Priority=1,Name="verified_email"\},\{Priority=2,Name="verified_phone_number"\}\]Questo comando non produce alcun output.
Per ulteriori informazioni, consulta Aggiornamento della configurazione del pool di utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta UpdateUserPool AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareverify-software-token.
- AWS CLI
-
Come confermare la registrazione di un autenticatore TOTP
L’esempio
verify-software-tokenseguente completa la registrazione TOTP per l’utente corrente.aws cognito-idp verify-software-token \ --access-tokeneyJra456defEXAMPLE\ --user-code123456Output:
{ "Status": "SUCCESS" }Per ulteriori informazioni, consulta Aggiunta dell’autenticazione MFA a un pool di utenti nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta VerifySoftwareToken AWS CLI
Command Reference.
-
Il seguente esempio di codice mostra come utilizzareverify-user-attribute.
- AWS CLI
-
Come verificare una modifica degli attributi
L’esempio
verify-user-attributeseguente verifica una modifica apportata all’attributo e-mail dell’utente corrente.aws cognito-idp verify-user-attribute \ --access-tokeneyJra456defEXAMPLE\ --attribute-nameemail\ --code123456Per ulteriori informazioni, consulta Configurazione della verifica di e-mail o telefono nella Guida per gli sviluppatori di Amazon Cognito.
-
Per i dettagli sull'API, consulta VerifyUserAttribute AWS CLI
Command Reference.
-
