Set active authentication configuration

PATCH/fhir-provider/{fhir_provider_id}/set-active-auth-config

Sets which authentication configuration should be active for a FHIR provider. Only one auth config can be active at a time.

If the specified auth config is already active, the request succeeds without making any changes and returns a message indicating the config is already active.

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 set as active

Returns

Active auth configuration set successfully, or the config was already active. Check the message field to determine which case occurred.

Response fields

successbooleanoptional

messagestringoptional

dataoneOfoptional

Provider details. Sandbox providers return FhirProviderSandboxInfo.

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}/set-active-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 set as active 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": false,
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-02-20T11:00:00Z",
        "scopes": "system/Patient.read system/Observation.read",
        "client_id": "your-client-id"
      },
      "auth-config-456": {
        "auth_config_id": "auth-config-456",
        "auth_method": "client_secret",
        "is_active_auth_config": true,
        "created_at": "2024-02-20T09:00:00Z",
        "updated_at": "2024-02-20T11:00:00Z",
        "scopes": "system/Patient.read",
        "client_id": "your-other-client-id"
      }
    },
    "last_updated": "2024-02-20T11:00:00Z"
  }
}