Memahami endpoint OAuth

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

Untuk melakukan tugasnya sebagai server otorisasi OAuth2, Apigee Edge perlu mengekspos endpoint di mana klien dapat meminta token dan kode auth. Topik ini memberikan gambaran singkat pengantar endpoint ini, dan menunjukkan cara menyiapkannya di Edge.

Apa itu endpoint OAuth2?

Endpoint OAuth2 adalah URL yang dipanggil klien untuk meminta token OAuth (atau kode autentikasi). Berikut adalah contoh permintaan untuk 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 Anda, kebijakan diperlukan untuk menangani permintaan semacam ini. Seperti yang Anda bisa dari permintaan, kebijakan tersebut harus mendukung "kredensial klien" jenis hibah, dan kebijakan harus dijalankan pada jalur /oauth/client_credentials/accesstoken.

Tujuan kebijakan yang benar dalam kasus ini adalah kebijakan OAuthV2, yang dikonfigurasi untuk dijalankan dalam alur seperti contoh berikut mengilustrasikan (dengan nama kebijakannya adalah 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; sebaliknya, maka akan menghasilkan {i>error<i}.

Menemukan endpoint default

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

Untuk menemukan proxy ini:

  1. Akses halaman Proxy API, seperti yang dijelaskan di bawah ini.

    Edge

    Untuk mengakses halaman Proxy API menggunakan UI Edge:

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

    Edge Klasik (Private Cloud)

    Untuk mengakses halaman Proxy API menggunakan UI Classic Edge:

    1. Login ke http://ms-ip:9000, dengan ms-ip sebagai Alamat IP atau nama DNS node Server Pengelolaan.
    2. Pilih API > Proxy API di menu navigasi atas.
  2. Dalam daftar proxy, pilih proxy yang disebut oauth.
  3. Di halaman ringkasan proxy, pilih tab Develop untuk memunculkan proxy editor, dan memeriksa kebijakan dan alur di proxy.

Praktik terbaik: Membuat proxy endpoint OAuth2 Anda sendiri

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

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

Topik terkait

Meminta token akses dan kode otorisasi