getOrgOAuthAppAuthorizationUrl

GET https://{{host}}/api/v1/orgs/:org_id/setting/:app_name/link_accounts

Parameters

NameTypeDescription
org_idstringRequired, Organisation id
app_namestringRequired, OAuth application name (Example : zoom, teams, intune, vmware, jamf)
forward_urlstringRequired, Mist portal url to which backend needs to redirect after succesful OAuth authorization

Response Definitions

NameTypeDescription
linkedbooleanOAuth application linked status, is mist portal authorized with the OAuth application
authorization_urlstringOAuth application authorization url
accountslistList of linked apps(zoom/teams/intune/vmware) account details

Request Params

KeyDatatypeRequiredDescription
forwardnull

RESPONSES

status: OK

{"linked":true,"accounts":[{"account_id":"KkEM7orQSIWHZNFzwMLuRA","last_sync":1665465339000,"last_status":"success","linked_by":"Testname1","company":"Test Compay1 Ltd","max_daily_api_requests":1500},{"account_id":"kojzWgIJQ0ujR73VvydOdg","last_sync":1665465346000,"last_status":"failed","linked_by":"Testname2","company":"Test Compay2 Ltd","error":"OAuth token refresh failed, please re-link your account","errors":["OAuth token refresh failed, please re-link your account","API daily rate limit reached for your account"],"max_daily_api_requests":null},{"account_id":"iojzXIJWEuiD73ZvydOfg","last_sync":"failed","last_status":1665465538000,"linked_by":"Testname3","company":"Test Compay3 Ltd","max_daily_api_requests":3500}],"authorization_url":"https://zoom.us/oauth/authorize?response_type=code\u0026client_id=YDyajBmJREjwkyb3TPAbA\u0026redirect_uri=https%3A%2F%2Fapi.local%2Fapi%2Fv1%2Forg%2Fb4e16c72-d50e-4c03-a952-a3217e231e2c%2Foauth2%2Fapp%2Fzoom%2Fcallback\u0026state=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2NDk3NjE0MDQsImZvcndhcmQiOiJodHRwczovL2NsaWVudGZvcndhcmR1cmwuY29tIn0.RIE4XTU5kpF4nKIy7_enJ0PpOCyTTp6DLm9PZsdncpI"}