Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
Beispiele für Amazon Cognito Identity Provider mit AWS CLI
Die folgenden Codebeispiele zeigen Ihnen, wie Sie mithilfe von Amazon Cognito Identity Provider Aktionen ausführen und allgemeine Szenarien implementieren. AWS Command Line Interface
Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Aktionen zeigen Ihnen zwar, wie Sie einzelne Servicefunktionen aufrufen, aber Sie können Aktionen im Kontext der zugehörigen Szenarien sehen.
Jedes Beispiel enthält einen Link zum vollständigen Quellcode, in dem Sie Anweisungen zum Einrichten und Ausführen des Codes im Kontext finden.
Themen
Aktionen
Das folgende Codebeispiel zeigt die Verwendungadd-custom-attributes
.
- AWS CLI
-
Um ein benutzerdefiniertes Attribut hinzuzufügen
In diesem Beispiel wird einem Benutzerpool das benutzerdefinierte Attribut CustomAttr 1 hinzugefügt. Es ist vom Typ Zeichenfolge und erfordert mindestens 1 und maximal 15 Zeichen. Sie ist nicht erforderlich.
Befehl:
aws cognito-idp add-custom-attributes --user-pool-id
us-west-2_aaaaaaaaa
--custom-attributes Name="CustomAttr1",AttributeDataType="String",DeveloperOnlyAttribute=false,Required=false,StringAttributeConstraints="{MinLength=1,MaxLength=15}"-
APIEinzelheiten finden Sie AddCustomAttributes
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmim-disable-user
.
- AWS CLI
-
Um einen Benutzer zu deaktivieren
In diesem Beispiel wird der Benutzer jane@example.com deaktiviert.
Befehl:
aws cognito-idp admin-disable-user --user-pool-id
us-west-2_aaaaaaaaa
--usernamejane@example.com
-
APIEinzelheiten finden Sie AdmimDisableUser
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmim-enable-user
.
- AWS CLI
-
Um einen Benutzer zu aktivieren
In diesem Beispiel wird der Benutzername jane@example.com aktiviert.
Befehl:
aws cognito-idp admin-enable-user --user-pool-id
us-west-2_aaaaaaaaa
--usernamejane@example.com
-
APIEinzelheiten finden Sie AdmimEnableUser
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-add-user-to-group
.
- AWS CLI
-
Um einen Benutzer zu einer Gruppe hinzuzufügen
In diesem Beispiel wird der Benutzer Jane zur Gruppe hinzugefügt MyGroup.
Befehl:
aws cognito-idp admin-add-user-to-group --user-pool-id
us-west-2_aaaaaaaaa
--usernameJane
--group-nameMyGroup
-
APIEinzelheiten finden Sie AdminAddUserToGroup
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-confirm-sign-up
.
- AWS CLI
-
Um die Benutzerregistrierung zu bestätigen
In diesem Beispiel wird der Benutzer jane@example.com bestätigt.
Befehl:
aws cognito-idp admin-confirm-sign-up --user-pool-id
us-west-2_aaaaaaaaa
--usernamejane@example.com
-
APIEinzelheiten finden Sie AdminConfirmSignUp
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-create-user
.
- AWS CLI
-
Um einen Benutzer zu erstellen
Im folgenden
admin-create-user
Beispiel wird ein Benutzer mit den angegebenen Einstellungen E-Mail-Adresse und Telefonnummer erstellt.aws cognito-idp admin-create-user \ --user-pool-id
us-west-2_aaaaaaaaa
\ --usernamediego
\ --user-attributesName=email,Value=diego@example.com
Name=phone_number,Value="+15555551212" \ --message-actionSUPPRESS
Ausgabe:
{ "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" } }
-
APIEinzelheiten finden Sie AdminCreateUser
unter AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-delete-user-attributes
.
- AWS CLI
-
Um ein Benutzerattribut zu löschen
In diesem Beispiel wird das benutzerdefinierte Attribut CustomAttr 1 für den Benutzer diego@example.com gelöscht.
Befehl:
aws cognito-idp admin-delete-user-attributes --user-pool-id
us-west-2_aaaaaaaaa
--usernamediego@example.com
--user-attribute-names"custom:CustomAttr1"
-
APIEinzelheiten finden Sie AdminDeleteUserAttributes
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-delete-user
.
- AWS CLI
-
Benutzer löschen
In diesem Beispiel wird ein Benutzer gelöscht.
Befehl:
aws cognito-idp admin-delete-user --user-pool-id
us-west-2_aaaaaaaaa
--usernamediego@example.com
-
APIEinzelheiten finden Sie AdminDeleteUser
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-forget-device
.
- AWS CLI
-
Um ein Gerät zu vergessen
In diesem Beispiel wird das Gerät für den Benutzernamen jane@example.com vergessen
Befehl:
aws cognito-idp admin-forget-device --user-pool-id
us-west-2_aaaaaaaaa
--usernamejane@example.com
--device-keyus-west-2_abcd_1234-5678
-
APIEinzelheiten finden Sie AdminForgetDevice
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-get-device
.
- AWS CLI
-
Um ein Gerät zu bekommen
In diesem Beispiel wird ein Gerät mit dem Benutzernamen jane@example.com abgerufen
Befehl:
aws cognito-idp admin-get-device --user-pool-id
us-west-2_aaaaaaaaa
--usernamejane@example.com
--device-keyus-west-2_abcd_1234-5678
-
APIEinzelheiten finden Sie AdminGetDevice
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-get-user
.
- AWS CLI
-
Benutzer abrufen
In diesem Beispiel werden Informationen zum Benutzernamen jane@example.com abgerufen.
Befehl:
aws cognito-idp admin-get-user --user-pool-id
us-west-2_aaaaaaaaa
--usernamejane@example.com
Ausgabe:
{ "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 }
-
APIEinzelheiten finden Sie AdminGetUser
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-initiate-auth
.
- AWS CLI
-
Authentifizierung initiieren
In diesem Beispiel wird die Autorisierung mithilfe des AUTH Flows ADMIN _NO_ SRP _ für den Benutzernamen jane@example.com initiiert
Auf dem Client muss die Anmeldung API für die serverbasierte Authentifizierung (ADMIN_NO_ _) aktiviert sein. SRP AUTH
Verwenden Sie die Sitzungsinformationen im Rückgabewert, um -challenge aufzurufen. admin-respond-to-auth
Befehl:
aws cognito-idp admin-initiate-auth --user-pool-id
us-west-2_aaaaaaaaa
--client-id3n4b5urk1ft4fl3mg5e62d9ado
--auth-flowADMIN_NO_SRP_AUTH
--auth-parametersUSERNAME=jane@example.com,PASSWORD=password
Ausgabe:
{ "ChallengeName": "NEW_PASSWORD_REQUIRED", "Session": "SESSION", "ChallengeParameters": { "USER_ID_FOR_SRP": "84514837-dcbc-4af1-abff-f3c109334894", "requiredAttributes": "[]", "userAttributes": "{\"email_verified\":\"true\",\"phone_number_verified\":\"true\",\"phone_number\":\"+01xxx5550100\",\"email\":\"jane@example.com\"}" } }
-
APIEinzelheiten finden Sie AdminInitiateAuth
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-list-devices
.
- AWS CLI
-
Um Geräte für einen Benutzer aufzulisten
In diesem Beispiel werden Geräte für den Benutzernamen jane@example.com aufgelistet.
Befehl:
aws cognito-idp admin-list-devices --user-pool-id
us-west-2_aaaaaaaaa
--usernamejane@example.com
-
APIEinzelheiten finden Sie AdminListDevices
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-list-groups-for-user
.
- AWS CLI
-
Um Gruppen für einen Benutzer aufzulisten
In diesem Beispiel werden Gruppen für den Benutzernamen jane@example.com aufgeführt.
Befehl:
aws cognito-idp admin-list-groups-for-user --user-pool-id
us-west-2_aaaaaaaaa
--usernamediego@example.com
Ausgabe:
{ "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 } ] }
-
APIEinzelheiten finden Sie AdminListGroupsForUser
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-list-user-auth-events
.
- AWS CLI
-
Um Autorisierungsereignisse für einen Benutzer aufzulisten
In diesem Beispiel werden Autorisierungsereignisse für den Benutzernamen diego@example.com aufgeführt.
Befehl:
aws cognito-idp admin-list-user-auth-events --user-pool-id
us-west-2_aaaaaaaaa
--usernamediego@example.com
-
APIEinzelheiten finden Sie AdminListUserAuthEvents
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-remove-user-from-group
.
- AWS CLI
-
Um einen Benutzer aus einer Gruppe zu entfernen
In diesem Beispiel wird jane@example.com von entfernt SampleGroup.
Befehl:
aws cognito-idp admin-remove-user-from-group --user-pool-id
us-west-2_aaaaaaaaa
--usernamejane@example.com
--group-nameSampleGroup
-
APIEinzelheiten finden Sie AdminRemoveUserFromGroup
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-reset-user-password
.
- AWS CLI
-
Um ein Benutzerkennwort zurückzusetzen
In diesem Beispiel wird das Passwort für diego@example.com zurückgesetzt.
Befehl:
aws cognito-idp admin-reset-user-password --user-pool-id
us-west-2_aaaaaaaaa
--usernamediego@example.com
-
APIEinzelheiten finden Sie AdminResetUserPassword
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-set-user-mfa-preference
.
- AWS CLI
-
Um die MFA Benutzerpräferenz festzulegen
In diesem Beispiel wird die SMS MFA Präferenz für den Benutzernamen diego@example.com festgelegt.
Befehl:
aws cognito-idp admin-set-user-mfa-preference --user-pool-id
us-west-2_aaaaaaaaa
--usernamediego@example.com
--sms-mfa-settingsEnabled=false,PreferredMfa=false
-
APIEinzelheiten finden Sie AdminSetUserMfaPreference
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-set-user-settings
.
- AWS CLI
-
Um Benutzereinstellungen festzulegen
In diesem Beispiel wird die MFA Versandpräferenz für den Benutzernamen diego@example.com auf festgelegtEMAIL.
Befehl:
aws cognito-idp admin-set-user-settings --user-pool-id
us-west-2_aaaaaaaaa
--usernamediego@example.com
--mfa-optionsDeliveryMedium=EMAIL
-
APIEinzelheiten finden Sie AdminSetUserSettings
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-update-auth-event-feedback
.
- AWS CLI
-
Um Feedback zu einem Autorisierungsereignis zu geben
In diesem Beispiel wird der Feedback-Wert für ein durch event-id identifiziertes Autorisierungsereignis auf Valid gesetzt.
Befehl:
aws cognito-idp admin-update-auth-event-feedback --user-pool-id
us-west-2_aaaaaaaaa
--usernamediego@example.com
--event-idc2c2cf89-c0d3-482d-aba6-99d78a5b0bfe
--feedback-valueValid
-
APIEinzelheiten finden Sie unter AdminUpdateAuthEventFeedback AWS CLI
Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungadmin-update-device-status
.
- AWS CLI
-
Um den Gerätestatus zu aktualisieren
In diesem Beispiel wird der Status „Gerät gespeichert“ für das mit dem Geräteschlüssel identifizierte Gerät auf „not_remembered“ gesetzt.
Befehl:
aws cognito-idp admin-update-device-status --user-pool-id
us-west-2_aaaaaaaaa
--usernamediego@example.com
--device-keyxxxx
--device-remembered-statusnot_remembered
-
APIEinzelheiten finden Sie unter AdminUpdateDeviceStatus
Befehlsreferenz.AWS CLI
-
Das folgende Codebeispiel zeigt die Verwendungadmin-update-user-attributes
.
- AWS CLI
-
Um Benutzerattribute zu aktualisieren
In diesem Beispiel wird ein benutzerdefiniertes Benutzerattribut CustomAttr 1 für den Benutzer diego@example.com aktualisiert.
Befehl:
aws cognito-idp admin-update-user-attributes --user-pool-id
us-west-2_aaaaaaaaa
--usernamediego@example.com
--user-attributes Name="custom:CustomAttr1",Value="Purple"-
APIEinzelheiten finden Sie AdminUpdateUserAttributes
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungchange-password
.
- AWS CLI
-
Um ein Passwort zu ändern
In diesem Beispiel wird ein Passwort geändert.
Befehl:
aws cognito-idp change-password --previous-password
OldPassword
--proposed-passwordNewPassword
--access-tokenACCESS_TOKEN
-
APIEinzelheiten finden Sie ChangePassword
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungconfirm-forgot-password
.
- AWS CLI
-
Um ein vergessenes Passwort zu bestätigen
Dieses Beispiel bestätigt ein vergessenes Passwort für den Benutzernamen diego@example.com.
Befehl:
aws cognito-idp confirm-forgot-password --client-id
3n4b5urk1ft4fl3mg5e62d9ado
--username=diego@example.com --passwordPASSWORD
--confirmation-codeCONF_CODE
-
APIEinzelheiten finden Sie ConfirmForgotPassword
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungconfirm-sign-up
.
- AWS CLI
-
Registrierung bestätigen
In diesem Beispiel wird die Registrierung des Benutzernamens diego@example.com bestätigt.
Befehl:
aws cognito-idp confirm-sign-up --client-id
3n4b5urk1ft4fl3mg5e62d9ado
--username=diego@example.com --confirmation-codeCONF_CODE
-
APIEinzelheiten finden Sie ConfirmSignUp
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungcreate-group
.
- AWS CLI
-
Um eine Gruppe zu erstellen
In diesem Beispiel wird eine Gruppe mit einer Beschreibung erstellt.
Befehl:
aws cognito-idp create-group --user-pool-id
us-west-2_aaaaaaaaa
--group-nameMyNewGroup
--description"New group."
Ausgabe:
{ "Group": { "GroupName": "MyNewGroup", "UserPoolId": "us-west-2_aaaaaaaaa", "Description": "New group.", "LastModifiedDate": 1548270073.795, "CreationDate": 1548270073.795 } }
Um eine Gruppe mit einer Rolle und Priorität zu erstellen
In diesem Beispiel wird eine Gruppe mit einer Beschreibung erstellt. Es beinhaltet auch eine Rolle und eine Rangfolge.
Befehl:
aws cognito-idp create-group --user-pool-id
us-west-2_aaaaaaaaa
--group-nameMyNewGroupWithRole
--description"New group with a role."
--role-arnarn:aws:iam::111111111111:role/MyNewGroupRole
--precedence2
Ausgabe:
{ "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 } }
-
APIEinzelheiten finden Sie CreateGroup
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungcreate-user-import-job
.
- AWS CLI
-
Um einen Benutzerimportauftrag zu erstellen
In diesem Beispiel wird ein Benutzerimportauftrag mit dem Namen erstellt MyImportJob.
Weitere Informationen zum Importieren von Benutzern finden Sie unter Benutzer aus einer CSV Datei in Benutzerpools importieren.
Befehl:
aws cognito-idp create-user-import-job --user-pool-id
us-west-2_aaaaaaaaa
--job-nameMyImportJob
--cloud-watch-logs-role-arnarn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole
Ausgabe:
{ "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 } }
Laden Sie die CSV-Datei mit curl hoch und verwenden Sie dabei das vorsignierte: URL
Befehl:
curl -v -T "PATH_TO_CSV_FILE" -H "x-amz-server-side-encryption:aws:kms" "PRE_SIGNED_URL"
-
APIEinzelheiten finden Sie CreateUserImportJob
in AWS CLI der Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungcreate-user-pool-client
.
- AWS CLI
-
Um einen Benutzerpool-Client zu erstellen
In diesem Beispiel wird ein neuer Benutzerpool-Client mit zwei expliziten Autorisierungsabläufen erstellt: USER _ PASSWORD _ AUTH und ADMIN _NO_ _SRP. AUTH
Befehl:
aws cognito-idp create-user-pool-client --user-pool-id
us-west-2_aaaaaaaaa
--client-nameMyNewClient
--no-generate-secret --explicit-auth-flows"USER_PASSWORD_AUTH"
"ADMIN_NO_SRP_AUTH"
Ausgabe:
{ "UserPoolClient": { "UserPoolId": "us-west-2_aaaaaaaaa", "ClientName": "MyNewClient", "ClientId": "6p3bs000no6a4ue1idruvd05ad", "LastModifiedDate": 1548697449.497, "CreationDate": 1548697449.497, "RefreshTokenValidity": 30, "ExplicitAuthFlows": [ "USER_PASSWORD_AUTH", "ADMIN_NO_SRP_AUTH" ], "AllowedOAuthFlowsUserPoolClient": false } }
-
APIEinzelheiten finden Sie CreateUserPoolClient
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungcreate-user-pool-domain
.
- AWS CLI
-
Um eine Benutzerpool-Domäne zu erstellen
In diesem Beispiel wird eine neue Benutzerpool-Domäne mit zwei expliziten Autorisierungsabläufen erstellt: USER _ PASSWORD _ AUTH und ADMIN SRP _NO_ _. AUTH
Befehl:
aws cognito-idp create-user-pool-domain --user-pool-id
us-west-2_aaaaaaaaa
--domainmy-new-domain
-
APIEinzelheiten finden Sie CreateUserPoolDomain
in AWS CLI der Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungcreate-user-pool
.
- AWS CLI
-
So erstellen Sie einen minimal konfigurierten Benutzerpool
In diesem Beispiel wird ein Benutzerpool erstellt, der MyUserPool mit Standardwerten benannt wird. Es gibt keine erforderlichen Attribute und keine Anwendungs-Clients. MFAund erweiterte Sicherheit ist deaktiviert.
Befehl:
aws cognito-idp create-user-pool --pool-name
MyUserPool
Ausgabe:
{ "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": {} } }
So erstellen Sie einen Benutzerpool mit zwei erforderlichen Attributen
In diesem Beispiel wird ein Benutzerpool erstellt MyUserPool. Der Pool ist so konfiguriert, dass er E-Mail-Adressen als Benutzernamensattribut akzeptiert. Außerdem wird die E-Mail-Quelladresse mit Amazon Simple Email Service auf eine validierte Adresse gesetzt.
Befehl:
aws cognito-idp create-user-pool --pool-name
MyUserPool
--username-attributes"email"
--email-configuration=SourceArn="arn:aws:ses:us-east-1:111111111111:identity/jane@example.com",ReplyToEmailAddress="jane@example.com"Ausgabe:
{ "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": {} } }
-
APIEinzelheiten finden Sie CreateUserPool
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdelete-group
.
- AWS CLI
-
Um eine Gruppe zu löschen
In diesem Beispiel wird eine Gruppe gelöscht.
Befehl:
aws cognito-idp delete-group --user-pool-id
us-west-2_aaaaaaaaa
--group-nameMyGroupName
-
APIEinzelheiten finden Sie DeleteGroup
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdelete-identity-provider
.
- AWS CLI
-
Um einen Identitätsanbieter zu löschen
In diesem Beispiel wird ein Identitätsanbieter gelöscht.
Befehl:
aws cognito-idp delete-identity-provider --user-pool-id
us-west-2_aaaaaaaaa
--provider-nameFacebook
-
APIEinzelheiten finden Sie unter DeleteIdentityProvider AWS CLI
Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdelete-resource-server
.
- AWS CLI
-
Um einen Ressourcenserver zu löschen
In diesem Beispiel wird ein Ressourcenserver mit dem Namen weather.example.com gelöscht.
Befehl:
aws cognito-idp delete-resource-server --user-pool-id
us-west-2_aaaaaaaaa
--identifierweather.example.com
-
APIEinzelheiten finden Sie unter DeleteResourceServer
Befehlsreferenz.AWS CLI
-
Das folgende Codebeispiel zeigt die Verwendungdelete-user-attributes
.
- AWS CLI
-
Um Benutzerattribute zu löschen
In diesem Beispiel wird das Benutzerattribut "FAVORITE_ANIMAL“ gelöscht.
Befehl:
aws cognito-idp delete-user-attributes --access-token
ACCESS_TOKEN
--user-attribute-names"FAVORITE_ANIMAL"
-
APIEinzelheiten finden Sie DeleteUserAttributes
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdelete-user-pool-client
.
- AWS CLI
-
Um einen Benutzerpool-Client zu löschen
In diesem Beispiel wird ein Benutzerpool-Client gelöscht.
Befehl:
aws cognito-idp delete-user-pool-client --user-pool-id
us-west-2_aaaaaaaaa
--client-id38fjsnc484p94kpqsnet7mpld0
-
APIEinzelheiten finden Sie DeleteUserPoolClient
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdelete-user-pool-domain
.
- AWS CLI
-
Um eine Benutzerpool-Domäne zu löschen
Im folgenden
delete-user-pool-domain
Beispiel wird eine Benutzerpool-Domäne mit dem Namen gelöschtmy-domain
aws cognito-idp delete-user-pool-domain \ --user-pool-id
us-west-2_aaaaaaaaa
\ --domainmy-domain
-
APIEinzelheiten finden Sie unter DeleteUserPoolDomain AWS CLI
Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdelete-user-pool
.
- AWS CLI
-
Um einen Benutzerpool zu löschen
In diesem Beispiel wird ein Benutzerpool mit der Benutzerpool-ID us-west-2_aaaaaaaaa gelöscht.
Befehl:
aws cognito-idp delete-user-pool --user-pool-id
us-west-2_aaaaaaaaa
-
Einzelheiten API finden Sie in der Befehlsreferenz. DeleteUserPool
AWS CLI
-
Das folgende Codebeispiel zeigt die Verwendungdelete-user
.
- AWS CLI
-
Benutzer löschen
In diesem Beispiel wird ein Benutzer gelöscht.
Befehl:
aws cognito-idp delete-user --access-token
ACCESS_TOKEN
-
APIEinzelheiten finden Sie DeleteUser
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdescribe-identity-provider
.
- AWS CLI
-
Um einen Identitätsanbieter zu beschreiben
Dieses Beispiel beschreibt einen Identitätsanbieter namens Facebook.
Befehl:
aws cognito-idp describe-identity-provider --user-pool-id
us-west-2_aaaaaaaaa
--provider-nameFacebook
Ausgabe:
{ "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 } }
-
APIEinzelheiten finden Sie DescribeIdentityProvider
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdescribe-resource-server
.
- AWS CLI
-
Um einen Ressourcenserver zu beschreiben
Dieses Beispiel beschreibt den Ressourcenserver weather.example.com.
Befehl:
aws cognito-idp describe-resource-server --user-pool-id
us-west-2_aaaaaaaaa
--identifierweather.example.com
Ausgabe:
{ "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" } ] } }
-
APIEinzelheiten finden Sie DescribeResourceServer
in AWS CLI der Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdescribe-risk-configuration
.
- AWS CLI
-
Um eine Risikokonfiguration zu beschreiben
Dieses Beispiel beschreibt die Risikokonfiguration im Zusammenhang mit Pool us-west-2_aaaaaaaaa.
Befehl:
aws cognito-idp describe-risk-configuration --user-pool-id
us-west-2_aaaaaaaaa
Ausgabe:
{ "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" } } } } }
-
APIEinzelheiten finden Sie in der Befehlsreferenz. DescribeRiskConfiguration
AWS CLI
-
Das folgende Codebeispiel zeigt die Verwendungdescribe-user-import-job
.
- AWS CLI
-
Um einen Benutzerimportjob zu beschreiben
Dieses Beispiel beschreibt einen Benutzereingabejob.
Weitere Informationen zum Importieren von Benutzern finden Sie unter Benutzer aus einer CSV Datei in Benutzerpools importieren.
Befehl:
aws cognito-idp describe-user-import-job --user-pool-id
us-west-2_aaaaaaaaa
--job-idimport-TZqNQvDRnW
Ausgabe:
{ "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 } }
-
APIEinzelheiten finden Sie DescribeUserImportJob
unter AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdescribe-user-pool-client
.
- AWS CLI
-
Um einen Benutzerpool-Client zu beschreiben
Dieses Beispiel beschreibt einen Benutzerpool-Client.
Befehl:
aws cognito-idp describe-user-pool-client --user-pool-id
us-west-2_aaaaaaaaa
--client-id38fjsnc484p94kpqsnet7mpld0
Ausgabe:
{ "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 } }
-
APIEinzelheiten finden Sie DescribeUserPoolClient
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdescribe-user-pool-domain
.
- AWS CLI
-
Um einen Benutzerpool-Client zu beschreiben
Dieses Beispiel beschreibt eine Benutzerpool-Domain mit dem Namen my-domain.
Befehl:
aws cognito-idp describe-user-pool-domain --domain
my-domain
Ausgabe:
{ "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": {} } }
-
APIEinzelheiten finden Sie DescribeUserPoolDomain
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungdescribe-user-pool
.
- AWS CLI
-
Um einen Benutzerpool zu beschreiben
Dieses Beispiel beschreibt einen Benutzerpool mit der Benutzerpool-ID us-west-2_aaaaaaaaa.
Befehl:
aws cognito-idp describe-user-pool --user-pool-id
us-west-2_aaaaaaaaa
Ausgabe:
{ "UserPool": { "SmsVerificationMessage": "Your verification code is {####}. ", "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": true, "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 } ], "EmailVerificationSubject": "Your verification code", "MfaConfiguration": "OFF", "Name": "MyUserPool", "EmailVerificationMessage": "Your verification code is {####}. ", "SmsAuthenticationMessage": "Your authentication code is {####}. ", "LastModifiedDate": 1547763720.822, "AdminCreateUserConfig": { "InviteMessageTemplate": { "EmailMessage": "Your username is {username} and temporary password is {####}. ", "EmailSubject": "Your temporary password", "SMSMessage": "Your username is {username} and temporary password is {####}. " }, "UnusedAccountValidityDays": 7, "AllowAdminCreateUserOnly": false }, "EmailConfiguration": { "ReplyToEmailAddress": "myemail@mydomain.com" "SourceArn": "arn:aws:ses:us-east-1:000000000000:identity/myemail@mydomain.com" }, "AutoVerifiedAttributes": [ "email" ], "Policies": { "PasswordPolicy": { "RequireLowercase": true, "RequireSymbols": true, "RequireNumbers": true, "MinimumLength": 8, "RequireUppercase": true } }, "UserPoolTags": {}, "UsernameAttributes": [ "email" ], "CreationDate": 1547763720.822, "EstimatedNumberOfUsers": 1, "Id": "us-west-2_aaaaaaaaa", "LambdaConfig": {} } }
-
APIEinzelheiten finden Sie in der Befehlsreferenz. DescribeUserPool
AWS CLI
-
Das folgende Codebeispiel zeigt die Verwendungforget-device
.
- AWS CLI
-
Um ein Gerät zu vergessen
In diesem Beispiel wird Gerät für Gerät vergessen.
Befehl:
aws cognito-idp forget-device --device-key
us-west-2_abcd_1234-5678
-
APIEinzelheiten finden Sie ForgetDevice
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungforgot-password
.
- AWS CLI
-
Um eine Passwortänderung zu erzwingen
Im folgenden
forgot-password
Beispiel wird eine Nachricht an jane@example.com gesendet, um ihr Passwort zu ändern.aws cognito-idp forgot-password --client-id
38fjsnc484p94kpqsnet7mpld0
--usernamejane@example.com
Ausgabe:
{ "CodeDeliveryDetails": { "Destination": "j***@e***.com", "DeliveryMedium": "EMAIL", "AttributeName": "email" } }
-
APIEinzelheiten finden Sie ForgotPassword
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungget-csv-header
.
- AWS CLI
-
Um einen CSV-Header zu erstellen
In diesem Beispiel wird ein CSV-Header erstellt.
Weitere Informationen zum Importieren von Benutzern finden Sie unter Benutzer aus einer CSV Datei in Benutzerpools importieren.
Befehl:
aws cognito-idp get-csv-header --user-pool-id
us-west-2_aaaaaaaaa
Ausgabe:
{ "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" ] }
... Benutzer aus einer CSV Datei in Benutzerpools importieren: https://docs.aws.amazon.com/cognito/ latest/developerguide/cognito - user-pools-using-import -tool.html
-
APIEinzelheiten finden Sie GetCsvHeader
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungget-group
.
- AWS CLI
-
Um Informationen über eine Gruppe zu erhalten
In diesem Beispiel werden Informationen über eine Gruppe mit dem Namen abgerufen MyGroup.
Befehl:
aws cognito-idp get-group --user-pool-id
us-west-2_aaaaaaaaa
--group-nameMyGroup
Ausgabe:
{ "Group": { "GroupName": "MyGroup", "UserPoolId": "us-west-2_aaaaaaaaa", "Description": "A sample group.", "LastModifiedDate": 1548270073.795, "CreationDate": 1548270073.795 } }
-
APIEinzelheiten finden Sie GetGroup
unter AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungget-signing-certificate
.
- AWS CLI
-
Um ein Signaturzertifikat zu erhalten
In diesem Beispiel wird ein Signaturzertifikat für einen Benutzerpool abgerufen.
Befehl:
aws cognito-idp get-signing-certificate --user-pool-id
us-west-2_aaaaaaaaa
Ausgabe:
{ "Certificate": "CERTIFICATE_DATA" }
-
APIEinzelheiten finden Sie GetSigningCertificate
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungget-ui-customization
.
- AWS CLI
-
Um Informationen zur Anpassung der Benutzeroberfläche zu erhalten
In diesem Beispiel werden Informationen zur Anpassung der Benutzeroberfläche für einen Benutzerpool abgerufen.
Befehl:
aws cognito-idp get-ui-customization --user-pool-id
us-west-2_aaaaaaaaa
Ausgabe:
{ "UICustomization": { "UserPoolId": "us-west-2_aaaaaaaaa", "ClientId": "ALL", "ImageUrl": "https://aaaaaaaaaaaaa.cloudfront.net/us-west-2_aaaaaaaaa/ALL/20190128231240/assets/images/image.jpg", "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\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: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\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}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\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\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\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: #faf;\n}\n", "CSSVersion": "20190128231240" } }
-
APIEinzelheiten finden Sie GetUiCustomization
unter AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendunglist-user-import-jobs
.
- AWS CLI
-
Um Benutzerimportaufträge aufzulisten
In diesem Beispiel werden Benutzerimportaufträge aufgeführt.
Weitere Informationen zum Importieren von Benutzern finden Sie unter Benutzer aus einer CSV Datei in Benutzerpools importieren.
Befehl:
aws cognito-idp list-user-import-jobs --user-pool-id
us-west-2_aaaaaaaaa
--max-results20
Ausgabe:
{ "UserImportJobs": [ { "JobName": "Test2", "JobId": "import-d0OnwGA3mV", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED_URL", "CreationDate": 1548272793.069, "Status": "Created", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 0 }, { "JobName": "Test1", "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 }, { "JobName": "import-Test1", "JobId": "import-TZqNQvDRnW", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED_URL", "CreationDate": 1548271708.512, "StartDate": 1548277247.962, "CompletionDate": 1548277248.912, "Status": "Failed", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 1, "CompletionMessage": "Too many users have failed or been skipped during the import." } ] }
-
APIEinzelheiten finden Sie ListUserImportJobs
unter AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendunglist-user-pools
.
- AWS CLI
-
Benutzerpools auflisten
In diesem Beispiel werden bis zu 20 Benutzerpools aufgelistet.
Befehl:
aws cognito-idp list-user-pools --max-results
20
Ausgabe:
{ "UserPools": [ { "CreationDate": 1547763720.822, "LastModifiedDate": 1547763720.822, "LambdaConfig": {}, "Id": "us-west-2_aaaaaaaaa", "Name": "MyUserPool" } ] }
-
APIEinzelheiten finden Sie ListUserPools
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendunglist-users-in-group
.
- AWS CLI
-
Um Benutzer in einer Gruppe aufzulisten
In diesem Beispiel werden Benutzer in einer Gruppe aufgeführt MyGroup.
Befehl:
aws cognito-idp list-users-in-group --user-pool-id
us-west-2_aaaaaaaaa
--group-nameMyGroup
Ausgabe:
{ "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" } ] }
-
APIEinzelheiten finden Sie ListUsersInGroup
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendunglist-users
.
- AWS CLI
-
Benutzer auflisten
In diesem Beispiel werden bis zu 20 Benutzer aufgelistet.
Befehl:
aws cognito-idp list-users --user-pool-id
us-west-2_aaaaaaaaa
--limit20
Ausgabe:
{ "Users": [ { "Username": "22704aa3-fc10-479a-97eb-2af5806bd327", "Enabled": true, "UserStatus": "FORCE_CHANGE_PASSWORD", "UserCreateDate": 1548089817.683, "UserLastModifiedDate": 1548089817.683, "Attributes": [ { "Name": "sub", "Value": "22704aa3-fc10-479a-97eb-2af5806bd327" }, { "Name": "email_verified", "Value": "true" }, { "Name": "email", "Value": "mary@example.com" } ] } ] }
-
APIEinzelheiten finden Sie ListUsers
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungresend-confirmation-code
.
- AWS CLI
-
Bestätigungscode erneut senden
Im folgenden
resend-confirmation-code
-Beispiel wird ein Bestätigungscode an den Benutzerjane
gesendet.aws cognito-idp resend-confirmation-code \ --client-id
12a3b456c7de890f11g123hijk
\ --usernamejane
Ausgabe:
{ "CodeDeliveryDetails": { "Destination": "j***@e***.com", "DeliveryMedium": "EMAIL", "AttributeName": "email" } }
Weitere Informationen finden Sie unter Registrieren und Bestätigen von Benutzerkonten im Amazon-Cognito-Entwicklerhandbuch.
-
APIEinzelheiten finden Sie ResendConfirmationCode
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungrespond-to-auth-challenge
.
- AWS CLI
-
Reaktion auf eine Amazon Cognito SRP-Authentifizierungs-Challenge
Dieses Beispiel veranschaulicht die Reaktion auf eine Authentifizierungs-Challenge, die mit „initiate-auth“ initiiert wurde. Es ist eine Antwort auf die NEW _ PASSWORD _ REQUIRED -Herausforderung. Es wird ein Passwort für den Benutzer jane@example.com festgelegt.
Befehl:
aws cognito-idp respond-to-auth-challenge --client-id
3n4b5urk1ft4fl3mg5e62d9ado
--challenge-nameNEW_PASSWORD_REQUIRED
--challenge-responses USERNAME=jane@example.com,NEW_PASSWORD="password" --session"SESSION_TOKEN"
Ausgabe:
{ "ChallengeParameters": {}, "AuthenticationResult": { "AccessToken": "ACCESS_TOKEN", "ExpiresIn": 3600, "TokenType": "Bearer", "RefreshToken": "REFRESH_TOKEN", "IdToken": "ID_TOKEN", "NewDeviceMetadata": { "DeviceKey": "us-west-2_fec070d2-fa88-424a-8ec8-b26d7198eb23", "DeviceGroupKey": "-wt2ha1Zd" } } }
-
APIEinzelheiten finden Sie RespondToAuthChallenge
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungset-risk-configuration
.
- AWS CLI
-
Um die Risikokonfiguration festzulegen
In diesem Beispiel wird die Risikokonfiguration für einen Benutzerpool festgelegt. Es legt die Aktion für das Anmeldeereignis auf ACTION NO_ fest.
Befehl:
aws cognito-idp set-risk-configuration --user-pool-id
us-west-2_aaaaaaaaa
--compromised-credentials-risk-configurationEventFilter=SIGN_UP,Actions={EventAction=NO_ACTION}
Ausgabe:
{ "RiskConfiguration": { "UserPoolId": "us-west-2_aaaaaaaaa", "CompromisedCredentialsRiskConfiguration": { "EventFilter": [ "SIGN_UP" ], "Actions": { "EventAction": "NO_ACTION" } } } }
-
APIEinzelheiten finden Sie SetRiskConfiguration
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungset-ui-customization
.
- AWS CLI
-
Um die Anpassung der Benutzeroberfläche festzulegen
In diesem Beispiel wird die CSS Einstellung für einen Benutzerpool angepasst.
Befehl:
aws cognito-idp set-ui-customization --user-pool-id
us-west-2_aaaaaaaaa
--css".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\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: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\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}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\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\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\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: #faf;\n}\n"
Ausgabe:
{ "UICustomization": { "UserPoolId": "us-west-2_aaaaaaaaa", "ClientId": "ALL", "CSS": ".logo-customizable {\n\tmax-width: 60%;\n\tmax-height: 30%;\n}\n.banner-customizable {\n\tpadding: 25px 0px 25px 10px;\n\tbackground-color: lightgray;\n}\n.label-customizable {\n\tfont-weight: 300;\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: 14px;\n\tfont-weight: bold;\n\tmargin: 20px 0px 10px 0px;\n\theight: 40px;\n\twidth: 100%;\n\tcolor: #fff;\n\tbackground-color: #337ab7;\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}\n.inputField-customizable:focus {\n\tborder-color: #66afe9;\n\toutline: 0;\n}\n.idpButton-customizable {\n\theight: 40px;\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\theight: 40px;\n\ttext-align: left;\n\twidth: 100%;\n\tmargin-bottom: 15px;\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: #faf;\n}\n", "CSSVersion": "20190129172214" } }
-
APIEinzelheiten finden Sie unter SetUiCustomization AWS CLI
Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungset-user-mfa-preference
.
- AWS CLI
-
Um MFA Benutzereinstellungen festzulegen
Im folgenden
set-user-mfa-preference
Beispiel werden die MFA Lieferoptionen geändert. Es ändert das MFA Liefermedium aufSMS.aws cognito-idp set-user-mfa-preference \ --access-token
"eyJra12345EXAMPLE"
\ --software-token-mfa-settingsEnabled=true,PreferredMfa=true
\ --sms-mfa-settingsEnabled=false,PreferredMfa=false
Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Hinzufügen MFA zu einem Benutzerpool im Amazon Cognito Developer Guide.
-
APIEinzelheiten finden Sie unter SetUserMfaPreference AWS CLI
Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungset-user-settings
.
- AWS CLI
-
Um Benutzereinstellungen festzulegen
In diesem Beispiel wird die MFA Versandpräferenz auf festgelegtEMAIL.
Befehl:
aws cognito-idp set-user-settings --access-token
ACCESS_TOKEN
--mfa-optionsDeliveryMedium=EMAIL
-
APIEinzelheiten finden Sie SetUserSettings
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungsign-up
.
- AWS CLI
-
Benutzer registrieren
In diesem Beispiel wird jane@example.com registriert.
Befehl:
aws cognito-idp sign-up --client-id
3n4b5urk1ft4fl3mg5e62d9ado
--usernamejane@example.com
--passwordPASSWORD
--user-attributes Name="email",Value="jane@example.com" Name="name",Value="Jane"Ausgabe:
{ "UserConfirmed": false, "UserSub": "e04d60a6-45dc-441c-a40b-e25a787d4862" }
-
APIEinzelheiten finden Sie SignUp
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungstart-user-import-job
.
- AWS CLI
-
Um einen Benutzerimportjob zu starten
In diesem Beispiel wird ein Benutzereingabejob gestartet.
Weitere Informationen zum Importieren von Benutzern finden Sie unter Benutzer aus einer CSV Datei in Benutzerpools importieren.
Befehl:
aws cognito-idp start-user-import-job --user-pool-id
us-west-2_aaaaaaaaa
--job-idimport-TZqNQvDRnW
Ausgabe:
{ "UserImportJob": { "JobName": "import-Test10", "JobId": "import-lmpxSOuIzH", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED_URL", "CreationDate": 1548278378.928, "StartDate": 1548278397.334, "Status": "Pending", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 0 } }
-
APIEinzelheiten finden Sie StartUserImportJob
unter AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungstop-user-import-job
.
- AWS CLI
-
Um einen Benutzerimportjob zu beenden
In diesem Beispiel wird ein Benutzereingabeauftrag beendet.
Weitere Informationen zum Importieren von Benutzern finden Sie unter Benutzer aus einer CSV Datei in Benutzerpools importieren.
Befehl:
aws cognito-idp stop-user-import-job --user-pool-id
us-west-2_aaaaaaaaa
--job-idimport-TZqNQvDRnW
Ausgabe:
{ "UserImportJob": { "JobName": "import-Test5", "JobId": "import-Fx0kARISFL", "UserPoolId": "us-west-2_aaaaaaaaa", "PreSignedUrl": "PRE_SIGNED_URL", "CreationDate": 1548278576.259, "StartDate": 1548278623.366, "CompletionDate": 1548278626.741, "Status": "Stopped", "CloudWatchLogsRoleArn": "arn:aws:iam::111111111111:role/CognitoCloudWatchLogsRole", "ImportedUsers": 0, "SkippedUsers": 0, "FailedUsers": 0, "CompletionMessage": "The Import Job was stopped by the developer." } }
-
APIEinzelheiten finden Sie StopUserImportJob
unter AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungupdate-auth-event-feedback
.
- AWS CLI
-
Um das Feedback zu Authentifizierungsereignissen zu aktualisieren
In diesem Beispiel wird das Feedback zu Autorisierungsereignissen aktualisiert. Es markiert das Ereignis als „Gültig“.
Befehl:
aws cognito-idp update-auth-event-feedback --user-pool-id
us-west-2_aaaaaaaaa
--usernamediego@example.com
--event-idEVENT_ID
--feedback-tokenFEEDBACK_TOKEN
--feedback-value"Valid"
-
APIEinzelheiten finden Sie UpdateAuthEventFeedback
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungupdate-device-status
.
- AWS CLI
-
Um den Gerätestatus zu aktualisieren
In diesem Beispiel wird der Status eines Geräts auf „not_remembered“ aktualisiert.
Befehl:
aws cognito-idp update-device-status --access-token
ACCESS_TOKEN
--device-keyDEVICE_KEY
--device-remembered-status"not_remembered"
-
APIEinzelheiten finden Sie UpdateDeviceStatus
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungupdate-group
.
- AWS CLI
-
Um eine Gruppe zu aktualisieren
In diesem Beispiel werden die Beschreibung und der Vorrang für MyGroup aktualisiert.
Befehl:
aws cognito-idp update-group --user-pool-id
us-west-2_aaaaaaaaa
--group-nameMyGroup
--description"New description"
--precedence2
Ausgabe:
{ "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 } }
-
APIEinzelheiten finden Sie UpdateGroup
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungupdate-resource-server
.
- AWS CLI
-
Um einen Ressourcenserver zu aktualisieren
In diesem Beispiel wird der Ressourcenserver Wetter aktualisiert. Es fügt einen neuen Bereich hinzu.
Befehl:
aws cognito-idp update-resource-server --user-pool-id
us-west-2_aaaaaaaaa
--identifierweather.example.com
--nameWeather
--scopes ScopeName=NewScope,ScopeDescription="New scope description"Ausgabe:
{ "ResourceServer": { "UserPoolId": "us-west-2_aaaaaaaaa", "Identifier": "weather.example.com", "Name": "Happy", "Scopes": [ { "ScopeName": "NewScope", "ScopeDescription": "New scope description" } ] } }
-
APIEinzelheiten finden Sie UpdateResourceServer
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungupdate-user-attributes
.
- AWS CLI
-
Um Benutzerattribute zu aktualisieren
In diesem Beispiel wird das Benutzerattribut „Nickname“ aktualisiert.
Befehl:
aws cognito-idp update-user-attributes --access-token
ACCESS_TOKEN
--user-attributes Name="nickname",Value="Dan"-
APIEinzelheiten finden Sie UpdateUserAttributes
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungupdate-user-pool-client
.
- AWS CLI
-
Um einen Benutzerpool-Client zu aktualisieren
In diesem Beispiel wird der Name eines Benutzerpool-Clients aktualisiert. Außerdem wird das beschreibbare Attribut „Nickname“ hinzugefügt.
Befehl:
aws cognito-idp update-user-pool-client --user-pool-id
us-west-2_aaaaaaaaa
--client-id3n4b5urk1ft4fl3mg5e62d9ado
--client-name"NewClientName"
--write-attributes"nickname"
Ausgabe:
{ "UserPoolClient": { "UserPoolId": "us-west-2_aaaaaaaaa", "ClientName": "NewClientName", "ClientId": "3n4b5urk1ft4fl3mg5e62d9ado", "LastModifiedDate": 1548802761.334, "CreationDate": 1548178931.258, "RefreshTokenValidity": 30, "WriteAttributes": [ "nickname" ], "AllowedOAuthFlowsUserPoolClient": false } }
-
APIEinzelheiten finden Sie UpdateUserPoolClient
in der AWS CLI Befehlsreferenz.
-
Das folgende Codebeispiel zeigt die Verwendungupdate-user-pool
.
- AWS CLI
-
Um einen Benutzerpool zu aktualisieren
Im folgenden
update-user-pool
Beispiel wird ein Benutzerpool mit Beispielsyntax für jede der verfügbaren Konfigurationsoptionen geändert. Um einen Benutzerpool zu aktualisieren, müssen Sie alle zuvor konfigurierten Optionen angeben. Andernfalls werden sie auf einen Standardwert zurückgesetzt.aws cognito-idp update-user-pool --user-pool-id
us-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"\}\]Mit diesem Befehl wird keine Ausgabe zurückgegeben.
Weitere Informationen finden Sie unter Aktualisieren der Benutzerpool-Konfiguration im Amazon Cognito Developer Guide.
-
APIEinzelheiten finden Sie UpdateUserPool
in der AWS CLI Befehlsreferenz.
-