O Auth Tokens - Get O Auth Connection Link
Returnerar anslutningslänken som behövs i OAuth-flödet.
POST {endpoint}/oauth/tokens/:connect?api-version=2023-11-01-preview
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
Namnområdets värdnamn, t.ex. admaInstanceName.farmbeats.azure.net |
api-version
|
query | True |
string |
Den begärda API-versionen |
Begärandehuvud
Name | Obligatorisk | Typ | Description |
---|---|---|---|
Authorization | True |
string |
Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare. |
Begärandetext
Name | Obligatorisk | Typ | Description |
---|---|---|---|
oAuthProviderId | True |
string |
ID för OAuthProvider. |
partyId | True |
string |
ID för festen. |
userRedirectLink | True |
string |
Länk för att omdirigera användaren till i slutet av oauth-flödet. |
userRedirectState |
string |
Tillstånd som ska anges när användaren omdirigeras i slutet av oauth-flödet. |
Svar
Name | Typ | Description |
---|---|---|
200 OK |
string |
Klart |
Other Status Codes |
Fel Headers x-ms-error-code: string |
Säkerhet
Authorization
Ange en giltig ägartoken för auktoriserade API-anrop. Observera att du kan behöva rensa webbläsarens cacheminne om du har provat oautentiserade anrop tidigare.
Type:
apiKey
In:
header
Exempel
OAuthTokens_GetOAuthConnectionLink
Sample Request
POST {endpoint}/oauth/tokens/:connect?api-version=2023-11-01-preview
{
"partyId": "PARTY123",
"oAuthProviderId": "JOHNDEERE",
"userRedirectLink": "https://docs.microsoft.com",
"userRedirectState": "code"
}
Sample Response
"Connection string"
Definitioner
Name | Description |
---|---|
Error |
Ett fel från Azure AgPlatform-tjänsten. |
Error |
Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokument. |
Inner |
Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError. |
OAuth |
Hämta frågeparametrar för OAuth-konfiguration. |
Error
Ett fel från Azure AgPlatform-tjänsten.
Name | Typ | Description |
---|---|---|
code |
string |
Serverdefinierad uppsättning felkoder. |
details |
Error[] |
Matris med information om specifika fel som ledde till det rapporterade felet. |
innererror |
Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError. |
|
message |
string |
Mänsklig läsbar representation av felet. |
target |
string |
Målet för felet. |
ErrorResponse
Ett felsvar från Azure AgPlatform-tjänsten. Se https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses för ErrorResponse-referensdokument.
Name | Typ | Description |
---|---|---|
error |
Ett fel från Azure AgPlatform-tjänsten. |
|
traceId |
string |
Unikt spårnings-ID. |
InnerError
Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError.
Name | Typ | Description |
---|---|---|
code |
string |
Specifik felkod än vad som angavs av det innehållande felet. |
innererror |
Inre fel som innehåller en lista över fel. Mer information https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object finns i referensdokumentet för InnerError. |
OAuthConnectRequest
Hämta frågeparametrar för OAuth-konfiguration.
Name | Typ | Description |
---|---|---|
oAuthProviderId |
string |
ID för OAuthProvider. |
partyId |
string |
ID för festen. |
userRedirectLink |
string |
Länk för att omdirigera användaren till i slutet av oauth-flödet. |
userRedirectState |
string |
Tillstånd som ska anges när användaren omdirigeras i slutet av oauth-flödet. |