O Auth Tokens - Get O Auth Connection Link

Returns Connection link needed in the OAuth flow.

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

URI Parameters

Name In Required Type Description
endpoint
path True

string

uri

The host name of the namespace, e.g. admaInstanceName.farmbeats.azure.net

api-version
query True

string

The requested API version

Request Header

Name Required Type Description
Authorization True

string

Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.

Request Body

Name Required Type Description
oAuthProviderId True

string

Id of the OAuthProvider.

partyId True

string

Id of the party.

userRedirectLink True

string

Link to redirect the user to, at the end of the oauth flow.

userRedirectState

string

State to provide back when redirecting the user, at the end of the oauth flow.

Responses

Name Type Description
200 OK

string

Success

Other Status Codes

ErrorResponse

Error

Headers

x-ms-error-code: string

Security

Authorization

Please provide a valid bearer token for authorized API calls. Note that you might need to clear your browser cache if you tried un-authenticated calls before.

Type: apiKey
In: header

Examples

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"

Definitions

Name Description
Error

An error from the Azure AgPlatform service.

ErrorResponse

An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.

InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

OAuthConnectRequest

Get OAuth config query parameters.

Error

An error from the Azure AgPlatform service.

Name Type Description
code

string

Server-defined set of error codes.

details

Error[]

Array of details about specific errors that led to this reported error.

innererror

InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

message

string

Human-readable representation of the error.

target

string

Target of the error.

ErrorResponse

An error response from the Azure AgPlatform service. See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses for ErrorResponse reference document.

Name Type Description
error

Error

An error from the Azure AgPlatform service.

traceId

string

Unique trace Id.

InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

Name Type Description
code

string

Specific error code than was provided by the containing error.

innererror

InnerError

Inner error containing list of errors.See https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object for InnerError reference document.

OAuthConnectRequest

Get OAuth config query parameters.

Name Type Description
oAuthProviderId

string

Id of the OAuthProvider.

partyId

string

Id of the party.

userRedirectLink

string

Link to redirect the user to, at the end of the oauth flow.

userRedirectState

string

State to provide back when redirecting the user, at the end of the oauth flow.