O Auth Tokens - Get O Auth Connection Link

서비스:

Azure Data Manager for Agriculture

API 버전:

2023-11-01-preview

OAuth 흐름에 필요한 연결 링크를 반환합니다.

POST {endpoint}/oauth/tokens/:connect?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 버전

요청 헤더

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

요청 본문

Name	필수	형식	Description
oAuthProviderId	True	string	OAuthProvider의 ID입니다.
partyId	True	string	파티의 ID입니다.
userRedirectLink	True	string	oauth 흐름이 끝날 때 사용자를 리디렉션하는 링크입니다.
userRedirectState		string	oauth 흐름이 끝날 때 사용자를 리디렉션할 때 다시 제공할 상태입니다.

응답

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

보안

Authorization

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

형식: apiKey
In(다음 안에): header

예제

OAuthTokens_GetOAuthConnectionLink

샘플 요청

HTTP

POST {endpoint}/oauth/tokens/:connect?api-version=2023-11-01-preview

{
  "partyId": "PARTY123",
  "oAuthProviderId": "JOHNDEERE",
  "userRedirectLink": "https://docs.microsoft.com",
  "userRedirectState": "code"
}

샘플 응답

상태 코드:

200

"Connection string"

정의

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 .
OAuthConnectRequest	OAuth 구성 쿼리 매개 변수를 가져옵니다.

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 .

OAuthConnectRequest

OAuth 구성 쿼리 매개 변수를 가져옵니다.

Name	형식	Description
oAuthProviderId	string	OAuthProvider의 ID입니다.
partyId	string	파티의 ID입니다.
userRedirectLink	string	oauth 흐름이 끝날 때 사용자를 리디렉션하는 링크입니다.
userRedirectState	string	oauth 흐름이 끝날 때 사용자를 리디렉션할 때 다시 제공할 상태입니다.