Memahami endpoint OAuth

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X.
info

Untuk menjalankan tugasnya sebagai server otorisasi OAuth2, Apigee Edge perlu mengekspos endpoint tempat klien dapat meminta token dan kode otorisasi. Topik ini menawarkan pengantar singkat tentang endpoint ini, dan menunjukkan cara menyiapkannya di Edge.

Apa yang dimaksud dengan endpoint OAuth2?

Endpoint OAuth2 adalah URL yang dipanggil klien untuk meminta token OAuth (atau kode autentikasi). Berikut adalah contoh permintaan token akses:

$ curl -i -H 'ContentType: x-www-form-urlencoded' \
-X POST 'https://docs-test.apigee.net/oauth/client_credential/accesstoken' \
-d 'grant_type=client_credentials' \
-H 'Authorization: Basic c3FIOG9vSGV4VHo4QzAySVg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ'

Di lingkungan Apigee Edge, kebijakan diperlukan untuk menangani jenis permintaan ini. Seperti yang dapat Anda simpulkan dari permintaan, kebijakan harus mendukung jenis pemberian "kredensial klien", dan kebijakan harus dijalankan di jalur /oauth/client_credentials/accesstoken.

Kebijakan yang benar dalam kasus ini adalah kebijakan OAuthV2, yang dikonfigurasi untuk dieksekusi dalam alur seperti yang diilustrasikan dalam contoh berikut (dengan nama kebijakan GenerateAccessTokenClient):

        <Flow name="AccessTokenClientCredential">
            <Description/>
            <Request>
                <Step>
                    <FaultRules/>
                    <Name>GenerateAccessTokenClient</Name>
                </Step>
            </Request>
            <Response/>
            <Condition>(proxy.pathsuffix MatchesPath &quot;/accesstoken&quot;) and (request.verb = &quot;POST&quot;)</Condition>
        </Flow>

Jika klien memberikan kredensial yang benar, kebijakan akan membuat dan menampilkan token; jika tidak, kebijakan akan menampilkan error.

Menemukan endpoint default

Apigee menambahkan contoh proxy endpoint OAuth2, secara default, ke setiap organisasi baru yang dibuatnya. Jika Anda melihat, Anda akan menemukan proxy bernama oauth di organisasi Anda.

Untuk menemukan proxy ini:

  1. Akses halaman API Proxies, seperti yang dijelaskan di bawah.

    Edge

    Untuk mengakses halaman API Proxies menggunakan UI Edge:

    1. Login ke apigee.com/edge.
    2. Pilih Develop > API Proxies di menu navigasi kiri.
    3. Klik +Proxy

    Classic Edge (Private Cloud)

    Untuk mengakses halaman API Proxies menggunakan UI Edge Klasik:

    1. Login ke http://ms-ip:9000, dengan ms-ip adalah alamat IP atau nama DNS node Server Pengelolaan.
    2. Pilih APIs > API Proxies di menu navigasi atas.
  2. Dalam daftar proxy, pilih proxy yang bernama oauth.
  3. Di halaman ringkasan proxy, pilih tab Develop untuk membuka editor proxy, lalu periksa kebijakan dan alur di proxy.

Praktik terbaik: Buat proxy endpoint OAuth2 Anda sendiri

Proxy oauth default terbatas: hanya mendukung jenis pemberian kredensial klien. Proxy ini hanya dimaksudkan sebagai contoh. Untuk produksi, Anda sebaiknya membuat proxy yang mengonfigurasi endpoint OAuth2 yang memenuhi persyaratan Anda.

Satu catatan penting: proxy yang menentukan endpoint OAuth2 biasanya merupakan proxy Tanpa Target. Proxy bertindak sebagai layanan yang dieksekusi di ProxyEndpoint dan langsung ditampilkan kembali ke klien.

Topik terkait

Meminta token akses dan kode otorisasi