11# Provider Registration Guide
22
3+ > ** Note:** All examples in this guide use the default local development URLs from ` docker compose up ` :
4+ > - ** Gateway:** ` http://localhost:8090 `
5+ > - ** Broker:** ` http://localhost:8080 `
6+ >
7+ > In production, substitute your own deployed URLs (e.g., ` https://nexus-gateway.example.com ` ).
8+
39## 1. Core Concepts
410
511### What is a Provider?
@@ -28,7 +34,7 @@ Before touching Nexus, you must create an "App" in the Provider's Developer Port
28341 . ** Create App:** Look for "OAuth Apps", "Integrations", or "API Credentials".
29352 . ** Configure Redirect URI:**
3036 * This is CRITICAL. It must match exactly.
31- * ** Value:** ` https ://nexus-broker.bravesea-3f5f7e75.eastus.azurecontainerapps.io /auth/callback`
37+ * ** Value:** ` http ://localhost:8080 /auth/callback`
32383 . ** Compliance Fields:**
3339 * Most providers will strictly limit your app (making it "Development Mode" only) until you fill these out:
3440 * ** App Name:** ` Nexus `
@@ -45,7 +51,7 @@ Before touching Nexus, you must create an "App" in the Provider's Developer Port
4551Use this template to register the provider in Nexus.
4652
4753``` bash
48- GATEWAY_URL=" https ://nexus-gateway.bravesea-3f5f7e75.eastus.azurecontainerapps.io "
54+ GATEWAY_URL=" http ://localhost:8090 "
4955
5056jq -n ' {
5157 profile: {
@@ -77,7 +83,7 @@ curl -s -X POST "$GATEWAY_URL/v1/request-connection" \
7783 "user_id": "test-user-001",
7884 "provider_name": "[provider-slug]",
7985 "scopes": ["scope1", "scope2"],
80- "return_url": "https ://nexus-frontend-staging.bravesea-3f5f7e75.eastus.azurecontainerapps.io/app-launcher/connected-apps/all-connected-apps/ "
86+ "return_url": "http ://localhost:3000/callback "
8187 # ^ Client App URL. httpbin.org is used to visualize the success params.
8288 }' | jq .
8389```
@@ -93,7 +99,7 @@ These providers do not require a Console App. You define a **Schema** for the fo
9399* Single token field.*
94100
95101``` bash
96- GATEWAY_URL=" https ://nexus-gateway.bravesea-3f5f7e75.eastus.azurecontainerapps.io "
102+ GATEWAY_URL=" http ://localhost:8090 "
97103
98104jq -n ' {
99105 profile: {
@@ -118,7 +124,7 @@ jq -n '{
118124* Username and Password.*
119125
120126``` bash
121- GATEWAY_URL=" https ://nexus-gateway.bravesea-3f5f7e75.eastus.azurecontainerapps.io "
127+ GATEWAY_URL=" http ://localhost:8090 "
122128
123129jq -n ' {
124130 profile: {
@@ -144,7 +150,7 @@ jq -n '{
144150* AWS Access Key & Secret Key.*
145151
146152``` bash
147- GATEWAY_URL=" https ://nexus-gateway.bravesea-3f5f7e75.eastus.azurecontainerapps.io "
153+ GATEWAY_URL=" http ://localhost:8090 "
148154
149155jq -n ' {
150156 profile: {
@@ -172,7 +178,7 @@ jq -n '{
172178* API Key injected into URL query string.*
173179
174180``` bash
175- GATEWAY_URL=" https ://nexus-gateway.bravesea-3f5f7e75.eastus.azurecontainerapps.io "
181+ GATEWAY_URL=" http ://localhost:8090 "
176182
177183jq -n ' {
178184 profile: {
@@ -198,7 +204,7 @@ jq -n '{
198204* Request signing with a secret.*
199205
200206``` bash
201- GATEWAY_URL=" https ://nexus-gateway.bravesea-3f5f7e75.eastus.azurecontainerapps.io "
207+ GATEWAY_URL=" http ://localhost:8090 "
202208
203209jq -n ' {
204210 profile: {
@@ -237,15 +243,15 @@ Non-OAuth providers do not use a browser redirect. You must verify them via API.
237243 -d '{
238244 "user_id": "test-user-123",
239245 "provider_id": "'$PROVIDER_ID'",
240- "return_url": "https ://nexus-frontend-staging.bravesea-3f5f7e75.eastus.azurecontainerapps.io/app-launcher/connected-apps/all-connected-apps/ "
246+ "return_url": "http ://localhost:3000/callback "
241247 }' | jq -r .authUrl)
242248 ```
243249
2442502. **Submit Credentials (`/auth/capture-credential`):**
245251 Extract `state` from the URL and submit the API Key.
246252 *Note: This request hits the Broker directly as defined in the `authUrl`.*
247253 ```bash
248- BROKER_URL="https ://nexus-broker.bravesea-3f5f7e75.eastus.azurecontainerapps.io "
254+ BROKER_URL="http ://localhost:8080 "
249255 STATE=$(echo "$AUTH_URL" | grep -o 'state=[^&]*' | cut -d= -f2)
250256
251257 curl -v -X POST "$BROKER_URL/auth/capture-credential" \
@@ -275,7 +281,7 @@ curl -s "$GATEWAY_URL/v1/providers" | jq -r '.. | .["[slug]"]? | .id // empty' |
275281** 2. Update Command (Rotate Secret):**
276282``` bash
277283PROVIDER_ID=" <provider-uuid>"
278- GATEWAY_URL=" https ://nexus-gateway.bravesea-3f5f7e75.eastus.azurecontainerapps.io "
284+ GATEWAY_URL=" http ://localhost:8090 "
279285
280286curl -s -X PATCH " $GATEWAY_URL /v1/providers/$PROVIDER_ID " \
281287 -H " Content-Type: application/json" \
0 commit comments