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 매개 변수

Name	In(다음 안에)	필수	형식	Description
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	필요한 최대 항목 수(포함)입니다. 최소 = 10, 최대 = 1000, 기본값 = 50.
minCreatedDateTime	query		string date-time	리소스의 최소 생성 날짜(포함)입니다.
minLastModifiedDateTime	query		string date-time	리소스의 최소 마지막으로 수정한 날짜(포함)입니다.
partyIds	query		string[]	파티 목록입니다.
skipToken	query		string	다음 결과 집합을 가져오기 위한 토큰을 건너뜁니다.

요청 헤더

Name	필수	형식	Description
Authorization	True	string	권한 있는 API 호출에 유효한 전달자 토큰을 제공하세요. 이전에 인증되지 않은 호출을 시도한 경우 브라우저 캐시를 지워야 할 수 있습니다.

응답

Name	형식	Description
200 OK	OAuthTokenListResponse	성공
Other Status Codes	ErrorResponse	오류 헤더 x-ms-error-code: string

Name

형식

Description

200 OK

OAuthTokenListResponse

성공

Other Status Codes

ErrorResponse

오류

헤더

x-ms-error-code: string

보안

Authorization

권한 있는 API 호출에 유효한 전달자 토큰을 제공하세요. 이전에 인증되지 않은 호출을 시도한 경우 브라우저 캐시를 지워야 할 수 있습니다.

형식: apiKey
In(다음 안에): 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"
}

정의

Name	Description
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 서비스의 오류입니다.

Name	형식	Description
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 .

Name	형식	Description
error	Error	Azure AgPlatform 서비스의 오류입니다.
traceId	string	고유 추적 ID입니다.

InnerError

오류 목록을 포함하는 내부 오류입니다. InnerError 참조 문서는 를 참조하세요 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .

Name	형식	Description
code	string	포함된 오류에서 제공한 것보다 구체적인 오류 코드입니다.
innererror	InnerError	오류 목록을 포함하는 내부 오류입니다. InnerError 참조 문서는 를 참조하세요 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object .

OAuthToken

OAuth 토큰 리소스의 스키마입니다.

Name	형식	Default value	Description
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 링크가 포함됩니다.

Name	형식	Description
nextLink	string	목록에서 결과의 다음 페이지에 대한 연속 링크(절대 URI)입니다.
skipToken	string	다음 페이지를 검색하는 데 사용되는 토큰입니다. null이면 추가 페이지가 없습니다.
value	OAuthToken[]	요청된 개체 목록입니다.

다음을 통해 공유

O Auth Tokens - List

URI 매개 변수

요청 헤더

응답

보안

Authorization

예제

OAuthTokens_List

샘플 요청

샘플 응답

정의

Error

ErrorResponse

InnerError

OAuthToken

OAuthTokenListResponse

추가 리소스