Menghasilkan token autentikasi JSON Web Token (JWT).
Deskripsi operasi
API ini melakukan autentikasi dan otorisasi identitas menggunakan Access Token yang dikeluarkan oleh IDaaS.
Pastikan Access Token yang disediakan memiliki otorisasi untuk mengakses fitur "Obtain Authentication Token" dari aplikasi bawaan Privileged Access Management (PAM) di IDaaS.
Scope yang sesuai adalah urn:cloud:idaas:pam|authentication_token:obtain.
Coba sekarang
Test
RAM authorization
Sintaks permintaan
POST /v2/{instanceId}/authenticationTokens/_/actions/generateJwt HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| instanceId |
string |
Yes |
ID Instance. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| Authorization |
string |
Yes |
Informasi autentikasi. Format: Bearer ${access_token}. Catatan
Masukkan Access Token yang dikeluarkan oleh IDaaS. |
Bearer xxxxxx |
| body |
object |
No |
Isi permintaan. |
|
| credentialProviderIdentifier |
string |
Yes |
Identitas penyedia kredensial. |
test_example_identifier |
| issuer |
string |
No |
Bidang `iss` dari JWT. |
https://test.issuer.com |
| subject |
string |
Yes |
Bidang `sub` dari JWT. |
test_jwt_subject |
| audiences |
array |
Yes |
Bidang `aud` dari JWT. |
|
|
string |
No |
Audiens JWT. |
test_jwt_audience |
|
| customClaims |
object |
No |
Klaim kustom. Penting
Pasangan kunci-nilai. Kunci harus berupa string. |
|
|
any |
No |
Pasangan kunci-nilai klaim kustom. |
- |
|
| expiration |
integer |
No |
Periode validitas JWT, dalam detik. |
900 |
| includeDerivedShortToken |
boolean |
No |
Apakah JWT yang dihasilkan perlu menyertakan "derived short token". |
true |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Detail token autentikasi JWT. |
||
| instanceId |
string |
ID Instance. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| authenticationTokenId |
string |
ID token autentikasi. |
atntkn_01kqflm0sxxx8nmdc1cb5dskxxxxx |
| credentialProviderId |
string |
ID penyedia kredensial. |
atp_01kr2cmj5gxxx4fvmls2e93dxxxxx |
| createTime |
integer |
Waktu pembuatan token autentikasi, timestamp UNIX, dalam milidetik. |
1649830225000 |
| updateTime |
integer |
Waktu pembaruan token autentikasi, timestamp UNIX, dalam milidetik. |
1649830225000 |
| authenticationTokenType |
string |
Jenis token autentikasi. Catatan
Nilainya tetap |
jwt |
| revoked |
boolean |
Apakah token autentikasi telah dicabut. |
false |
| creatorType |
string |
Jenis pembuat token autentikasi. Nilai yang valid:
|
application |
| creatorId |
string |
ID pembuat token autentikasi. |
app_ngtkgrrxxxxktg5eao6z4xxxxx |
| consumerType |
string |
Jenis konsumen token autentikasi. Nilai yang valid:
|
custom |
| consumerId |
string |
ID konsumen token autentikasi. |
test_jwt_subject |
| expirationTime |
integer |
Waktu kedaluwarsa token autentikasi, timestamp UNIX, dalam milidetik. |
1772693568000 |
| jwtContent |
object |
Konten token autentikasi JWT. |
|
| jwtValue |
string |
Konten JWT. |
eyJhbGciOixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
| derivedShortToken |
string |
Derived short token dari JWT. |
sk-Nx2vzxxxxxxxxxxxxxxxxx |
Contoh
Respons sukses
JSONformat
{
"instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"authenticationTokenId": "atntkn_01kqflm0sxxx8nmdc1cb5dskxxxxx",
"credentialProviderId": "atp_01kr2cmj5gxxx4fvmls2e93dxxxxx",
"createTime": 1649830225000,
"updateTime": 1649830225000,
"authenticationTokenType": "jwt",
"revoked": false,
"creatorType": "application",
"creatorId": "app_ngtkgrrxxxxktg5eao6z4xxxxx",
"consumerType": "custom",
"consumerId": "test_jwt_subject",
"expirationTime": 1772693568000,
"jwtContent": {
"jwtValue": "eyJhbGciOixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"derivedShortToken": "sk-Nx2vzxxxxxxxxxxxxxxxxx"
}
}
Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.