Gets an app integration authentication

Gets the app integration authentication by the given id.

get
Path parameters
idstringRequired

The id of the app integration authentication.

Header parameters
Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL
Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY
Responses
200
The request was successful.
application/json
get
GET /api/v1/app-integrations/authentication/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*
{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "appIntegration": {
      "type": "PaymentGateway",
      "name": "Stripe",
      "domain": "https://stripe.com",
      "description": "Stripe payment gateway",
      "logoURL": null,
      "status": "Active",
      "id": "sApKpllz4sAplsmzha"
    },
    "isDefault": false,
    "status": "Active",
    "description": "description",
    "tags": "tags",
    "iconURL": "iconUrl",
    "tokenEndpoint": "tokenEndpoint",
    "id": "sApKpllz4sAplsmzha",
    "authEndpoint": "authEndpoint",
    "redirectURI": "redirectUri",
    "clientSecret": "clientSecret",
    "clientId": "clientId",
    "projectId": "projectId",
    "name": "name",
    "code": "code",
    "scope": "scope"
  },
  "errors": []
}

Last updated

Was this helpful?