Kebijakan GenerateJWT

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Apa

Membuat JWT yang ditandatangani atau JWT terenkripsi, dengan kumpulan klaim yang dapat dikonfigurasi. JWT kemudian dapat ditampilkan ke klien, dikirim ke target backend, atau digunakan dengan cara lain. Lihat ringkasan kebijakan JWS dan JWT untuk pengantar mendetail.

Kebijakan ini adalah Kebijakan yang dapat diperluas dan penggunaan kebijakan ini mungkin memiliki implikasi biaya atau penggunaan, bergantung pada lisensi Apigee Anda. Untuk informasi tentang jenis kebijakan dan implikasi penggunaan, lihat Jenis kebijakan.

Solusi

Apakah kebijakan menghasilkan JWT yang ditandatangani atau dienkripsi bergantung pada elemen yang Anda gunakan untuk menentukan algoritma yang menghasilkan JWT:

• Jika Anda menggunakan elemen <Algorithm>, kebijakan akan membuat JWT yang ditandatangani.
• Jika Anda menggunakan elemen <Algorithms>, kebijakan akan menghasilkan JWT terenkripsi.

Video

Catatan: Video berikut menampilkan Editor Proxy klasik di UI Apigee. Apigee memperkenalkan versi baru Editor Proxy, yang memiliki desain berbeda dari versi klasik yang ditampilkan dalam video.

Tonton video singkat untuk mempelajari cara membuat JWT yang ditandatangani.

Membuat JWT yang Ditandatangani

Bagian ini menjelaskan cara membuat JWT yang ditandatangani. Untuk JWT yang ditandatangani, gunakan elemen <Algorithm> untuk menentukan algoritma untuk menandatangani kunci.

Contoh untuk JWT yang ditandatangani

Contoh berikut mengilustrasikan cara membuat JWT yang ditandatangani.

Algoritma HS256

Contoh kebijakan ini menghasilkan JWT baru dan menandatanganinya menggunakan algoritma HS256. HS256 mengandalkan rahasia bersama untuk menandatangani dan memverifikasi tanda tangan.

Saat tindakan kebijakan ini dipicu, Apigee akan mengenkode header dan payload JWT, lalu menandatangani JWT secara digital. Tonton video di atas untuk melihat contoh lengkap, termasuk cara mengajukan permintaan untuk kebijakan tersebut.

Konfigurasi kebijakan di sini akan membuat JWT dengan serangkaian klaim standar seperti yang ditentukan oleh spesifikasi JWT, termasuk masa berlaku 1 jam, serta klaim tambahan. Anda dapat menyertakan klaim tambahan sebanyak yang diinginkan. Lihat Referensi elemen untuk mengetahui detail tentang persyaratan dan opsi untuk setiap elemen dalam contoh kebijakan ini.

<GenerateJWT name="JWT-Generate-HS256">
    <DisplayName>JWT Generate HS256</DisplayName>
    <Type>Signed</Type>
    <Algorithm>HS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <SecretKey>
        <Value ref="private.secretkey"/>
        <Id>1918290</Id>
    </SecretKey>
    <ExpiresIn>1h</ExpiresIn>
    <Subject>monty-pythons-flying-circus</Subject>
    <Issuer>urn://apigee-JWT-policy-test</Issuer>
    <Audience>fans</Audience>
    <Id/>
    <AdditionalClaims>
        <Claim name="show">And now for something completely different.</Claim>
    </AdditionalClaims>
    <OutputVariable>jwt-variable</OutputVariable>
</GenerateJWT>

JWT yang dihasilkan akan memiliki header ini …

{
  "typ" : "JWT",
  "alg" : "HS256",
  "kid" : "1918290"
}

… dan akan memiliki payload dengan konten seperti ini:

{
  "sub" : "monty-pythons-flying-circus",
  "iss" : "urn://apigee-JWT-policy-test",
  "aud" : "fans",
  "iat" : 1506553019,
  "exp" : 1506556619,
  "jti" : "BD1FF263-3D25-4593-A685-5EC1326E1F37",
  "show": "And now for something completely different."
}

Nilai klaim iat, exp, dan jti akan bervariasi.

Algoritma RS256

Catatan: Gunakan contoh yang sama ini untuk membuat JWT untuk algoritma PS256 atau ES256. Cukup ubah nilai <Algorithm>RS256</Algorithm> menjadi PS256 atau ES256. Untuk ES256, Anda juga harus menentukan kunci yang kompatibel dengan algoritma. Untuk mengetahui persyaratan kunci selengkapnya, lihat Tentang algoritma enkripsi tanda tangan.

Contoh kebijakan ini membuat JWT baru dan menandatanganinya menggunakan algoritma RS256. Pembuatan tanda tangan RS256 bergantung pada kunci pribadi RSA, yang harus diberikan dalam bentuk yang dienkode PEM, dan yang dapat dienkripsi dengan sandi. Tonton video di atas untuk melihat contoh lengkap, termasuk cara mengajukan permintaan untuk kebijakan tersebut.

Saat tindakan kebijakan ini dipicu, Apigee akan mengenkode dan menandatangani JWT secara digital, termasuk klaim. Untuk mempelajari bagian-bagian JWT dan cara dienkripsi serta ditandatangani, lihat RFC7519.

<GenerateJWT name="JWT-Generate-RS256">
    <Type>Signed</Type>
    <Algorithm>RS256</Algorithm>
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <PrivateKey>
        <Value ref="private.privatekey"/>
        <Password ref="private.privatekey-password"/>
        <Id ref="private.privatekey-id"/>
    </PrivateKey>
    <Subject>apigee-seattle-hatrack-montage</Subject>
    <Issuer>urn://apigee-JWT-policy-test</Issuer>
    <Audience>urn://c60511c0-12a2-473c-80fd-42528eb65a6a</Audience>
    <ExpiresIn>60m</ExpiresIn>
    <Id/>
    <AdditionalClaims>
        <Claim name="show">And now for something completely different.</Claim>
    </AdditionalClaims>
    <OutputVariable>jwt-variable</OutputVariable>
</GenerateJWT>

Contoh di atas menggunakan elemen <Algorithm>, sehingga menghasilkan JWT yang ditandatangani. Elemen <PrivateKey> menentukan kunci kriptografis yang digunakan untuk menandatangani JWT. Ada juga elemen penting lainnya. Mana yang Anda gunakan bergantung pada algoritma yang ditentukan oleh nilai <Algorithm>, seperti yang dijelaskan di bagian berikutnya.

Menetapkan elemen kunci untuk JWT yang ditandatangani

Gunakan salah satu elemen berikut untuk menentukan kunci yang digunakan untuk membuat JWT yang ditandatangani:

• <SecretKey>
• <PrivateKey>

Elemen yang Anda gunakan bergantung pada algoritma yang dipilih, seperti yang ditunjukkan dalam tabel berikut:

Catatan: Algoritma RS*, PS*, dan ES* semuanya menggunakan elemen yang sama untuk menentukan kunci, tetapi data kunci ES* berbeda dengan yang digunakan oleh algoritma RS* dan PS*.

Algoritme	Elemen utama
HS{256/384/512}^*	<SecretKey> <Value ref="private.secretkey"/> <Id ref="secretkey-id">key-1918290</Id> </SecretKey>
RS/PS/ES{256/384/512}^*	<PrivateKey> <Value ref="private.privatekey"/> <Password ref="private.privatekey-password"/> <Id ref="privatekey-id">key-1918290</Id> </PrivateKey>

Pada contoh di atas, elemen <Password> dan <Id> bersifat opsional.

Untuk mengetahui persyaratan kunci selengkapnya, lihat Tentang algoritma enkripsi tanda tangan.

Membuat JWT terenkripsi

Bagian ini menjelaskan cara membuat JWT terenkripsi. Untuk JWT terenkripsi, gunakan elemen <Algorithms> untuk menentukan algoritma untuk menandatangani kunci dan konten.

Contoh untuk JWT terenkripsi

Contoh berikut menunjukkan cara membuat JWT terenkripsi. Contoh ini menggunakan elemen <Algorithms>, sehingga menghasilkan JWT terenkripsi.

RSA-OAEP-256

Pada contoh di bawah:

• Kunci dienkripsi dengan algoritma RSA-OAEP-256.
• Konten dienkripsi dengan algoritma A128GCM.

Elemen <PublicKey> menentukan kunci yang digunakan untuk enkripsi kunci.

<GenerateJWT name="gjwt-1">
  <Type>Encrypted</Type>
  <Algorithms>
    <Key>RSA-OAEP-256</Key>
    <Content>A128GCM</Content>
  </Algorithms>
  <PublicKey>
    <Value ref="rsa_publickey"/>
  </PublicKey>
  <Subject>[e-mail]</Subject>
  <Issuer>urn://apigee</Issuer>
  <ExpiresIn>1h</ExpiresIn>
  <AdditionalHeaders>
    <Claim name="moniker">Harvey</Claim>
  </AdditionalHeaders>
  <OutputVariable>output_var</OutputVariable>
</GenerateJWT>

A128KW

Pada contoh di bawah:

• Kunci dienkripsi dengan algoritma A128KW.
• Konten dienkripsi dengan algoritma A128GCM.

Elemen <SecretKey> menentukan kunci yang digunakan untuk enkripsi kunci.

<GenerateJWT name='gjwt-2'>
  <Algorithms>
    <Key>A128KW</Key>
    <Content>A128GCM</Content>
  </Algorithms>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
  <SecretKey>
    <Value ref='private.secretkey'/>
  </SecretKey>
  <Subject>[e-mail]</Subject>
  <Issuer>urn://apigee</Issuer>
  <ExpiresIn>1h</ExpiresIn>
  <OutputVariable>output_var</OutputVariable>
</GenerateJWT>

Menetapkan elemen kunci untuk JWT terenkripsi

Gunakan salah satu elemen berikut untuk menentukan kunci enkripsi untuk GenerateJWT, jika Anda ingin membuat JWT terenkripsi:

• <PublicKey>
• <SecretKey>
• <PasswordKey>
• <DirectKey>

Elemen yang Anda gunakan bergantung pada algoritma enkripsi kunci yang dipilih, seperti yang ditunjukkan dalam tabel berikut:

Algoritma enkripsi kunci	Elemen utama
RSA-OAEP-256	<PublicKey> <Value ref="rsa_publickey"/> </PublicKey> Catatan: Kunci harus di-resolve ke kunci publik RSA.
ECDH-ES ECDH-ES+A128KW ECDH-ES+A192KW ECDH-ES+A256KW	<PublicKey> <Value ref="ec_publickey"/> </PublicKey> Catatan: Kunci harus me-resolve ke kunci publik kurva elips.
A128KW A192KW A256KW A128GCMKW A192GCMKW A256GCMKW	<SecretKey> <Id>optional key identifier here</Id> <Value ref="private.secretkey"/> </SecretKey>
PBES2-HS256+A128KW PBES2-HS384+A192KW PBES2-HS512+A256KW	<PasswordKey> <Id>optional key identifier here</Id> <Value ref="private.passwordkey"/> <SaltLength> <PBKDF2Iterations> </PasswordKey>
dir	<DirectKey> <Id>optional key identifier here</Id> <Value encoding="base16|hex|base64|base64url" ref="private.directkey"/> </DirectKey>

Untuk mengetahui persyaratan kunci selengkapnya, lihat Tentang algoritma enkripsi tanda tangan.

Referensi elemen untuk Membuat JWT

Referensi kebijakan menjelaskan elemen dan atribut kebijakan Buat JWT.

Catatan: Konfigurasi akan sedikit berbeda bergantung pada algoritma enkripsi yang Anda gunakan. Lihat Contoh untuk JWT yang ditandatangani atau Contoh untuk JWT terenkripsi untuk mengetahui contoh yang menunjukkan konfigurasi untuk kasus penggunaan tertentu.

Atribut yang berlaku untuk elemen tingkat atas

<GenerateJWT name="JWT" continueOnError="false" enabled="true" async="false">

Atribut berikut bersifat umum untuk semua elemen induk kebijakan.

Atribut	Deskripsi	Default	Kehadiran
nama	Nama internal kebijakan. Karakter yang dapat Anda gunakan dalam nama dibatasi untuk: A-Z0-9._\-$ %. Namun, UI Apigee menerapkan batasan tambahan, seperti menghapus karakter yang bukan alfanumerik secara otomatis. Secara opsional, gunakan elemen <displayname></displayname> untuk memberi label pada kebijakan di editor proxy UI Apigee dengan nama bahasa alami yang berbeda.	T/A	Wajib
continueOnError	Tetapkan ke false untuk menampilkan error saat kebijakan gagal. Perilaku ini wajar terjadi untuk sebagian besar kebijakan. Tetapkan ke true agar eksekusi alur berlanjut meskipun setelah kebijakan gagal.	false	Opsional
diaktifkan	Tetapkan ke true untuk menerapkan kebijakan. Tetapkan ke false untuk "menonaktifkan" kebijakan. Kebijakan tidak akan diterapkan meskipun tetap terlampir ke alur.	benar	Opsional
asinkron	Atribut ini tidak digunakan lagi.	false	Tidak digunakan lagi

<DisplayName>

<DisplayName>Policy Display Name</DisplayName>

Gunakan selain atribut nama untuk memberi label pada kebijakan di editor proxy UI Apigee dengan nama bahasa alami yang berbeda.

Default	Jika Anda menghapus elemen ini, nilai atribut nama kebijakan akan digunakan.
Kehadiran	Opsional
Jenis	String

<Algorithm>

<Algorithm>algorithm-here</Algorithm>

Menentukan algoritma kriptografi yang digunakan untuk menandatangani token. Gunakan elemen <Algorithm> untuk membuat JWT yang ditandatangani.

Catatan: Gunakan tepat satu elemen <Algorithm> dan <Algorithms>.

Default	T/A
Kehadiran	Opsional. <Algorithm> atau <Algorithms> harus ada.
Jenis	String
Nilai yang valid	HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, PS384, PS512

<Algorithms>

<Algorithms>
    <Key>key-algorithm</Key>
    <Content>content-algorithm</Content>
</Algorithm>

Menentukan algoritma kriptografi untuk enkripsi kunci dan konten. Gunakan elemen <Algorithms> untuk membuat JWT terenkripsi.

Catatan: Gunakan tepat satu elemen <Algorithm> dan <Algorithms>.

Default	T/A
Opsional. <Algorithm> atau <Algorithms> harus ada.	Wajib
Jenis	String

Elemen turunan dari <Algorithms>

Tabel berikut memberikan deskripsi tingkat tinggi tentang elemen turunan <Algorithms>:

Elemen Turunan	Wajib?	Deskripsi
<Key>	Wajib	Menentukan algoritma enkripsi untuk kunci.
<Content>	Wajib	Menentukan algoritma enkripsi untuk konten.

Algoritma enkripsi kunci

Tabel berikut mencantumkan algoritma yang tersedia untuk enkripsi kunci.

Nilai <Key> (algoritma enkripsi kunci)	Elemen kunci wajib diisi
dir	<DirectKey>
RSA-OAEP-256	<PublicKey> (yang harus me-resolve ke kunci publik RSA)
A128KW A192KW A256KW A128GCMKW A192GCMKW A256GCMKW	<SecretKey>
PBES2-HS256+A128KW PBES2-HS384+A192KW PBES2-HS512+A256KW	<PasswordKey>
ECDH-ES ECDH-ES+A128KW ECDH-ES+A192KW ECDH-ES+A256KW	<PublicKey> (yang harus me-resolve ke kunci publik kurva elips)

Lihat Membuat JWT terenkripsi untuk mengetahui contoh saat algoritma enkripsi kunci adalah RSA-OAEP-256, sehingga Anda menggunakan elemen <PublicKey> dengan nilai yang me-resolve ke kunci Publik RSA.

Algoritma enkripsi konten

Algoritma berikut (simetris, berbasis AES) tersedia untuk enkripsi konten:

• A128CBC-HS256
• A192CBC-HS384
• A256CBC-HS512
• A128GCM
• A192GCM
• A256GCM

Untuk mengetahui informasi selengkapnya tentang semua algoritma ini, lihat RFC7518.

<Audience>

<Audience>audience-here</Audience>

or:

<Audience ref='variable_containing_audience'/>

Kebijakan ini menghasilkan JWT yang berisi klaim aud yang ditetapkan ke nilai yang ditentukan. Klaim ini mengidentifikasi penerima yang dituju JWT. Ini adalah salah satu klaim terdaftar yang disebutkan dalam RFC7519.

Default	T/A
Kehadiran	Opsional
Jenis	Array (daftar nilai yang dipisahkan koma)
Nilai yang valid	Apa pun yang mengidentifikasi audiens.

<AdditionalClaims/Claim>

<AdditionalClaims>
    <Claim name='claim1'>explicit-value-of-claim-here</Claim>
    <Claim name='claim2' ref='variable-name-here'/>
    <Claim name='claim3' ref='variable-name-here' type='boolean'/>
</AdditionalClaims>

or:

<AdditionalClaims ref='claim_payload'/>

Memungkinkan Anda menentukan pasangan nama/nilai klaim tambahan dalam payload JWT. Anda dapat menentukan klaim secara eksplisit sebagai string, angka, boolean, peta, atau array. Peta hanyalah sekumpulan pasangan nama/nilai.

Elemen <Claim> mendukung fitur penggantian string dinamis yang disebut template pesan saat type=map.

Default	T/A
Kehadiran	Opsional
Nilai yang valid	Nilai apa pun yang ingin Anda gunakan untuk klaim tambahan. Anda dapat menentukan klaim secara eksplisit sebagai string, angka, boolean, peta, atau array.

Elemen <Claim> menggunakan atribut berikut:

• name - (Wajib) Nama klaim.
  Catatan: Jangan gunakan nama klaim terdaftar apa pun dalam elemen ini. Klaim terdaftar ditentukan dalam RFC7519. Ini mencakup: "iss", "sub", "aud", "iat", "exp", "nbf", dan "jti".
• ref - (Opsional) Nama variabel alur. Jika ada, kebijakan akan menggunakan nilai variabel ini sebagai klaim. Jika atribut ref dan nilai klaim eksplisit ditentukan, nilai eksplisit adalah default, dan digunakan jika variabel alur yang dirujuk tidak terselesaikan.
• type - (Opsional) Salah satu dari: string (default), angka, boolean, atau peta
• array - (Opsional) Tetapkan ke true untuk menunjukkan apakah nilainya adalah array jenis. Default: false.

Saat Anda menyertakan elemen <Claim>, nama klaim ditetapkan secara statis saat Anda mengonfigurasi kebijakan. Atau, Anda dapat meneruskan objek JSON untuk menentukan nama klaim. Karena objek JSON diteruskan sebagai variabel, nama klaim dalam JWT yang dihasilkan ditentukan saat runtime.

Contoh:

<AdditionalClaims ref='json_claims'/>

Dengan variabel json_claims berisi objek JSON dalam bentuk:

{
  "sub" : "[e-mail]",
  "iss" : "urn://[e-mail]",
  "non-registered-claim" : {
    "This-is-a-thing" : 817,
    "https://example.com/foobar" : { "p": 42, "q": false }
  }
}

JWT yang dihasilkan menyertakan semua klaim dalam objek JSON.

Perhatikan perilaku berikut sehubungan dengan penggunaan referensi variabel dan nilai klaim eksplisit di elemen Claim:

Apigee tidak akan membuat klaim dalam kondisi berikut:

• jika referensi variabel ada, tetapi tidak terselesaikan, dan
• jika Anda tidak menentukan nilai eksplisit (nilai default), dan
• jika atribut kebijakan IgnoreUnresolvedVariables adalah true.

Jika IgnoreUnresolvedVariables adalah false, Apigee akan menampilkan error dalam kondisi di atas.

Apigee akan membuat klaim dalam kondisi berikut:

• jika referensi variabel ada, tetapi belum terselesaikan, dan
• jika Anda menentukan nilai eksplisit (nilai default), dan
• jika IgnoreUnresolvedVariables adalah true atau false

<AdditionalHeaders/Claim>

<AdditionalHeaders>
    <Claim name='claim1'>explicit-value-of-claim-here</Claim>
    <Claim name='claim2' ref='variable-name-here'/>
    <Claim name='claim3' ref='variable-name-here' type='boolean'/>
    <Claim name='claim4' ref='variable-name' type='string' array='true'/>
 </AdditionalHeaders>

Menempatkan pasangan nama/nilai klaim tambahan di header untuk JWT.

Elemen <Claim> mendukung fitur penggantian string dinamis yang disebut template pesan saat type=map.

Default	T/A
Kehadiran	Opsional
Nilai yang valid	Nilai apa pun yang ingin Anda gunakan untuk klaim tambahan. Anda dapat menentukan klaim secara eksplisit sebagai string, angka, boolean, peta, atau array.

Elemen <Claim> menggunakan atribut berikut:

• name - (Wajib) Nama klaim.
  Catatan: Jangan gunakan nama klaim terdaftar apa pun dalam elemen ini. Klaim terdaftar ditentukan dalam RFC7519. Ini mencakup: "iss", "sub", "aud", "iat", "exp", "nbf", dan "jti".
• ref - (Opsional) Nama variabel alur. Jika ada, kebijakan akan menggunakan nilai variabel ini sebagai klaim. Jika atribut ref dan nilai klaim eksplisit ditentukan, nilai eksplisit adalah default, dan digunakan jika variabel alur yang dirujuk tidak terselesaikan.
• type - (Opsional) Salah satu dari: string (default), angka, boolean, atau peta
• array - (Opsional) Tetapkan ke true untuk menunjukkan apakah nilainya adalah array jenis. Default: false.

<Compress>

<Compress>true</Compress>

Menentukan apakah teks dikompresi sebelum dienkripsi. Elemen ini hanya valid saat membuat JWT terenkripsi.

<CriticalHeaders>

<CriticalHeaders>a,b,c</CriticalHeaders>

or:

<CriticalHeaders ref=’variable_containing_headers’/>

Menambahkan header penting, crit, ke header JWT. Header crit adalah array nama header yang harus diketahui dan dikenali oleh penerima JWT. Contoh:

{
  "typ": "...",
  "alg" : "...",
  "crit" : [ "a", "b", "c" ],
}

Menurut spesifikasi, pihak yang memverifikasi harus memeriksa header crit dan memverifikasi bahwa setiap header tersebut dipahami. Misalnya, kebijakan VerifyJWT memeriksa header crit. Untuk setiap item yang tercantum di header crit, kebijakan ini akan memeriksa apakah elemen <KnownHeaders> kebijakan VerifyJWT juga mencantumkan header tersebut. Setiap header yang ditemukan kebijakan VerifyJWT di crit yang juga tidak tercantum di <KnownHeaders> akan menyebabkan kebijakan VerifyJWT gagal.

Catatan: <CriticalHeaders> sebenarnya tidak menambahkan header ke JWT. Ini hanya menentukan konten header crit. Anda dapat menggunakan <AdditionalHeader/Claims> untuk menambahkan header.

Default	T/A
Kehadiran	Opsional
Jenis	Array string yang dipisahkan koma
Nilai yang valid	Array atau nama variabel yang berisi array.

<CustomClaims>

Catatan: Saat ini, elemen CustomClaims disisipkan saat Anda menambahkan kebijakan GenerateJWT baru melalui UI. Elemen ini tidak berfungsi dan diabaikan. Elemen yang benar untuk digunakan adalah <AdditionalClaims>. UI akan diperbarui untuk menyisipkan elemen yang benar di lain waktu.

<DirectKey>

<DirectKey>
  <Id>A12345</Id>
  <Value encoding="base16|hex|base64|base64url" ref="private.directkey"/>
</DirectKey>

Menentukan kunci langsung untuk mengenkripsi JWT jika algoritma enkripsinya adalah dir ("enkripsi langsung").

Elemen turunan dari <DirectKey>

Tabel berikut memberikan deskripsi tingkat tinggi tentang elemen turunan <DirectKey>:

Elemen Turunan	Wajib?	Deskripsi
ID	Opsional	ID kunci
Nilai	Wajib	Tentukan referensi ke variabel dengan atribut ref. Isi variabel yang dirujuk harus berupa encoding string dari array byte, yang dienkode melalui salah satu dari hex (base16), base64, atau base64url.

Dengan enkripsi kunci langsung, Anda dapat langsung menyediakan serangkaian byte yang akan bertindak sebagai kunci enkripsi konten (CEK). Anda harus menentukan array byte sebagai string yang dienkode. Panjang array byte yang diperlukan bergantung pada kekuatan algoritma enkripsi konten yang dipilih. Misalnya, untuk A256CBC-HS512, Anda harus memberikan kunci yang berukuran tepat 512 bit, atau 64 byte.

Isi variabel private.directkey harus berupa string yang dienkode, baik melalui hex (base16), base64, atau base64url. Misalnya, berikut adalah kunci 32 byte yang dienkode hex:

96 4b e1 71 15 71 5f 87 11 0e 13 52 4c ec 1e ba df 47 62 1a 9d 3b f5 ad d2 7b b2 35 e7 d6 17 11

Untuk encoding hex, spasi kosong diterima, tetapi tidak diperlukan, dan huruf besar atau kecil diterima (B7 sama dengan b7).

Setara dengan yang dienkode base64url di atas adalah:

lkvhcRVxX4cRDhNSTOweut9HYhqdO/Wt0nuyNefWFxE

Untuk varian base64*, spasi kosong tidak diterima, dan huruf besar/kecil penting. Jika Anda tidak menentukan encoding, kebijakan akan menganggap encoding tersebut adalah base64.

Berikut ini penjelasan tentang panjang kunci yang diperlukan:

Algoritma Enkripsi Konten	Persyaratan panjang kunci
A128CBC-HS256	256 bit (32 byte)
A192CBC-HS384	384 (48)
A256CBC-HS512	512 (64)
A128GCM	128 (16)
A192GCM	192 (24)
A256GCM	256 (32)

Catatan: Kunci enkripsi konten yang diberikan melalui elemen <DirectKey> harus memiliki panjang yang tepat untuk algoritma enkripsi konten yang ditentukan. Untuk algoritma enkripsi kunci selain dir, kebijakan akan menghasilkan CEK acak dengan panjang yang tepat, tetapi untuk dir, konfigurasi harus menyediakan kunci dengan ukuran yang tepat secara eksplisit.

<ExpiresIn>

<ExpiresIn>time-value-here</ExpiresIn>

or:

<ExpiresIn ref='time-value-here'/>

Menentukan masa berlaku JWT dalam milidetik, detik, menit, jam, atau hari. Tentukan masa berlaku menggunakan elemen XML atau atribut ref, tetapi tidak keduanya.

Catatan: Ini adalah rentang waktu, bukan nilai waktu absolut. Kuantitas dapat berupa nilai numerik sederhana, yang dalam hal ini ditafsirkan sebagai milidetik.

Default	N/A
Kehadiran	Opsional
Jenis	Bilangan bulat
Nilai yang valid	Nilai atau referensi ke variabel alur yang berisi nilai. Satuan waktu dapat ditentukan sebagai berikut: ms = milidetik (default) s = detik m = menit h = jam d = hari Misalnya, ExpiresIn=10d setara dengan ExpiresIn sebesar 864000 detik.

<Id>

<Id>explicit-jti-value-here</Id>
 -or-
<Id ref='variable-name-here'/>
 -or-
<Id/>

Membuat JWT dengan klaim jti tertentu. Jika nilai teks dan atribut ref kosong, kebijakan akan menghasilkan jti yang berisi UUID acak. Klaim ID JWT (jti) adalah ID unik untuk JWT. Untuk mengetahui informasi selengkapnya tentang jti, lihat RFC7519.

Default	T/A
Kehadiran	Opsional
Jenis	String, atau referensi.
Nilai yang valid	String atau nama variabel alur yang berisi ID.

<IgnoreUnresolvedVariables>

<IgnoreUnresolvedVariables>true|false</IgnoreUnresolvedVariables>

Tetapkan ke salah (false) jika Anda ingin kebijakan menampilkan error saat variabel yang dirujuk yang ditentukan dalam kebijakan tidak dapat di-resolve. Tetapkan ke benar (true) untuk memperlakukan variabel yang tidak dapat di-resolve sebagai string kosong (null).

Default	Salah
Kehadiran	Opsional
Jenis	Boolean
Nilai yang valid	benar atau salah

<Issuer>

<Issuer ref='variable-name-here'/>
<Issuer>issuer-string-here</Issuer>

Kebijakan ini menghasilkan JWT yang berisi klaim dengan nama iss, dengan nilai yang ditetapkan ke nilai yang ditentukan. Klaim yang mengidentifikasi penerbit JWT. Ini adalah salah satu kumpulan klaim terdaftar yang disebutkan dalam RFC7519.

Default	T/A
Kehadiran	Opsional
Jenis	String, atau referensi
Nilai yang valid	Semua

<NotBefore>

<!-- Specify an absolute time. -->
<NotBefore>2017-08-14T11:00:21-07:00</NotBefore>
 -or-
<!-- Specify a time relative to when the token is generated. -->
<NotBefore>6h</NotBefore>

Menentukan waktu saat token menjadi valid. Token tidak valid hingga waktu yang ditentukan. Anda dapat menentukan nilai waktu absolut, atau waktu yang relatif terhadap saat token dibuat.

Default	T/A
Kehadiran	Opsional
Jenis	String
Nilai yang valid	Lihat di bawah.

Nilai waktu yang valid untuk elemen NotBefore untuk nilai waktu absolut

Nama	Format	Contoh
sortable	yyyy-MM-dd'T'HH:mm:ss.SSSZ	2017-08-14T11:00:21.269-0700
RFC 1123	EEE, dd MMM yyyy HH:mm:ss zzz	Sen, 14 Agustus 2017 11.00.21 PDT
RFC 850	EEEE, dd-MMM-yy HH:mm:ss zzz	Senin, 14-Agustus-17 11.00.21 PDT
ANCI-C	EEE MMM d HH:mm:ss yyyy	Sen 14 Agu 11.00.21 2017

Untuk nilai waktu relatif, tentukan bilangan bulat dan jangka waktu, misalnya:

• 10 dtk
• 60m
• 12 j

<OutputVariable>

<OutputVariable>jwt-variable</OutputVariable>

Menentukan tempat untuk menempatkan JWT yang dihasilkan oleh kebijakan ini. Secara default, nilai ini ditempatkan ke dalam variabel alur jwt.POLICYNAME.generated_jwt.

Default	jwt.POLICYNAME.generated_jwt
Kehadiran	Opsional
Jenis	String (nama variabel alur)

<PasswordKey>

<PasswordKey>
  <Id>abcdefg</Id>
  <Value ref="private.password"/>
  <SaltLength>8</SaltLength>
  <PBKDF2Iterations>10000</PBKDF2>
</PasswordKey>

Menentukan kunci untuk mengenkripsi JWT jika algoritma enkripsinya adalah salah satu dari berikut:

• PBES2-HS256+A128KW
• PBES2-HS384+A192KW
• PBES2-HS512+A256KW

Untuk setiap algoritma kunci ini, Anda harus memberikan sandi yang menjadi asal kunci enkripsi kunci, melalui variabel private.password di elemen <Value ref="private.password"/>.

Elemen turunan dari <PasswordKey>

Tabel berikut memberikan deskripsi tingkat tinggi tentang elemen turunan <PasswordKey>:

Elemen Turunan	Kehadiran	Deskripsi
ID	Opsional	ID kunci
Nilai	Wajib	Menentukan sandi yang digunakan untuk membuat kunci enkripsi kunci. Gunakan atribut ref dan tentukan variabel, seperti private.password .
SaltLength	Opsional	Panjang garam. Default: 8 byte.
PBKDF2Iterations	Opsional	Jumlah iterasi PBKDF2: Default: 10.000.

<PrivateKey>

<PrivateKey>
  <Id ref="privatekey-id"/>
  <Value ref="private.pem-encoded-privatekey"/>
  <Password ref="private.privatekey-password"/>
</PrivateKey>

Menentukan kunci pribadi yang akan digunakan saat membuat JWT yang ditandatangani, dan Algorithm adalah varian RSA atau elliptic curve (EC) - salah satu dari RS256/RS384/RS512, PS256/PS384/PS512, atau ES256/ES384/ES512.

Elemen turunan dari <PrivateKey>

Tabel berikut memberikan deskripsi elemen turunan <PrivateKey>:

Elemen Turunan	Kehadiran	Deskripsi
ID	Opsional	ID kunci. Nilainya dapat berupa string apa pun. Anda dapat menentukan nilai sebagai nilai teks literal, atau secara tidak langsung, melalui referensi variabel, dengan atribut ref. Kebijakan ini akan menyertakan ID kunci ini sebagai klaim kid di header JWT yang dihasilkan.
Nilai	Wajib	Kunci pribadi yang dienkode PEM. Menentukan kunci pribadi yang digunakan untuk menandatangani payload. Gunakan atribut ref dan tentukan variabel, seperti private.private-key . Jika elemen <Algorithm> menyimpan varian RSA, salah satu dari RS256/RS384/RS512 atau PS256/PS384/PS512, Anda harus menyediakan kunci pribadi RSA yang dienkode. Jika elemen <Algorithm> menyimpan varian EC, salah satu dari ES256/ES384/ES512, Anda harus memberikan kunci pribadi Kurva Elips untuk kurva yang sesuai.
Sandi	Opsional	Sandi yang harus digunakan kebijakan untuk mendekripsi kunci pribadi, jika diperlukan. Gunakan atribut ref untuk meneruskan sandi melalui variabel flow. Catatan: Anda harus menentukan variabel alur. Apigee akan menolak konfigurasi kebijakan yang tidak valid, dengan sandi yang ditentukan dalam teks biasa. Variabel alur harus memiliki awalan "private". Misalnya, private.mypassword

<PublicKey>

<PublicKey>
  <!-- specify exactly one of the following -->
  <Value ref="variable-containing-encoded-publickey"/>
  <Value>PEM encoded public key</Value>
  <Certificate ref="variable-containing-encoded-x509-certificate"/>
  <Certificate>PEM encoded X509 certificate</Certificate>
  <JWKS>jwks-content</JWKS>
  <JWKS ref="variable-containing-jwks-content"/>
  <JWKS uri="variable-containing-jwks-content"/>
  <JWKS uriRef="variable-containing-uri"/>
</PublicKey>

Menentukan kunci publik yang akan digunakan saat membuat JWT terenkripsi, dan algoritma Key adalah varian RSA atau kurva elips (EC) - RSA-OAEP-256, ECDH-ES, ECDH-ES+A128KW, ECDH-ES+A192KW, atau ECDH-ES+A256KW.

Elemen turunan dari <PublicKey>

Berikan salah satu dari Value, Certificate, atau JWKS. Jika menentukan JWKS, Anda juga harus menentukan Id. Tabel berikut memberikan deskripsi elemen turunan <PublicKey> ini:

Elemen Turunan	Deskripsi
Nilai	Kunci publik yang dienkode dengan PEM. Menentukan kunci publik yang harus digunakan kebijakan untuk mengenkripsi kunci enkripsi konten. Anda dapat menentukan kunci secara harfiah, atau secara tidak langsung melalui referensi variabel. <PublicKey> <Value ref="public.publickey"/> </PublicKey> atau <PublicKey> <Value> -----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAw2kPrRzcufvUNHvTH/WW 2F73IyN....your key will vary....1jC0dwUD1lHV8MfUyRXmpmnNxJHACof C5TBtXMORc+us7A2cTtC4gZV256bT4h3sIEMsDl0Joz9K9MPzVPFxa1i0RgNt06n ZmkDb/DRW5onclGzxQITBFP3S6JXd4LNESJcTp705ec1cQ9Wp2Kl+nKrKyv1E5Xx DQIDAQAB -----END PUBLIC KEY----- </Value> </PublicKey> Kunci publik yang dienkode harus menunjukkan kunci RSA jika Anda menggunakan algoritma RSA-OAEP-256, atau kunci EC dari kurva yang sesuai jika Anda menggunakan algoritma EC.
Sertifikat	Sertifikat X.509 yang dienkode PEM, yang menggabungkan kunci publik. Apigee akan mengekstrak kunci publik dari sertifikat, lalu menggunakan kunci tersebut untuk mengenkripsi kunci enkripsi konten. Anda dapat menentukan sertifikat secara harfiah, atau secara tidak langsung melalui referensi variabel. <PublicKey> <Certificate ref="public.pem-encoded-certificate"/> </PublicKey> atau <PublicKey> <Certificate> -----BEGIN CERTIFICATE----- MIIDqDCCApACCQCG/xVb7Yzw3zANBgkqhkiG9w0BAQUFADCBlTELMAkGA1UEBhMC 2F73IyN....your certificate data will vary....1jC0dwUD1lHV8MfUyR VQQKDAZHb29nbGUxDzANBgNVBAsMBkFwaWdlZTEaMBgGA1UEAwwRYXBpZ2VlLmdv ... YjBaZuNUDVLGvbTSRgWG5lwm85Jar2zeCBcxFDwqyZFvVNV9SfoWF/LgVVpK54n8 rknZ17USb0ob51ckxPTENmF2DUHBzgptiw10Yw== -----END CERTIFICATE----- </Certificate> </PublicKey> Kunci publik yang dienkode harus menunjukkan kunci RSA jika Anda menggunakan algoritma RSA-OAEP-256, atau kunci EC dari kurva yang sesuai jika Anda menggunakan algoritma EC. Catatan: Apigee tidak memvalidasi tanggal validitas pada sertifikat yang Anda berikan, dan Apigee juga tidak memvalidasi rantai kepercayaan pada sertifikat. Apigee memperlakukan semua sertifikat yang Anda tentukan dengan elemen ini sebagai valid dan tepercaya.
JWKS	Sumber kunci publik JWKS. Ini akan menjadi daftar kunci yang mengikuti format yang dijelaskan dalam IETF RFC 7517 - JSON Web Key (JWK). Anda dapat menentukan JWKS dengan salah satu dari empat cara berikut: secara harfiah, sebagai nilai teks: <PublicKey> <JWKS>jwks-content-here</JWKS> <Id ref="variable-containing-a-kid">literal-value-here</Id> </PublicKey> secara tidak langsung, dengan atribut ref, menentukan variabel flow: <PublicKey> <JWKS ref="variable-containing-jwks-content"/> <Id ref="variable-containing-a-kid">literal-value-here</Id> </PublicKey> Variabel yang direferensikan harus berisi string yang mewakili JWKS. secara tidak langsung melalui URI statis, dengan atribut uri: <PublicKey> <JWKS uri="uri-that-returns-a-jwks"/> <Id ref="variable-containing-a-kid">literal-value-here</Id> </PublicKey> secara tidak langsung melalui URI yang ditentukan secara dinamis, dengan atribut uriRef: <PublicKey> <JWKS uriRef="variable-containing-a-uri-that-returns-a-jwks"/> <Id ref="variable-containing-a-kid">literal-value-here</Id> </PublicKey> Dalam semua kasus, saat menentukan elemen JWKS dalam GenerateJWT untuk membuat JWT terenkripsi, Anda juga harus menentukan elemen PublicKey/Id. <PublicKey> <JWKS uri="uri-that-returns-a-jwks"/> <Id ref="variable-containing-a-kid">literal-value-here</Id> </PublicKey>
ID	String yang mewakili ID kunci. Saat runtime, Apigee mengambil kunci dari JWKS yang memiliki kolom kid yang cocok dengan nilai ini. Elemen Id diperlukan jika Anda menggunakan elemen JWKS dalam GenerateJWT.

<SecretKey>

<SecretKey encoding="base16|hex|base64|base64url" >
 <Id ref="variable-containing-key-id-here">secret-key-id</Id>
 <Value ref="private.variable-here"/>
</SecretKey>

Elemen SecretKey bersifat opsional. Ini menentukan kunci rahasia yang akan digunakan saat membuat JWT yang ditandatangani yang menggunakan algoritma simetris (HS*) atau saat membuat JWT terenkripsi yang menggunakan algoritma simetris (AES) untuk enkripsi kunci.

Anak-anak <SecretKey>

Tabel berikut memberikan deskripsi elemen turunan dan atribut <SecretKey>:

Anak	Kehadiran	Deskripsi
encoding (atribut)	Opsional	Menentukan cara kunci dienkode dalam variabel yang dirujuk. Secara default, jika tidak ada encoding, encoding kunci akan diperlakukan sebagai UTF-8. Nilai yang valid untuk atribut ini adalah: hex, base16, base64, atau base64url. Nilai encoding hex dan base16 adalah sinonim. <SecretKey encoding="VALUE_HERE" > <Id ref="variable-containing-key-id-here">secret-key-id</Id> <Value ref="private.secretkey"/> </SecretKey> Pada contoh di atas, jika atribut encoding adalah hex, dan konten variabel private.secretkey adalah 494c6f766541504973, kunci akan didekode sebagai kumpulan 9 byte, yang dalam heksadesimal akan menjadi 49 4c 6f 76 65 41 50 49 73. Sebaliknya, jika atribut encoding adalah base64, dan konten variabel private.secretkey adalah VGhpcy1pcy1hLXNlY3JldA, kunci akan didekode sebagai kumpulan 16 byte, dalam heksadesimal: 54 68 69 73 2d 69 73 2d 61 2d 73 65 63 72 65 74. Catatan: Apigee menerapkan kekuatan kunci minimum. Lihat dokumentasi untuk elemen Value guna mengetahui detailnya.
ID (elemen)	Opsional	ID kunci. Nilainya dapat berupa string apa pun. Anda dapat menentukan nilai sebagai nilai teks literal, atau secara tidak langsung, melalui referensi variabel, dengan atribut ref. <SecretKey> <Id ref="flow-variable-name-here"/> <Value ref="private.variable-here"/> </SecretKey> or <SecretKey> <Id>your-id-value-here</Id> <Value ref="private.variable-here"/> </SecretKey> Kebijakan ini akan menyertakan ID kunci ini sebagai klaim kid di header JWT yang dihasilkan.
Nilai (elemen)	Wajib	Kunci rahasia yang dienkode. Menentukan kunci rahasia yang digunakan untuk menandatangani payload. Gunakan atribut ref untuk memberikan kunci secara tidak langsung melalui variabel, seperti private.secret-key . <SecretKey> <Id ref="flow-variable-name-here"/> <Value ref="private.my-secret-variable"/> </SecretKey> Catatan: Nama variabel harus menyertakan awalan private seperti yang ditunjukkan pada contoh di atas. Apigee menerapkan kekuatan kunci minimum untuk algoritma HS256/HS384/HS512. Panjang kunci minimum untuk HS256 adalah 32 byte, untuk HS384 adalah 48 byte, dan untuk HS512 adalah 64 byte. Menggunakan kunci dengan kekuatan yang lebih rendah akan menyebabkan error runtime.

<Subject>

<Subject>subject-string-here</Subject>

atau

<Subject ref="flow_variable" />

Contoh:

<Subject ref="apigee.developer.email"/>

Kebijakan ini menghasilkan JWT yang berisi klaim sub, yang ditetapkan ke nilai yang ditentukan.Klaim ini mengidentifikasi atau membuat pernyataan tentang subjek JWT. Ini adalah salah satu kumpulan klaim standar yang disebutkan dalam IETF RFC 7519.

Default	T/A
Kehadiran	Opsional
Jenis	String
Nilai yang valid	Nilai apa pun yang mengidentifikasi subjek atau variabel alur secara unik yang merujuk ke nilai.

<Type>

<Type>type-string-here</Type>

Menjelaskan apakah kebijakan menghasilkan JWT yang ditandatangani atau JWT terenkripsi. Elemen <Type> bersifat opsional. Anda dapat menggunakannya untuk memberi tahu pembaca tentang konfigurasi apakah kebijakan menghasilkan JWT yang ditandatangani atau dienkripsi.

• Jika elemen <Type> ada:
  • Jika nilai <Type> adalah Signed, kebijakan akan menghasilkan JWT yang ditandatangani, dan elemen <Algorithm> harus ada.
  • Jika nilai <Type> adalah Encrypted, kebijakan akan menghasilkan JWT terenkripsi, dan elemen <Algorithms> harus ada.
• Jika elemen <Type> tidak ada:
  • Jika elemen <Algorithm> ada, kebijakan akan menganggap <Type> adalah Signed.
  • Jika elemen <Algorithms> ada, kebijakan akan mengasumsikan <Type> adalah Encrypted.
• Jika <Algorithm> atau <Algorithms> tidak ada, konfigurasi tidak valid.

Default	T/A
Kehadiran	Opsional
Jenis	String
Nilai yang valid	Signed atau Encrypted

Variabel alur

Kebijakan Buat JWT tidak menetapkan variabel alur.

Referensi error

Bagian ini menjelaskan kode error dan pesan error yang ditampilkan serta variabel error yang ditetapkan oleh Apigee saat kebijakan ini memicu error. Informasi ini penting untuk diketahui jika Anda mengembangkan aturan error untuk menangani error. Untuk mempelajari lebih lanjut, lihat Yang perlu Anda ketahui tentang error kebijakan dan Menangani error.

Error runtime

Error ini dapat terjadi saat kebijakan dieksekusi.

Kode kerusakan	Status HTTP	Terjadi saat
steps.jwt.AlgorithmInTokenNotPresentInConfiguration	401	Terjadi saat kebijakan verifikasi memiliki beberapa algoritma.
steps.jwt.AlgorithmMismatch	401	Algoritma yang ditentukan dalam kebijakan Buat tidak cocok dengan algoritma yang diharapkan dalam kebijakan Verifikasi. Algoritma yang ditentukan harus cocok.
steps.jwt.EncryptionFailed	401	Pembuatan JWT terenkripsi gagal karena alasan yang tidak spesifik
steps.jwt.FailedToDecode	401	Kebijakan tidak dapat mendekode JWT. JWT mungkin rusak.
steps.jwt.GenerationFailed	401	Kebijakan tidak dapat membuat JWT.
steps.jwt.InsufficientKeyLength	401	Untuk kunci kurang dari 32 byte untuk algoritma HS256, kurang dari 48 byte untuk algoritma HS386, dan kurang dari 64 byte untuk algoritma HS512.
steps.jwt.InvalidClaim	401	Untuk klaim yang tidak ada atau ketidakcocokan klaim, atau header yang tidak ada atau ketidakcocokan header.
steps.jwt.InvalidConfiguration	401	Elemen <Algorithm> dan <Algorithms> ada.
steps.jwt.InvalidCurve	401	Kurva yang ditentukan oleh kunci tidak valid untuk algoritma Elliptic Curve.
steps.jwt.InvalidJsonFormat	401	JSON tidak valid ditemukan di header atau payload.
steps.jwt.InvalidPasswordKey	401	Kunci yang ditentukan tidak memenuhi persyaratan.
steps.jwt.InvalidPrivateKey	401	Kunci yang ditentukan tidak memenuhi persyaratan.
steps.jwt.InvalidPublicKey	401	Kunci yang ditentukan tidak memenuhi persyaratan.
steps.jwt.InvalidSecretKey	401	Kunci yang ditentukan tidak memenuhi persyaratan.
steps.jwt.InvalidToken	401	Error ini terjadi saat verifikasi tanda tangan JWT gagal.
steps.jwt.JwtAudienceMismatch	401	Klaim audiens gagal dalam verifikasi token.
steps.jwt.JwtIssuerMismatch	401	Klaim penerbit gagal dalam verifikasi token.
steps.jwt.JwtSubjectMismatch	401	Klaim subjek gagal dalam verifikasi token.
steps.jwt.KeyIdMissing	401	Kebijakan Verifikasi menggunakan JWKS sebagai sumber untuk kunci publik, tetapi JWT yang ditandatangani tidak menyertakan properti kid di header.
steps.jwt.KeyParsingFailed	401	Kunci publik tidak dapat diuraikan dari informasi kunci yang diberikan.
steps.jwt.NoAlgorithmFoundInHeader	401	Terjadi saat JWT tidak berisi header algoritma.
steps.jwt.NoMatchingPublicKey	401	Kebijakan Verifikasi menggunakan JWKS sebagai sumber untuk kunci publik, tetapi kid dalam JWT yang ditandatangani tidak tercantum dalam JWKS.
steps.jwt.SigningFailed	401	Di GenerateJWT, untuk kunci yang kurang dari ukuran minimum untuk algoritma HS384 atau HS512
steps.jwt.TokenExpired	401	Kebijakan ini mencoba memverifikasi token yang sudah tidak berlaku.
steps.jwt.TokenNotYetValid	401	Token belum valid.
steps.jwt.UnhandledCriticalHeader	401	Header yang ditemukan oleh kebijakan Verifikasi JWT di header crit tidak tercantum dalam KnownHeaders.
steps.jwt.UnknownException	401	Terjadi pengecualian yang tidak diketahui.
steps.jwt.WrongKeyType	401	Jenis kunci yang ditentukan salah. Misalnya, jika Anda menentukan kunci RSA untuk algoritma Elliptic Curve, atau kunci kurva untuk algoritma RSA.

Error saat deployment

Error ini dapat terjadi saat Anda men-deploy proxy yang berisi kebijakan ini.

Tips: Perlu bantuan untuk mengatasi error? Klik di kolom Perbaiki untuk mendapatkan informasi pemecahan masalah mendetail.

Nama error	Penyebab	Perbaiki
InvalidNameForAdditionalClaim	Deployment akan gagal jika klaim yang digunakan di elemen turunan <Claim> dari elemen <AdditionalClaims> adalah salah satu nama terdaftar berikut: kid, iss, sub, aud, iat, exp, nbf, atau jti.
InvalidTypeForAdditionalClaim	Jika klaim yang digunakan dalam elemen turunan <Claim> dari elemen <AdditionalClaims> bukan dari jenis string, number, boolean, atau map, deployment akan gagal.
MissingNameForAdditionalClaim	Jika nama klaim tidak ditentukan dalam elemen turunan <Claim> dari elemen <AdditionalClaims>, deployment akan gagal.
InvalidNameForAdditionalHeader	Error ini terjadi saat nama klaim yang digunakan dalam elemen turunan <Claim> dari elemen <AdditionalClaims> adalah alg atau typ.
InvalidTypeForAdditionalHeader	Jika jenis klaim yang digunakan dalam elemen turunan <Claim> dari elemen <AdditionalClaims> bukan dari jenis string, number, boolean, atau map, deployment akan gagal.
InvalidValueOfArrayAttribute	Error ini terjadi jika nilai atribut array di elemen turunan <Claim> dari elemen <AdditionalClaims> tidak ditetapkan ke true atau false.
InvalidConfigurationForActionAndAlgorithm	Jika elemen <PrivateKey> digunakan dengan algoritma Keluarga HS atau elemen <SecretKey> digunakan dengan algoritma Keluarga RSA, deployment akan gagal.
InvalidValueForElement	Jika nilai yang ditentukan dalam elemen <Algorithm> bukan nilai yang didukung, deployment akan gagal.
MissingConfigurationElement	Error ini akan terjadi jika elemen <PrivateKey> tidak digunakan dengan algoritma keluarga RSA atau elemen <SecretKey> tidak digunakan dengan algoritma Keluarga HS.
InvalidKeyConfiguration	Jika elemen turunan <Value> tidak ditentukan dalam elemen <PrivateKey> atau <SecretKey>, deployment akan gagal.
EmptyElementForKeyConfiguration	Jika atribut ref dari elemen turunan <Value> dari elemen <PrivateKey> atau <SecretKey> kosong atau tidak ditentukan, deployment akan gagal.
InvalidVariableNameForSecret	Error ini terjadi jika nama variabel flow yang ditentukan dalam atribut ref elemen turunan <Value> dari elemen <PrivateKey> atau <SecretKey> tidak berisi awalan pribadi (private.).
InvalidSecretInConfig	Error ini terjadi jika elemen turunan <Value> dari elemen <PrivateKey> atau <SecretKey> tidak berisi awalan pribadi (private.).
InvalidTimeFormat	Jika nilai yang ditentukan dalam elemen <NotBefore> tidak menggunakan format yang didukung, deployment akan gagal.

Variabel error

Variabel ini ditetapkan saat error runtime terjadi. Untuk mengetahui informasi selengkapnya, lihat Yang perlu Anda ketahui tentang error kebijakan.

Variabel	Dari mana	Contoh
fault.name="fault_name"	fault_name adalah nama error, seperti yang tercantum dalam tabel Runtime errors di atas. Nama error adalah bagian terakhir dari kode error.	fault.name Matches "InvalidToken"
JWT.failed	Semua kebijakan JWT menetapkan variabel yang sama jika terjadi kegagalan.	JWT.failed = true

Contoh respons error

Untuk penanganan error, praktik terbaiknya adalah menangkap bagian errorcode dari respons error. Jangan mengandalkan teks di faultstring, karena teks tersebut dapat berubah.

Contoh aturan error

    <FaultRules>
        <FaultRule name="JWT Policy Errors">
            <Step>
                <Name>JavaScript-1</Name>
                <Condition>(fault.name Matches "InvalidToken")</Condition>
            </Step>
            <Condition>JWT.failed=true</Condition>
        </FaultRule>
    </FaultRules>