FetchOAuthAuthenticationToken - Identity as a Service - Alibaba Cloud Documentation Center

Mengambil token otentikasi OAuth yang valid.

Deskripsi operasi

API ini mengotentikasi dan mengotorisasi permintaan berdasarkan Token Akses yang diterbitkan oleh IDaaS.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Sintaks permintaan

POST /v2/{instanceId}/authenticationTokens/_/actions/fetchOAuthAccessToken HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	ID instans.	idaas_ue2jvisn35ea5lmthk267xxxxx.

Parameter permintaan

Parameter	Type	Required	Description	Example
Authorization	string	Yes	Informasi otentikasi. Format: Bearer ${access_token}.	Bearer xxxxxx.
body	object	No	Badan permintaan.	{'key': 'value'}
credentialProviderIdentifier	string	Yes	Pengenal penyedia kredensial.	test_example_identifier.
scope	string	No	Cakupan (dalam OAuth) yang sesuai dengan protokol OAuth.	example:test_01 example:test_02
forceAuthentication	boolean	No	Apakah akan mengabaikan token valid yang ada dan memaksa otorisasi ulang. Nilai default: false.	false.
customParameters	object	No	Pasangan kunci-nilai kustom yang ditambahkan ke URL otorisasi OAuth untuk meneruskan parameter tambahan yang didukung oleh penyedia OAuth.
	string	No	Parameter tambahan yang didukung oleh penyedia OAuth.	access_type=offline.

Elemen respons

Element	Type	Description	Example
	object	Detail token otentikasi OAuth.
instanceId	string	ID instans.	idaas_ue2jvisn35ea5lmthk267xxxxx.
authenticationTokenId	string	ID token otentikasi.	atntkn_01kqflm0sxxx8nmdc1cb5dskxxxxx.
credentialProviderId	string	ID penyedia kredensial.	atp_01kr2cmj5gxxx4fvmls2e93dxxxxx.
createTime	integer	Waktu pembuatan token otentikasi. Nilai ini adalah stempel waktu UNIX dalam milidetik.	1649830225000
updateTime	integer	Waktu pembaruan token otentikasi. Nilai ini adalah stempel waktu UNIX dalam milidetik.	1649830225000
authenticationTokenType	string	Tipe token otentikasi. Valid values: oauth_access_token : oauth_access_token.	oauth_access_token.
revoked	boolean	Apakah token otentikasi telah dicabut.	false.
creatorType	string	Tipe pembuat token otentikasi. Valid values: application : aplikasi.	application
creatorId	string	ID pembuat token otentikasi.	app_ngtkgrrxxxxktg5eao6z4xxxxx.
consumerType	string	Tipe konsumen token otentikasi. Valid values: application : aplikasi. custom : custom.	application
consumerId	string	ID konsumen token otentikasi.	app_ngtkgrrxxxxktg5eao6z4xxxxx.
expirationTime	integer	Waktu kedaluwarsa token otentikasi. Nilai ini adalah stempel waktu UNIX dalam milidetik.	1772693568000
oauthAccessTokenContent	object	Konten token otentikasi tipe Token Akses OAuth.
accessTokenValue	string	Bidang access_token dalam tanggapan titik akhir token protokol OAuth.	DgEBAGP2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.
tokenType	string	Bidang token_type dalam tanggapan titik akhir token protokol OAuth.	Bearer.
scope	string	Bidang scope dalam tanggapan titik akhir token protokol OAuth.	example:test_01 example:test_02
oauthAuthorizationSession	object	Sesi otorisasi alur user_federation OAuth. Dikembalikan saat otorisasi pertama kali atau ketika interaksi pengguna diperlukan.
sessionId	string	ID sesi otorisasi.	atpoas_01l6losojlojbbv01adsq56xxxxx.
authorizationUrl	string	URL otorisasi pengguna.	https://login.dingtalk.com/oauth2/auth?client_id=...
sessionUri	string	URI sesi otorisasi.	urn:ietf:params:oauth:request_uri:atpoas_01l6ljnvrpc5niakl3gj3amxxxxxx.
sessionStatus	string	Status sesi otorisasi. Valid values: pending : pending.	pending.

Contoh

Respons sukses

JSONformat

{
  "instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx.",
  "authenticationTokenId": "atntkn_01kqflm0sxxx8nmdc1cb5dskxxxxx.",
  "credentialProviderId": "atp_01kr2cmj5gxxx4fvmls2e93dxxxxx.",
  "createTime": 1649830225000,
  "updateTime": 1649830225000,
  "authenticationTokenType": "oauth_access_token.",
  "revoked": true,
  "creatorType": "application",
  "creatorId": "app_ngtkgrrxxxxktg5eao6z4xxxxx.",
  "consumerType": "application",
  "consumerId": "app_ngtkgrrxxxxktg5eao6z4xxxxx.",
  "expirationTime": 1772693568000,
  "oauthAccessTokenContent": {
    "accessTokenValue": "DgEBAGP2xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx.",
    "tokenType": "Bearer.",
    "scope": "example:test_01 example:test_02"
  },
  "oauthAuthorizationSession": {
    "sessionId": "atpoas_yyy.",
    "authorizationUrl": "https://auth.example.com.",
    "sessionUri": "urn:ietf:params:oauth:request_uri:atpoas_yyy.",
    "sessionStatus": "pending."
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.