O Auth Tokens - List

サービス:

Azure Data Manager for Agriculture

API バージョン:

2023-11-01-preview

OAuthToken ドキュメントの一覧を返します。

GET {endpoint}/oauth/tokens?api-version=2023-11-01-preview

省略可能なパラメーターを含む:

GET {endpoint}/oauth/tokens?authProviderIds={authProviderIds}&partyIds={partyIds}&isValid={isValid}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&api-version=2023-11-01-preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string uri	名前空間のホスト名 (例: admaInstanceName.farmbeats.azure.net)
api-version	query	True	string	要求された API バージョン
authProviderIds	query		string[]	AuthProvider の名前。
isValid	query		boolean	トークン オブジェクトが有効な場合。
maxCreatedDateTime	query		string date-time	リソースの最大作成日 (含む)。
maxLastModifiedDateTime	query		string date-time	リソースの最終更新日の最大値 (含む)。
maxPageSize	query		integer int32	必要な項目の最大数 (含む)。 Minimum = 10、Maximum = 1000、既定値 = 50。
minCreatedDateTime	query		string date-time	リソースの最小作成日 (含む)。
minLastModifiedDateTime	query		string date-time	リソースの最終更新日の最小値 (含む)。
partyIds	query		string[]	パーティの一覧。
skipToken	query		string	次の結果セットを取得するためのトークンをスキップします。

要求ヘッダー

名前	必須	型	説明
Authorization	True	string	承認された API 呼び出しに有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザーのキャッシュをクリアする必要がある場合があることに注意してください。

応答

名前	型	説明
200 OK	OAuthTokenListResponse	Success
Other Status Codes	ErrorResponse	エラー ヘッダー x-ms-error-code: string

セキュリティ

Authorization

承認された API 呼び出しに有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザーのキャッシュをクリアする必要がある場合があることに注意してください。

型: apiKey
/: header

例

OAuthTokens_List

要求のサンプル

HTTP

GET {endpoint}/oauth/tokens?api-version=2023-11-01-preview

応答のサンプル

状態コード:

200

{
  "value": [
    {
      "partyId": "PARTY123",
      "authProviderId": "JOHNDEERE",
      "isValid": true,
      "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e",
      "createdDateTime": "2021-04-22T18:49:25Z",
      "modifiedDateTime": "2021-04-22T18:49:25Z"
    }
  ],
  "skipToken": "string",
  "nextLink": "https://{{resourceName}}.farmbeats.azure.net/parties/{{partyId}}/seasonalFields/{{seasonalFieldId}}?api-version={{apiVersion}}&skipToken=%5b%7b%22token%22%3a%22%2bRID%3a%7e23TRC%3a10%23ISA%3d%22%2c%22range%22%3a%7b%22min%22%3a%22%22%2c%22max%22%3a%22FF%22%7d%7d%5d"
}

定義

名前	説明
Error	Azure AgPlatform サービスからのエラー。
ErrorResponse	Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンス ドキュメントを参照してください https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。
InnerError	エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。
OAuthToken	OAuth トークン リソースのスキーマ。
OAuthTokenListResponse	ページ応答には、要求されたオブジェクトの一覧と、次の結果セットを取得するための URL リンクが含まれています。

Error

Azure AgPlatform サービスからのエラー。

名前	型	説明
code	string	サーバー定義のエラー コードのセット。
details	Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	InnerError	エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。
message	string	人が判読できるエラーの表現。
target	string	エラーのターゲット。

ErrorResponse

Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンス ドキュメントを参照してください https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses 。

名前	型	説明
error	Error	Azure AgPlatform サービスからのエラー。
traceId	string	一意のトレース ID。

InnerError

エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。

名前	型	説明
code	string	含まれているエラーによって提供されたエラーコードより具体的なエラー コード。
innererror	InnerError	エラーの一覧を含む内部エラー。InnerError のリファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。

OAuthToken

OAuth トークン リソースのスキーマ。

名前	型	規定値	説明
authProviderId	string		アプリ情報を含む OAuth プロバイダー リソースの ID。
createdDateTime	string		リソースが作成された日時 (サンプル形式: yyyy-MM-ddTHH:mm:ssZ)。
eTag	string		オプティミスティック コンカレンシーを実装する ETag 値。
isValid	boolean	True	トークンが有効か期限切れかを示す省略可能なフラグ (既定値: true)。
modifiedDateTime	string		リソースが最後に変更された日時 (サンプル形式: yyyy-MM-ddTHH:mm:ssZ)。
partyId	string		この OAuth 構成のパーティ ID。

OAuthTokenListResponse

ページ応答には、要求されたオブジェクトの一覧と、次の結果セットを取得するための URL リンクが含まれています。

名前	型	説明
nextLink	string	一覧にある結果の次のページへの継続リンク (絶対 URI)
skipToken	string	次のページの取得に使用されるトークン。 null の場合、追加のページはありません。
value	OAuthToken[]	要求されたオブジェクトの一覧。