Verwaltung im AppFabric Hinblick auf Produktivität AppClients - AWS AppFabric
Erfahren Sie mehr über ein AppClientListe AppClientsAktualisieren Sie ein AppClientLöschen Sie ein AppClientTokens für Endbenutzer aktualisieren

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.

Verwaltung im AppFabric Hinblick auf Produktivität AppClients

Die Funktion AWS AppFabric zur Steigerung der Produktivität befindet sich in der Vorschauversion und kann sich ändern.

Sie können Ihre AppFabric Produktivität verwalten, AppClients um den reibungslosen Betrieb und die Aufrechterhaltung der Authentifizierungs- und Autorisierungsprozesse sicherzustellen.

Erfahren Sie mehr über ein AppClient

Verwenden Sie den AppFabric GetAppClient API-Vorgang, um Details zu Ihrem anzuzeigen AppClient, einschließlich der Überprüfung des AppClient Status. Weitere Informationen finden Sie unter GetAppClient.

Um Details zu einem zu erhalten AppClient, müssen Sie mindestens über die "appfabric:GetAppClient" IAM-Richtlinienberechtigungen verfügen. Weitere Informationen finden Sie unter Erlauben Sie den Zugriff, um Details zu erhalten AppClients.

Felder anfordern

  • appClientId- Die AppClient ID.

Antwortfelder

  • appName- Der Name der Anwendung, die den Benutzern auf der Zustimmungsseite des AppFabric Benutzerportals angezeigt wird.

  • customerManagedKeyIdentifier(optional) — Der ARN des vom Kunden verwalteten Schlüssels (generiert von KMS), der zur Verschlüsselung der Daten verwendet werden soll. Wenn nicht angegeben, wird der AWS AppFabric verwaltete Schlüssel verwendet.

  • description- Eine Beschreibung der Anwendung.

  • redirectUrls— Der URI, zu dem Endbenutzer nach der Autorisierung weitergeleitet werden sollen. Sie können bis zu 5 Weiterleitungs-URLs hinzufügen. z. B. https://localhost:8080.

  • starterUserEmails- Eine Benutzer-E-Mail-Adresse, der Zugriff auf die Erkenntnisse gewährt wird, bis die Anwendung verifiziert ist. Es ist nur eine E-Mail-Adresse zulässig. z. B. anyuser@example.com.

  • verificationStatus- Der AppClient Bestätigungsstatus.

    • pending_verification- Die Überprüfung von AppClient ist noch im Gange AppFabric. Bis zur AppClient Überprüfung von kann nur ein Benutzer (angegeben unterstarterUserEmails) den verwenden AppClient.

    • verified- Der Überprüfungsprozess wurde erfolgreich abgeschlossen AppFabric und AppClient ist nun vollständig verifiziert.

    • rejected- Der Überprüfungsprozess für AppClient wurde von abgelehnt AppFabric. Der AppClient kann erst dann von weiteren Benutzern verwendet werden, wenn der Überprüfungsprozess erneut initiiert und erfolgreich abgeschlossen wurde.

curl --request GET \
  --header "Content-Type: application/json" \
  --header "X-Amz-Content-Sha256: <sha256_payload>" \
  --header "X-Amz-Security-Token: <security_token>" \
  --header "X-Amz-Date: 20230922T172215Z" \
  --header "Authorization: AWS4-HMAC-SHA256 ..." \
  --url https://appfabric.<region>.amazonaws.com/appclients/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

200 OK

{
    "appClient": {
        "appName": "Test App",
        "arn": "arn:aws:appfabric:<region>:111122223333:appclient/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "customerManagedKeyArn": "arn:aws:kms:<region>:111122223333:key/<key>",
        "description": "This is a test app",
        "redirectUrls": [
            "https://localhost:8080"
        ],
        "starterUserEmails": [
            "anyuser@example.com"
        ],
        "verificationDetails": {
            "verificationStatus": "pending_verification"
        }
    }
}

Liste AppClients

Verwenden Sie den AppFabric ListAppClients API-Vorgang, um eine Liste Ihrer anzuzeigen AppClients. AppFabric erlaubt nur einen AppClient pro AWS-Konto. Dies kann sich in future ändern. Weitere Informationen finden Sie unter ListAppClients.

Um die Liste auflisten AppClients zu können, müssen Sie mindestens über die "appfabric:ListAppClients" IAM-Richtlinienberechtigungen verfügen. Weitere Informationen finden Sie unter Erlauben Sie den Zugriff auf die Liste AppClients.

Felder anfordern

  • Es gibt keine Pflichtfelder.

Felder für Antworten

  • appClientARN- Der Amazon-Ressourcenname (ARN), der die AppClient ID enthält. Die AppClient ID lautet beispielsweisea1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

  • verificationStatus- Der AppClient Bestätigungsstatus.

    • pending_verification- Die Überprüfung von AppClient ist noch im Gange AppFabric. Bis zur AppClient Überprüfung von kann nur ein Benutzer (angegeben unterstarterUserEmails) den verwenden AppClient.

    • verified- Der Überprüfungsprozess wurde erfolgreich abgeschlossen AppFabric und AppClient ist nun vollständig verifiziert.

    • rejected- Der Überprüfungsprozess für AppClient wurde von abgelehnt AppFabric. Der AppClient kann erst dann von weiteren Benutzern verwendet werden, wenn der Überprüfungsprozess erneut initiiert und erfolgreich abgeschlossen wurde.

curl --request GET \
  --header "Content-Type: application/json" \
  --header "X-Amz-Content-Sha256: <sha256_payload>" \
  --header "X-Amz-Security-Token: <security_token>" \
  --header "X-Amz-Date: 20230922T172215Z" \
  --header "Authorization: AWS4-HMAC-SHA256 ..." \
  --url https://appfabric.<region>.amazonaws.com/appclients

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

200 OK

{
    "appClientList": [
        {
            "appClientArn": "arn:aws:appfabric:<region>:111122223333:appclient/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
            "verificationStatus": "pending_verification"
        }
    ]
}

Aktualisieren Sie ein AppClient

Verwenden Sie den AppFabric UpdateAppClient API-Vorgang, um die Ihren zugewiesenen Redirect-URLs zu aktualisieren. AppClient Wenn Sie andere Parameter wie, oder andere ändern müssen AppName starterUserEmails, müssen Sie diese löschen AppClient und einen neuen erstellen. Weitere Informationen finden Sie unter UpdateAppClient.

Um einen zu aktualisieren AppClient, müssen Sie mindestens über die "appfabric:UpdateAppClient" IAM-Richtlinienberechtigungen verfügen. Weitere Informationen finden Sie unter Erlauben Sie den Zugriff auf das Update AppClients.

Felder anfordern

  • appClientId(erforderlich) — Die AppClient ID, mit der Sie die Redirect-URLs aktualisieren.

  • redirectUrls(erforderlich) — Die aktualisierte Liste der RedirectURLs. Sie können bis zu 5 RedirectURLs hinzufügen.

Antwortfelder

  • appName- Der Name der Anwendung, die den Benutzern auf der Zustimmungsseite des AppFabric Benutzerportals angezeigt wird.

  • customerManagedKeyIdentifier(optional) — Der ARN des vom Kunden verwalteten Schlüssels (generiert von KMS), der zur Verschlüsselung der Daten verwendet werden soll. Wenn nicht angegeben, wird der AWS AppFabric verwaltete Schlüssel verwendet.

  • description- Eine Beschreibung der Anwendung.

  • redirectUrls— Der URI, zu dem Endbenutzer nach der Autorisierung weitergeleitet werden sollen. z. B. https://localhost:8080.

  • starterUserEmails- Eine Benutzer-E-Mail-Adresse, der Zugriff gewährt wird, um die Erkenntnisse zu erhalten, bis die Anwendung verifiziert ist. Es ist nur eine E-Mail-Adresse zulässig. z. B. anyuser@example.com.

  • verificationStatus- Der AppClient Bestätigungsstatus.

    • pending_verification- Die Überprüfung von AppClient ist noch im Gange AppFabric. Bis zur AppClient Überprüfung von kann nur ein Benutzer (angegeben unterstarterUserEmails) den verwenden AppClient.

    • verified- Der Überprüfungsprozess wurde erfolgreich abgeschlossen AppFabric und AppClient ist nun vollständig verifiziert.

    • rejected- Der Überprüfungsprozess für AppClient wurde von abgelehnt AppFabric. Der AppClient kann erst dann von weiteren Benutzern verwendet werden, wenn der Überprüfungsprozess erneut initiiert und erfolgreich abgeschlossen wurde.

curl --request PATCH \
  --header "Content-Type: application/json" \
  --header "X-Amz-Content-Sha256: <sha256_payload>" \
  --header "X-Amz-Security-Token: <security_token>" \
  --header "X-Amz-Date: 20230922T172215Z" \
  --header "Authorization: AWS4-HMAC-SHA256 ..." \
  --url https://appfabric.<region>.amazonaws.com/appclients/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
  --data '{
    "redirectUrls": ["https://localhost:8081"]
}'

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

200 OK

{
    "appClient": {
        "appName": "Test App",
        "arn": "arn:aws:appfabric:<region>:111122223333:appclient/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "customerManagedKeyArn": "arn:aws:kms:<region>:111122223333:key/<key>",
        "description": "This is a test app",
        "redirectUrls": [
            "https://localhost:8081"
        ],
        "starterUserEmails": [
            "anyuser@example.com"
        ],
        "verificationDetails": {
            "verificationStatus": "pending_verification"
        }
    }
}

Löschen Sie ein AppClient

Verwenden Sie den AppFabric DeleteAppClient API-Vorgang, um alle zu löschen, die AppClients Sie nicht mehr benötigen. Weitere Informationen finden Sie unter DeleteAppClient.

Um eine zu löschen AppClient, müssen Sie mindestens über die "appfabric:DeleteAppClient" IAM-Richtlinienberechtigungen verfügen. Weitere Informationen finden Sie unter Erlauben Sie den Zugriff zum Löschen AppClients.

Felder anfordern

  • appClientId- Die AppClient ID.

Antwortfelder

  • Es gibt keine Antwortfelder.

curl --request DELETE \
  --header "Content-Type: application/json" \
  --header "X-Amz-Content-Sha256: <sha256_payload>" \
  --header "X-Amz-Security-Token: <security_token>" \
  --header "X-Amz-Date: 20230922T172215Z" \
  --header "Authorization: AWS4-HMAC-SHA256 ..." \
  --url https://appfabric.<region>.amazonaws.com/appclients/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Wenn die Aktion erfolgreich ist, gibt der Dienst eine HTTP-204-Antwort mit leerem HTTP-Textinhalt zurück.

Tokens für Endbenutzer aktualisieren

Die Token, die AppClient Sie für Endbenutzer erwerben, können nach Ablauf aktualisiert werden. Dies kann mithilfe der Token API mit dem refresh_token Grant_Type erfolgen. Der refresh_token zu verwendende Wert wird als Teil der Token-API-Antwort zurückgegeben, wenn der Grant_Type authorization_code Die Standardablaufzeiten sind 12 Stunden. Um die Aktualisierungs-API aufzurufen, benötigen Sie die "appfabric:Token" IAM-Richtlinienberechtigung. Weitere Informationen finden Sie unter Token und Erlauben Sie den Zugriff auf das Update AppClients.

Felder anfordern

  • refresh_token(erforderlich) — Das Aktualisierungstoken, das bei der ersten /token Anfrage empfangen wurde.

  • app_client_id(erforderlich) — Die ID der AppClient Ressource, die für die erstellt wurde AWS-Konto.

  • grant_type(erforderlich) — Das muss seinrefresh_token.

Antwortfelder

  • expires_in- Wie lange dauert es, bis das Token abläuft. Die Standardablaufzeit beträgt 12 Stunden.

  • refresh_token— Das Aktualisierungstoken, das von der ersten /token-Anforderung empfangen wurde.

  • token— Das Token, das von der ersten /token-Anforderung empfangen wurde.

  • token_type- Der Wert wird sein. Bearer

  • appfabric_user_id- Die AppFabric Benutzer-ID. Dies wird nur für Anfragen zurückgegeben, die den authorization_code Grant-Typ verwenden.

curl --location \
"https://appfabric.<region>.amazonaws.com/oauth2/token" \
--header "Content-Type: application/json" \
--header "X-Amz-Content-Sha256: <sha256_payload>" \
--header "X-Amz-Security-Token: <security_token>" \
--header "X-Amz-Date: 20230922T172215Z" \
--header "Authorization: AWS4-HMAC-SHA256 ..." \
--data "{
    \"refresh_token\": \"<refresh_token>",
    \"app_client_id\": \"a1b2c3d4-5678-90ab-cdef-EXAMPLE11111\",
    \"grant_type\": \"refresh_token\"
}"

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

200 OK

{
    "expires_in": 43200,
    "token": "apkaeibaerjr2example",
    "token_type": "Bearer",
    "appfabric_user_id" : "${UserID}"
}