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 autentikasi. Topik ini memberikan 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 auth). 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 dapat Anda simpulkan dari permintaan tersebut, 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 dijalankan dalam alur seperti yang digambarkan dalam contoh berikut (dengan nama kebijakan 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; 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 perhatikan, Anda akan menemukan proxy yang disebut oauth di organisasi.

Untuk menemukan proxy ini:

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

    Edge

    Untuk mengakses halaman Proxy API menggunakan Edge UI:

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

    Edge Klasik (Private Cloud)

    Untuk mengakses halaman API Proxy menggunakan UI Classic Edge:

    1. Login ke http://ms-ip:9000, dengan ms-ip yang merupakan alamat IP atau nama DNS node Server Pengelolaan.
    2. Pilih APIs > API Proxy di menu navigasi atas.
  2. Pada daftar proxy, pilih yang disebut oauth.
  3. Di halaman ringkasan proxy, pilih tab Develop untuk menampilkan editor proxy, dan periksa kebijakan serta alur di proxy.

Praktik terbaik: Membuat proxy endpoint OAuth2 Anda sendiri

Proxy oauth default terbatas: proxy hanya mendukung jenis pemberian kredensial klien. {i>Proxy<i} ini dimaksudkan sebagai contoh saja. Untuk produksi, sebaiknya buat proxy yang mengonfigurasi endpoint OAuth2 yang memenuhi persyaratan Anda.

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

Topik terkait

Meminta token akses dan kode otorisasi