O Auth Tokens - Get O Auth Connection Link
Retourneert verbindingskoppeling die nodig is in de OAuth-stroom.
POST {endpoint}/oauth/tokens/:connect?api-version=2023-11-01-preview
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string uri |
De hostnaam van de naamruimte, bijvoorbeeld admaInstanceName.farmbeats.azure.net |
api-version
|
query | True |
string |
De aangevraagde API-versie |
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
Authorization | True |
string |
Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u mogelijk uw browsercache moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd. |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
oAuthProviderId | True |
string |
Id van de OAuthProvider. |
partyId | True |
string |
Id van de partij. |
userRedirectLink | True |
string |
Koppeling om de gebruiker om te leiden naar, aan het einde van de oauth-stroom. |
userRedirectState |
string |
Status die moet worden opgegeven bij het omleiden van de gebruiker, aan het einde van de oauth-stroom. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
string |
Geslaagd |
Other Status Codes |
Fout Kopteksten x-ms-error-code: string |
Beveiliging
Authorization
Geef een geldig Bearer-token op voor geautoriseerde API-aanroepen. Houd er rekening mee dat u mogelijk uw browsercache moet wissen als u eerder niet-geverifieerde aanroepen hebt geprobeerd.
Type:
apiKey
In:
header
Voorbeelden
OAuthTokens_GetOAuthConnectionLink
Voorbeeldaanvraag
POST {endpoint}/oauth/tokens/:connect?api-version=2023-11-01-preview
{
"partyId": "PARTY123",
"oAuthProviderId": "JOHNDEERE",
"userRedirectLink": "https://docs.microsoft.com",
"userRedirectState": "code"
}
Voorbeeldrespons
"Connection string"
Definities
Name | Description |
---|---|
Error |
Een fout van de Azure AgPlatform-service. |
Error |
Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse. |
Inner |
Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object het referentiedocument innerError voor meer informatie. |
OAuth |
OAuth-configuratiequeryparameters ophalen. |
Error
Een fout van de Azure AgPlatform-service.
Name | Type | Description |
---|---|---|
code |
string |
Door de server gedefinieerde set foutcodes. |
details |
Error[] |
Matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid. |
innererror |
Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object het referentiedocument innerError voor meer informatie. |
|
message |
string |
Door mensen leesbare weergave van de fout. |
target |
string |
Doel van de fout. |
ErrorResponse
Een foutreactie van de Azure AgPlatform-service. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses voor het referentiedocument ErrorResponse.
Name | Type | Description |
---|---|---|
error |
Een fout van de Azure AgPlatform-service. |
|
traceId |
string |
Unieke tracerings-id. |
InnerError
Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object het referentiedocument innerError voor meer informatie.
Name | Type | Description |
---|---|---|
code |
string |
Specifieke foutcode dan is opgegeven door de betreffende fout. |
innererror |
Interne fout met een lijst met fouten. Zie https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object het referentiedocument innerError voor meer informatie. |
OAuthConnectRequest
OAuth-configuratiequeryparameters ophalen.
Name | Type | Description |
---|---|---|
oAuthProviderId |
string |
Id van de OAuthProvider. |
partyId |
string |
Id van de partij. |
userRedirectLink |
string |
Koppeling om de gebruiker om te leiden naar, aan het einde van de oauth-stroom. |
userRedirectState |
string |
Status die moet worden opgegeven bij het omleiden van de gebruiker, aan het einde van de oauth-stroom. |