Test building an authentication URL

This endpoint is used to simulate the process of building an authentication URL for a specific App Integration. It helps validate that the configured authentication settings (e.g., OAuth2 parameters, redirect URIs, scopes) generate a correct and functional URL for initiating the authentication flow.

Use this endpoint to verify the integration setup before enabling real authentication with third-party services.

Test building an authentication URL

post

Path parameters

appIntegrationIdstringRequired

The app integration id.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

clientIdstring · min: 1Required

The client email of the app integration. This value is used for OAuth2 methods. For example, for Google OAuth2, this value is the email of the service account.

redirectURIstring · min: 1Required

The redirect URI of the app integration. After the user logs in, the user is redirected to this URI. This value is must be mapping with the application configuration on the OAuth2 provider.

scopestring · min: 1Required

The scope of the app integration.

statestring · nullableOptional

The state of the app integration.

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

datastring · nullableRead-onlyOptional

This is the data to be returned to the client.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/app-integrations/{appIntegrationId}/authentication/test

HTTPcURLJavaScriptPython

POST /api/v1/app-integrations/{appIntegrationId}/authentication/test HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "clientId": "text",
  "redirectURI": "text",
  "scope": "text",
  "state": "text"
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": "AUTH_URL_APP_INTEGRATION",
  "errors": []
}