curl --request POST \
--url https://us.getconvoy.cloud/api/v1/projects/{projectID}/endpoints/oauth2/test \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"oauth2": {
"audience": "<string>",
"authentication_type": "<string>",
"client_id": "<string>",
"client_secret": "<string>",
"expiry_time_unit": "<string>",
"field_mapping": {
"access_token": "<string>",
"expires_in": "<string>",
"token_type": "<string>"
},
"grant_type": "<string>",
"issuer": "<string>",
"scope": "<string>",
"signing_algorithm": "<string>",
"signing_key": {
"crv": "<string>",
"d": "<string>",
"dp": "<string>",
"dq": "<string>",
"e": "<string>",
"kid": "<string>",
"kty": "<string>",
"n": "<string>",
"p": "<string>",
"q": "<string>",
"qi": "<string>",
"x": "<string>",
"y": "<string>"
},
"subject": "<string>",
"url": "<string>"
}
}
'{
"message": "<string>",
"status": true,
"data": {
"access_token": "<string>",
"error": "<string>",
"expires_at": "<string>",
"message": "<string>",
"success": true,
"token_type": "<string>"
}
}This endpoint tests the OAuth2 connection by attempting to exchange a token
curl --request POST \
--url https://us.getconvoy.cloud/api/v1/projects/{projectID}/endpoints/oauth2/test \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"oauth2": {
"audience": "<string>",
"authentication_type": "<string>",
"client_id": "<string>",
"client_secret": "<string>",
"expiry_time_unit": "<string>",
"field_mapping": {
"access_token": "<string>",
"expires_in": "<string>",
"token_type": "<string>"
},
"grant_type": "<string>",
"issuer": "<string>",
"scope": "<string>",
"signing_algorithm": "<string>",
"signing_key": {
"crv": "<string>",
"d": "<string>",
"dp": "<string>",
"dq": "<string>",
"e": "<string>",
"kid": "<string>",
"kty": "<string>",
"n": "<string>",
"p": "<string>",
"q": "<string>",
"qi": "<string>",
"x": "<string>",
"y": "<string>"
},
"subject": "<string>",
"url": "<string>"
}
}
'{
"message": "<string>",
"status": true,
"data": {
"access_token": "<string>",
"error": "<string>",
"expires_at": "<string>",
"message": "<string>",
"success": true,
"token_type": "<string>"
}
}Was this page helpful?