Obtenga detalles de un AppClient Lista AppClients Actualice un AppClient Eliminar un AppClient Actualizar los tokens para los usuarios finales

Administrar AppFabric para aumentar la productividad AppClients

La función AWS AppFabric de productividad está en versión preliminar y está sujeta a cambios.

Puede gestionar su productividad AppFabric AppClients para garantizar el buen funcionamiento y el mantenimiento de los procesos de autenticación y autorización.

Obtenga detalles de un AppClient

Utilice la operación de la AppFabric GetAppClient API para ver los detalles sobre su AppClient, incluida la verificación del AppClient estado. Para obtener más información, consulte GetAppClient.

Para obtener los detalles de una AppClient, debes tener, como mínimo, los permisos de la política de "appfabric:GetAppClient" IAM. Para obtener más información, consulte Permita el acceso para obtener detalles de AppClients.

Campos requeridos

appClientId- El AppClient carné.

Campos de respuesta

appName- El nombre de la aplicación que se mostrará a los usuarios en la página de consentimiento del portal de AppFabric usuarios.
customerManagedKeyIdentifier (opcional): el ARN de la clave administrada por el cliente (generada por KMS) que se utilizará para cifrar los datos. Si no se especifica, se utilizará la clave AWS AppFabric gestionada.
description: una descripción de la aplicación.
redirectUrls: el URI al que se redirige a los usuarios finales después de la autorización. Puede agregar hasta 5 redirectUrls. Por ejemplo, https://localhost:8080.
starterUserEmails: una dirección de correo electrónico de usuario a la que se permitirá acceder para recibir información hasta que se verifique la aplicación. Solo se permite una dirección de correo electrónico. Por ejemplo, anyuser@example.com.
verificationStatus- El estado AppClient de la verificación.
- pending_verification- La verificación del aún AppClient está en curso AppFabric. Hasta que AppClient se verifique, solo un usuario (especificado enstarterUserEmails) puede usar el AppClient.
- verified- El proceso de verificación se completó correctamente AppFabric y ahora AppClient está completamente verificado.
- rejected- El proceso de verificación del AppClient fue rechazado por AppFabric. AppClient No lo pueden utilizar otros usuarios hasta que el proceso de verificación se reinicie y se complete correctamente.


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

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.


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"
        }
    }
}

Lista AppClients

Usa la operación de la AppFabric ListAppClients API para ver una lista de tus AppClients. AppFabric solo permite uno AppClient por Cuenta de AWS. Este límite está sujeto a cambios en el futuro. Para obtener más información, consulte ListAppClients.

Para publicar AppClients, debes tener, como mínimo, los permisos de la política de "appfabric:ListAppClients" IAM. Para obtener más información, consulte Permitir el acceso a la lista AppClients.

Campos requeridos

No hay campos obligatorios.

Campos de respuesta

appClientARN- El nombre del recurso de Amazon (ARN) que incluye el AppClient ID. Por ejemplo, el AppClient ID esa1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
verificationStatus- El estado AppClient de la verificación.
- pending_verification- La verificación del aún AppClient está en curso AppFabric. Hasta que AppClient se verifique, solo un usuario (especificado enstarterUserEmails) puede usar el AppClient.
- verified- El proceso de verificación se completó correctamente AppFabric y ahora AppClient está completamente verificado.
- rejected- El proceso de verificación del AppClient fue rechazado por AppFabric. AppClient No lo pueden utilizar otros usuarios hasta que el proceso de verificación se reinicie y se complete correctamente.


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

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.


200 OK

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

Actualice un AppClient

Utilice la operación de AppFabric UpdateAppClient API para actualizar las URL de redireccionamiento asignadas a su. AppClient Si necesita cambiar cualquier otro parámetro, por ejemplo, u otro starterUserEmails, debe eliminarlo AppClient y crear uno nuevo. AppName Para obtener más información, consulte UpdateAppClient.

Para actualizar un AppClient, debe tener, como mínimo, los permisos de la política de "appfabric:UpdateAppClient" IAM. Para obtener más información, consulte Permitir el acceso a la actualización AppClients.

Campos requeridos

appClientId(obligatorio): el AppClient ID con el que vas a actualizar las URL del redireccionamiento.
redirectUrls (obligatorio): la lista actualizada de las redirectUrls. Puede agregar hasta 5 redirectUrls.

Campos de respuesta

appName- El nombre de la aplicación que se mostrará a los usuarios en la página de consentimiento del portal de usuarios. AppFabric
customerManagedKeyIdentifier (opcional): el ARN de la clave administrada por el cliente (generada por KMS) que se utilizará para cifrar los datos. Si no se especifica, se utilizará la clave AWS AppFabric gestionada.
description: una descripción de la aplicación.
redirectUrls: el URI al que se redirige a los usuarios finales después de la autorización. Por ejemplo, https://localhost:8080.
starterUserEmails: una dirección de correo electrónico de usuario a la que se permitirá acceder para recibir información hasta que se verifique la aplicación. Solo se permite una dirección de correo electrónico. Por ejemplo, anyuser@example.com.
verificationStatus- El estado AppClient de la verificación.
- pending_verification- La verificación del aún AppClient está en curso AppFabric. Hasta que AppClient se verifique, solo un usuario (especificado enstarterUserEmails) puede usar el AppClient.
- verified- El proceso de verificación se completó correctamente AppFabric y ahora AppClient está completamente verificado.
- rejected- El proceso de verificación del AppClient fue rechazado por AppFabric. AppClient No lo pueden utilizar otros usuarios hasta que el proceso de verificación se reinicie y se complete correctamente.


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"]
}'

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.


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"
        }
    }
}

Eliminar un AppClient

Usa la operación de la AppFabric DeleteAppClient API para eliminar los que ya no AppClients necesites. Para obtener más información, consulte DeleteAppClient.

Para eliminar una AppClient, debes tener, como mínimo, los permisos de la política de "appfabric:DeleteAppClient" IAM. Para obtener más información, consulte Permitir el acceso para eliminar AppClients.

Campos requeridos

appClientId- El AppClient identificador.

Campos de respuesta

No hay campos de respuesta.


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

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 204 con un cuerpo HTTP vacío.

Actualizar los tokens para los usuarios finales

Los tokens que AppClient adquieras para los usuarios finales se pueden actualizar al caducar. Esto se puede hacer mediante la API Token con el grant_type refresh_token. El refresh_token que se va a utilizar se devuelve como parte de la respuesta de la API del token cuando el grant_type es authorization_code. El máximo de caducidad predeterminado es de 12 horas. Para llamar a la API de actualización, debe tener el permiso de la política de IAM "appfabric:Token". Para obtener más información, consulte Token y Permitir el acceso a la actualización AppClients.

Campos requeridos

refresh_token (obligatorio): el token de actualización recibido de la solicitud inicial del /token.
app_client_id(obligatorio): el ID del AppClient recurso creado para. Cuenta de AWS
grant_type (obligatorio): debe ser refresh_token.

Campos de respuesta

expires_in: cuánto falta para que caduque el token. El tiempo de caducidad predeterminado es de 12 horas.
refresh_token: el token de actualización recibido de la solicitud /token inicial.
token: el token recibido de la solicitud /token inicial.
token_type: el valor será Bearer.
appfabric_user_id- El AppFabric seudónimo. Se devuelve solo para las solicitudes que utilizan el tipo de concesión authorization_code.


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\"
}"

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.


200 OK

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

Aviso JavaScript está desactivado o no está disponible en su navegador.

Para utilizar la documentación de AWS, debe estar habilitado JavaScript. Para obtener más información, consulte las páginas de ayuda de su navegador.

Convenciones del documento

Primeros pasos para desarrolladores de aplicaciones

Resolución de problemas