O Auth Providers - List

Odwołanie

Service:: Azure Data Manager for Agriculture

API Version:: 2023-06-01-preview

Zwraca listę z podziałem na strony zasobów oauthProvider.

GET /oauth/providers?api-version=2023-06-01-preview

With optional parameters:

GET /oauth/providers?ids={ids}&names={names}&propertyFilters={propertyFilters}&statuses={statuses}&minCreatedDateTime={minCreatedDateTime}&maxCreatedDateTime={maxCreatedDateTime}&minLastModifiedDateTime={minLastModifiedDateTime}&maxLastModifiedDateTime={maxLastModifiedDateTime}&maxPageSize={maxPageSize}&skipToken={skipToken}&api-version=2023-06-01-preview

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
api-version	query	True	string	Żądana wersja interfejsu API
ids	query		string[]	Identyfikatory zasobu.
maxCreatedDateTime	query		string date-time	Maksymalna data utworzenia zasobu (włącznie).
maxLastModifiedDateTime	query		string date-time	Maksymalna data ostatniej modyfikacji zasobu (włącznie).
maxPageSize	query		integer int32	Maksymalna liczba potrzebnych elementów (włącznie). Minimum = 10, Maksimum = 1000, Wartość domyślna = 50.
minCreatedDateTime	query		string date-time	Minimalna data utworzenia zasobu (włącznie).
minLastModifiedDateTime	query		string date-time	Minimalna data ostatniej modyfikacji zasobu (włącznie).
names	query		string[]	Nazwy zasobu.
propertyFilters	query		string[]	Filtry w parach klucz-wartość w obiekcie Properties. np. "{testKey} eq {testValue}".
skipToken	query		string	Pomiń token pobierania następnego zestawu wyników.
statuses	query		string[]	Stany zasobu.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej próbowano wykonać nieuwierzytelnione wywołania.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	OAuthProviderListResponse	Powodzenie
Other Status Codes	ErrorResponse	Błąd Headers x-ms-error-code: string

Nazwa

Typ

Opis

200 OK

OAuthProviderListResponse

Powodzenie

Other Status Codes

ErrorResponse

Błąd

Headers

x-ms-error-code: string

Zabezpieczenia

Authorization

Podaj prawidłowy token elementu nośnego dla autoryzowanych wywołań interfejsu API. Pamiętaj, że może być konieczne wyczyszczenie pamięci podręcznej przeglądarki, jeśli wcześniej próbowano wykonać nieuwierzytelnione wywołania.

Type: apiKey
In: header

Przykłady

OAuthProviders_List

Sample Request

HTTP

GET /oauth/providers?api-version=2023-06-01-preview

Sample Response

Status code:: 200

{
  "value": [
    {
      "appId": "appId",
      "appSecret": "appSecret",
      "apiKey": "apiKey",
      "isProductionApp": false,
      "id": "JOHNDEERE",
      "eTag": "f8fad5b-d9cb-469f-a165-70867728950e",
      "createdDateTime": "2021-04-22T18:27:37Z",
      "modifiedDateTime": "2021-04-22T18:27:37Z",
      "name": "JD Integration",
      "description": "Oauth Flow",
      "properties": {
        "Party": "123"
      }
    }
  ],
  "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"
}

Definicje

Nazwa	Opis
Error	Błąd usługi Azure AgPlatform.
ErrorResponse	Odpowiedź na błąd z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses dokument referencyjny ErrorResponse.
InnerError	Błąd wewnętrzny zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokumentację dotyczącą błędu wewnętrznego.
OAuthProvider	Schemat zasobu dostawcy OAuth.
OAuthProviderListResponse	Odpowiedź stronicowana zawiera listę żądanych obiektów i link adresu URL w celu uzyskania następnego zestawu wyników.

Error

Błąd usługi Azure AgPlatform.

Nazwa	Typ	Opis
code	string	Zdefiniowany przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerError	Błąd wewnętrzny zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokumentację dotyczącą błędu wewnętrznego.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd z usługi Azure AgPlatform. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses dokument referencyjny ErrorResponse.

Nazwa	Typ	Opis
error	Error	Błąd usługi Azure AgPlatform.
traceId	string	Unikatowy identyfikator śledzenia.

InnerError

Błąd wewnętrzny zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokumentację dotyczącą błędu wewnętrznego.

Nazwa	Typ	Opis
code	string	Określony kod błędu niż został dostarczony przez błąd zawierający.
innererror	InnerError	Błąd wewnętrzny zawierający listę błędów. Zobacz https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object dokumentację dotyczącą błędu wewnętrznego.

OAuthProvider

Schemat zasobu dostawcy OAuth.

Nazwa	Typ	Wartość domyślna	Opis
apiKey	string		Klucz interfejsu API OAuth dla danego dostawcy. Uwaga: obecnie dotyczy dostawcy klimatu. Nie zostanie wysłana w odpowiedzi.
appId	string		Identyfikator aplikacji OAuth dla danego dostawcy OAuth.
appSecret	string		Wpis tajny aplikacji OAuth dla danego dostawcy. Uwaga: nie zostanie wysłana w odpowiedzi.
createdBy	string		Utworzony przez identyfikator użytkownika/dzierżawy.
createdDateTime	string		Data i godzina utworzenia zasobu, format próbki: rrrr-MM-ddTHH:mm:ssZ.
description	string		Tekstowy opis zasobu.
eTag	string		Wartość ETag w celu zaimplementowania optymistycznej współbieżności.
id	string		Unikatowy identyfikator dostawcy OAuth.
isProductionApp	boolean	False	Opcjonalna flaga określająca, czy aplikacja jest gotowa do użycia w scenariuszach produkcyjnych po stronie dostawcy, czy nie. (Wartość domyślna: false) Uwaga: Obecnie dotyczy johnDeere.
modifiedBy	string		Zmodyfikowane przez identyfikator użytkownika/dzierżawy.
modifiedDateTime	string		Data i godzina ostatniej modyfikacji zasobu, format próbki: rrrr-MM-ddTHH:mm:ssZ.
name	string		Nazwa identyfikującego zasób.
properties			Kolekcja par klucz-wartość, która należy do zasobu. Każda para nie może mieć klucza większego niż 50 znaków i nie może mieć wartości większej niż 150 znaków. Uwaga: dla zasobu można podać maksymalnie 25 par wartości klucza, a obsługiwane są tylko wartości ciągu, liczb i daty/godziny (rrrr-MM-ddTHH:mm:ssZ).

OAuthProviderListResponse

Odpowiedź stronicowana zawiera listę żądanych obiektów i link adresu URL w celu uzyskania następnego zestawu wyników.

Nazwa	Typ	Opis
nextLink	string	Link kontynuacji (bezwzględny identyfikator URI) do następnej strony wyników na liście.
skipToken	string	Token używany podczas pobierania następnej strony. Jeśli ma wartość null, nie ma żadnych dodatkowych stron.
value	OAuthProvider[]	Lista żądanych obiektów.

O Auth Providers - List

Parametry identyfikatora URI

Nagłówek żądania

Odpowiedzi

Zabezpieczenia

Authorization

Przykłady

OAuthProviders_List

Sample Request

Sample Response

Definicje

Error

ErrorResponse

InnerError

OAuthProvider

OAuthProviderListResponse

Dodatkowe zasoby