OAuth 権限付与会話の現在のステータスと権限付与結果を照会します。
今すぐお試しください
テスト
RAM 認証
リクエスト構文
POST /v2/{instanceId}/oauthAuthorizationSessions/_/actions/get HTTP/1.1パスパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| instanceId |
string |
必須 |
インスタンスの ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx。 |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Authorization |
string |
必須 |
認証情報。フォーマット: Bearer ${access_token}。 説明
IDaaS が発行したアクセストークンを入力してください。 |
Bearer xxxxxx。 |
| body |
object |
任意 |
リクエストボディ。 |
|
| sessionUri |
string |
必須 |
権限付与会話 URI。 説明
FetchOAuthAuthenticationToken の呼び出しで返されます。 |
urn:ietf:params:oauth:request_uri:atpoas_01l6ljnvrpc5niakl3gj3amxxxxxx |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
OAuth 権限付与会話の詳細。 |
||
| instanceId |
string |
インスタンスの ID。 |
idaas_ue2jvisn35ea5lmthk267xxxxx。 |
| sessionId |
string |
権限付与会話の ID。 |
atpoas_01l6losojlojbbv01adsq56xxxxx。 |
| sessionUri |
string |
権限付与会話 URI。 |
urn:ietf:params:oauth:request_uri:atpoas_01l6ljnvrpc5niakl3gj3amxxxxxx |
| sessionStatus |
string |
権限付与会話のステータス。 列挙値:
|
pending。 |
| credentialProviderIdentifier |
string |
認証情報プロバイダーのビジネス識別子。 |
test_example_identifier。 |
| consumerType |
string |
認証トークンの消費者タイプ。 列挙値:
|
application。 |
| consumerId |
string |
認証トークンの消費者 ID。 |
app_ngtkgrrxxxxktg5eao6z4xxxxx。 |
| creatorType |
string |
認証トークンの作成者タイプ。 列挙値:
|
application。 |
| creatorId |
string |
認証トークンの作成者 ID。 |
app_ngtkgrrxxxxktg5eao6z4xxxxx。 |
| authorizationUrl |
string |
ユーザー権限付与 URL。 |
https://login.dingtalk.com/oauth2/auth?client_id=... |
| expirationTime |
integer |
認証トークンの有効期限時間。ミリ秒単位の UNIX タイムスタンプ。 |
1704153600000 |
| authenticationTokenId |
string |
認証トークンの ID。 |
atntkn_01l6lot7o4e4r77oelp6qtuxxxxx。 |
| errorCode |
string |
エラーコード。 |
access_denied |
| errorDescription |
string |
エラーの説明。 |
ユーザーが権限付与リクエストを拒否しました |
例
成功レスポンス
JSONJSON
{
"instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"sessionId": "atpoas_01l6losojlojbbv01adsq56xxxxx",
"sessionUri": "urn:ietf:params:oauth:request_uri:atpoas_01l6ljnvrpc5niakl3gj3amxxxxxx",
"sessionStatus": "pending",
"credentialProviderIdentifier": "test_example_identifier",
"consumerType": "application",
"consumerId": "app_ngtkgrrxxxxktg5eao6z4xxxxx\n",
"creatorType": "application",
"creatorId": "app_ngtkgrrxxxxktg5eao6z4xxxxx",
"authorizationUrl": "https://login.dingtalk.com/oauth2/auth?client_id=...",
"expirationTime": 1704153600000,
"authenticationTokenId": "atntkn_01l6lot7o4e4r77oelp6qtuxxxxx",
"errorCode": "access_denied",
"errorDescription": "The user denied the authorization request"
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。