Remove authentication configuration

PATCH/fhir-provider/{fhir_provider_id}/remove-auth-config

Removes an authentication configuration from a FHIR provider. Cannot remove the currently active auth configuration.

Note: Sandbox providers cannot be modified.

RequiresBearerauthentication

Path parameters

fhir_provider_idstringrequired

ID of the FHIR provider

Body parameters

auth_config_idstringrequired

ID of the auth configuration to remove

Returns

Auth configuration removed successfully

Response fields

successbooleanoptional

messagestringoptional

dataobjectoptional

Full FHIR provider configuration returned for non-sandbox providers. auth_configs and last_updated are always populated, which is how list responses distinguish this shape from FhirProviderSandboxInfo.

idstringrequired

Unique identifier for the FHIR provider

namestringrequired

Display name for the FHIR provider

descriptionstringoptional

Optional description of the FHIR provider

providerstringrequired

Type of FHIR server provider.

The "sandbox" provider type is managed internally and cannot be created via API. It is used on shared instances.

aidboxathenahealthcanvascernerelationepicgoogle_healthcarehapimeditechmedplumphenostoresandbox

base_urlstring (uri)optional

Base URL of the FHIR server

client_idstringoptional

OAuth client ID. Deprecated: use client_id on FhirProviderAuthConfig instead. Retained for backward compatibility with existing providers.

auth_configsobjectrequired

Map of authentication configurations (key is auth_config_id)

last_updatedstring (date-time)required

Timestamp when the provider was last updated

PATCHRequest

# Get authentication token
PHENOML_TOKEN=$(curl -X POST "https://experiment.app.pheno.ml/v2/auth/token" \
  -u "$PHENOML_CLIENT_ID:$PHENOML_CLIENT_SECRET" \
  | jq -r '.access_token')

curl -X PATCH "https://experiment.app.pheno.ml/fhir-provider/{fhir_provider_id}/remove-auth-config" \
  -H "Authorization: Bearer $PHENOML_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "auth_config_id": "auth-config-456"
}'

200 OKExample Response

{
  "success": true,
  "message": "Fhir provider auth config deleted successfully",
  "data": {
    "id": "1716d214-de93-43a4-aa6b-a878d864e2ad",
    "name": "Epic Sandbox",
    "description": "Epic sandbox environment for testing",
    "provider": "epic",
    "base_url": "https://fhir.epic.com/interconnect-fhir-oauth/api/FHIR/R4",
    "auth_configs": {
      "auth-config-123": {
        "auth_config_id": "auth-config-123",
        "auth_method": "jwt",
        "is_active_auth_config": true,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z",
        "scopes": "system/Patient.read system/Observation.read",
        "client_id": "your-client-id"
      }
    },
    "last_updated": "2024-02-20T11:30:00Z"
  }
}