O Auth Providers - Create Or Update

サービス:

Azure Data Manager for Agriculture

API バージョン:

2023-11-01-preview

oauthProvider リソースを作成または更新します。

PATCH {endpoint}/oauth/providers/{oauthProviderId}?api-version=2023-11-01-preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string uri	名前空間のホスト名 (例: admaInstanceName.farmbeats.azure.net)
oauthProviderId	path	True	string	oauthProvider リソースの ID。
api-version	query	True	string	要求された API バージョン

要求ヘッダー

Media Types: "application/merge-patch+json"

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

要求本文

Media Types: "application/merge-patch+json"

名前	型	説明
apiKey	string	特定のプロバイダーの OAuth Api キー。 注: 現在、気候プロバイダーに適用されます。 応答で送信されません。
appId	string	指定された OAuth プロバイダーの OAuth アプリ ID。
appSecret	string	特定のプロバイダーの OAuth アプリ シークレット。 注: 応答では送信されません。
description	string	リソースの説明テキスト。
isProductionApp	boolean	プロバイダー側の運用シナリオでアプリを使用する準備ができているかどうかを判断するための省略可能なフラグ。 (既定値: false)注: 現在、JohnDeere に適用されます。
name	string	リソースを識別する名前
properties		リソースに属するキー値ペアのコレクション。 各ペアは、50 文字を超えるキーを持つ必要があり、150 文字を超える値を持つ必要があります。 注: リソースには最大 25 個のキー値ペアを指定でき、文字列、数字、datetime (yyyy-MM-ddTHH:mm:ssZ) の値のみがサポートされます。

応答

名前	型	説明
200 OK	OAuthProvider	Success
201 Created	OAuthProvider	作成済み
Other Status Codes	ErrorResponse	エラー ヘッダー x-ms-error-code: string

セキュリティ

Authorization

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

型: apiKey
/: header

例

OAuthProviders_CreateOrUpdate

要求のサンプル

HTTP

PATCH {endpoint}/oauth/providers/JOHNDEERE?api-version=2023-11-01-preview

{
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  }
}

応答のサンプル

状態コード:

200

{
  "id": "JOHNDEERE",
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  },
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "createdDateTime": "2021-04-23T11:31:10Z",
  "modifiedDateTime": "2021-04-23T11:31:10Z"
}

状態コード:

201

{
  "id": "JOHNDEERE",
  "appId": "appId",
  "appSecret": "appSecret",
  "apiKey": "apiKey",
  "isProductionApp": false,
  "name": "JOHNDEERE",
  "description": "some description",
  "properties": {
    "orgId": "ORG123"
  },
  "eTag": "0f8fad5b-d9cb-469f-a165-70867728950e",
  "createdDateTime": "2021-04-23T11:31:10Z",
  "modifiedDateTime": "2021-04-23T11:31:10Z"
}

定義

名前	説明
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 してください。
OAuthProvider	OAuth プロバイダー リソースのスキーマ。

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 してください。

OAuthProvider

OAuth プロバイダー リソースのスキーマ。

名前	型	規定値	説明
apiKey	string		特定のプロバイダーの OAuth Api キー。 注: 現在、気候プロバイダーに適用されます。 応答で送信されません。
appId	string		指定された OAuth プロバイダーの OAuth アプリ ID。
appSecret	string		特定のプロバイダーの OAuth アプリ シークレット。 注: 応答では送信されません。
createdBy	string		ユーザー/テナント ID によって作成されます。
createdDateTime	string		リソースが作成された日時 (サンプル形式: yyyy-MM-ddTHH:mm:ssZ)。
description	string		リソースの説明テキスト。
eTag	string		オプティミスティック コンカレンシーを実装する ETag 値。
id	string		一意の OAuth プロバイダー ID。
isProductionApp	boolean	False	プロバイダー側の運用シナリオでアプリを使用する準備ができているかどうかを判断するための省略可能なフラグ。 (既定値: false)注: 現在、JohnDeere に適用されます。
modifiedBy	string		ユーザー/テナント ID によって変更されました。
modifiedDateTime	string		リソースが最後に変更された日時 (サンプル形式: yyyy-MM-ddTHH:mm:ssZ)。
name	string		リソースを識別する名前
properties			リソースに属するキー値ペアのコレクション。 各ペアは、50 文字を超えるキーを持つ必要があり、150 文字を超える値を持つ必要があります。 注: リソースには最大 25 個のキー値ペアを指定でき、文字列、数字、datetime (yyyy-MM-ddTHH:mm:ssZ) の値のみがサポートされます。