Mengelola AppFabric produktivitas AppClients - AWS AppFabric
Dapatkan detail dari AppClientDaftar AppClientsPerbarui AppClientMenghapus AppClientSegarkan token untuk pengguna akhir

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Mengelola AppFabric produktivitas AppClients

Fitur AWS AppFabric untuk produktivitas dalam pratinjau dan dapat berubah sewaktu-waktu.

Anda dapat mengelola produktivitas Anda AppFabric AppClients untuk memastikan kelancaran operasi dan pemeliharaan proses otentikasi dan otorisasi.

Dapatkan detail dari AppClient

Gunakan operasi AppFabric GetAppClient API untuk melihat detail tentang Anda AppClient, termasuk memeriksa AppClient status. Untuk informasi selengkapnya, lihat GetAppClient.

Untuk mendapatkan detail AppClient, Anda harus memiliki, setidaknya, izin kebijakan "appfabric:GetAppClient" IAM. Untuk informasi selengkapnya, lihat Izinkan akses untuk mendapatkan detail AppClients.

Bidang Permintaan

  • appClientId- AppClient Id.

Bidang Respons

  • appName- Nama aplikasi yang akan ditampilkan kepada pengguna di halaman persetujuan portal AppFabric pengguna.

  • customerManagedKeyIdentifier(opsional) - ARN dari Customer Managed Key (dihasilkan oleh KMS) untuk digunakan untuk mengenkripsi data. Jika tidak ditentukan, maka Kunci AWS AppFabric Terkelola akan digunakan.

  • description- Deskripsi untuk aplikasi.

  • redirectUrls- URI untuk mengarahkan pengguna akhir setelah otorisasi. Anda dapat menambahkan hingga 5 RedirecTurls. Misalnya, https://localhost:8080.

  • starterUserEmails- Alamat email pengguna yang akan diizinkan mengakses untuk menerima wawasan sampai aplikasi diverifikasi. Hanya satu alamat email yang diizinkan. Misalnya, anyuser@example.com.

  • verificationStatus- Status AppClient verifikasi.

    • pending_verification- Verifikasi AppClient masih dalam proses dengan AppFabric. Sampai AppClient diverifikasi, hanya satu pengguna (ditentukan dalamstarterUserEmails) yang dapat menggunakan file AppClient.

    • verified- Proses verifikasi telah berhasil diselesaikan oleh AppFabric dan sekarang sepenuhnya diverifikasi. AppClient

    • rejected- Proses verifikasi untuk AppClient ditolak oleh AppFabric. AppClient Tidak dapat digunakan oleh pengguna tambahan sampai proses verifikasi dimulai kembali dan diselesaikan dengan sukses.

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

Jika tindakan berhasil, layanan mengirimkan kembali respons 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"
        }
    }
}

Daftar AppClients

Gunakan operasi AppFabric ListAppClients API untuk melihat daftar Anda AppClients. AppFabric hanya memungkinkan satu AppClient per Akun AWS. Ini dapat berubah di masa depan. Untuk informasi selengkapnya, lihat ListAppClients.

Untuk mendaftar AppClients, Anda harus memiliki, setidaknya, izin kebijakan "appfabric:ListAppClients" IAM. Untuk informasi selengkapnya, lihat Izinkan akses ke daftar AppClients.

Bidang Permintaan

  • Tidak ada bidang wajib.

Bidang Respons

  • appClientARN- Nama Sumber Daya Amazon (ARN) yang menyertakan ID. AppClient Misalnya, AppClient ID adalaha1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

  • verificationStatus- Status AppClient verifikasi.

    • pending_verification- Verifikasi AppClient masih dalam proses dengan AppFabric. Sampai AppClient diverifikasi, hanya satu pengguna (ditentukan dalamstarterUserEmails) yang dapat menggunakan file AppClient.

    • verified- Proses verifikasi telah berhasil diselesaikan oleh AppFabric dan sekarang sepenuhnya diverifikasi. AppClient

    • rejected- Proses verifikasi untuk AppClient ditolak oleh AppFabric. AppClient Tidak dapat digunakan oleh pengguna tambahan sampai proses verifikasi dimulai kembali dan diselesaikan dengan sukses.

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

200 OK

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

Perbarui AppClient

Gunakan operasi AppFabric UpdateAppClient API untuk memperbarui redirectUrls yang dipetakan ke Anda. AppClient Jika Anda perlu mengubah parameter lain, seperti AppName, starterUserEmails, atau lainnya, Anda harus menghapus AppClient dan membuat yang baru. Untuk informasi selengkapnya, lihat UpdateAppClient.

Untuk memperbarui AppClient, Anda harus memiliki, setidaknya, izin kebijakan "appfabric:UpdateAppClient" IAM. Untuk informasi selengkapnya, lihat Izinkan akses untuk memperbarui AppClients.

Bidang Permintaan

  • appClientId(required) - AppClient ID yang Anda perbarui redirectUrls.

  • redirectUrls(wajib) - Daftar RedirecTurls yang diperbarui. Anda dapat menambahkan hingga 5 RedirecTurls.

Bidang Respons

  • appName- Nama aplikasi yang akan ditampilkan kepada pengguna di halaman persetujuan portal AppFabric pengguna.

  • customerManagedKeyIdentifier(opsional) - ARN dari Customer Managed Key (dihasilkan oleh KMS) untuk digunakan untuk mengenkripsi data. Jika tidak ditentukan, maka Kunci AWS AppFabric Terkelola akan digunakan.

  • description- Deskripsi untuk aplikasi.

  • redirectUrls- URI untuk mengarahkan pengguna akhir setelah otorisasi. Misalnya, https://localhost:8080.

  • starterUserEmails- Alamat email pengguna yang akan diizinkan mengakses untuk menerima wawasan sampai aplikasi diverifikasi. Hanya satu alamat email yang diizinkan. Misalnya, anyuser@example.com.

  • verificationStatus- Status AppClient verifikasi.

    • pending_verification- Verifikasi AppClient masih dalam proses dengan AppFabric. Sampai AppClient diverifikasi, hanya satu pengguna (ditentukan dalamstarterUserEmails) yang dapat menggunakan file AppClient.

    • verified- Proses verifikasi telah berhasil diselesaikan oleh AppFabric dan sekarang sepenuhnya diverifikasi. AppClient

    • rejected- Proses verifikasi untuk AppClient ditolak oleh AppFabric. AppClient Tidak dapat digunakan oleh pengguna tambahan sampai proses verifikasi dimulai kembali dan diselesaikan dengan sukses.

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

Jika tindakan berhasil, layanan mengirimkan kembali respons 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"
        }
    }
}

Menghapus AppClient

Gunakan operasi AppFabric DeleteAppClient API untuk menghapus apa pun yang tidak lagi AppClients Anda perlukan. Untuk informasi selengkapnya, lihat DeleteAppClient.

Untuk menghapus AppClient, Anda harus memiliki, setidaknya, izin kebijakan "appfabric:DeleteAppClient" IAM. Untuk informasi selengkapnya, lihat Izinkan akses untuk menghapus AppClients.

Bidang permintaan

  • appClientId- AppClient Id.

Bidang respons

  • Tidak ada bidang respons.

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 204 dengan isi HTTP kosong.

Segarkan token untuk pengguna akhir

Token yang Anda AppClient peroleh untuk pengguna akhir dapat di-refresh pada saat kedaluwarsa. Ini dapat dilakukan dengan menggunakan Token API dengan refresh_token grant_type. Yang refresh_token akan digunakan dikembalikan sebagai bagian dari respons API token saat grant_type. authorization_code Kedaluwarsa default adalah 12 jam. Untuk memanggil refresh API, Anda harus memiliki izin kebijakan "appfabric:Token" IAM. Untuk informasi selengkapnya, lihat Token dan Izinkan akses untuk memperbarui AppClients.

Bidang Permintaan

  • refresh_token(wajib) - Token penyegaran yang diterima dari /token permintaan awal.

  • app_client_id(wajib) - ID AppClient sumber daya yang dibuat untuk file Akun AWS.

  • grant_type(wajib) - Ini harusrefresh_token.

Bidang Respons

  • expires_in- Seberapa cepat sebelum token kedaluwarsa. Waktu kedaluwarsa default adalah 12 jam.

  • refresh_token- Token penyegaran yang diterima dari permintaan /token awal.

  • token- Token yang diterima dari permintaan /token awal.

  • token_type- Nilainya akanBearer.

  • appfabric_user_id- Id AppFabric pengguna. Ini dikembalikan hanya untuk permintaan yang menggunakan jenis authorization_code hibah.

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

Jika tindakan berhasil, layanan mengirimkan kembali respons HTTP 200.

200 OK

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