Firebase identity and profile

Use these operations with an already-configured Firebase integration. Read the account settings, sign in to obtain an ID token, then exchange it for Wallkit member context. Verification inspects an ID token. Registration creates or links Wallkit records. Password-reset and email-link requests start separate provider flows. Follow the Firebase identity.

Firebase context

Use this resource’s existing Firebase configuration and public resource key. These actions permit guest ACL access, but each operation’s explicit member and context requirements still apply. Shared credential checks can reject a supplied stale session before the action. Configured provider services must be available; client configuration alone does not prove that.

Keep Firebase custom tokens, Firebase ID tokens and Wallkit session tokens separate. The credential definitions explain their uses. Each request table specifies headers or body transport. Examples are synthetic; see sample runtimes.

Operations

curl -X POST "${WALLKIT_API_BASE}/api/v1/firebase/oauth/token" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "firebase-token: ${FIREBASE_ID_TOKEN}" \
  -H "Content-Type: application/json" \
  --data '{"сreate_wk_user_if_not_exist":false}'

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/firebase/oauth/token", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "POST",
    headers: {
      "resource": process.env.RESOURCE_KEY,
      "firebase-token": process.env.FIREBASE_ID_TOKEN,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({"сreate_wk_user_if_not_exist":false})
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/firebase/oauth/token')
body = {'сreate_wk_user_if_not_exist': False}
request = Request(url, data=json.dumps(body, ensure_ascii=False).encode("utf-8"), headers={'resource': os.environ['RESOURCE_KEY'], 'firebase-token': os.environ['FIREBASE_ID_TOKEN'], "Content-Type": "application/json"}, method='POST')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{
  "token": "EXAMPLE_WALLKIT_SESSION_TOKEN",
  "existed": true
}

{
  "error": "user_resource_not_exist",
  "error_description": "Create user resource relationship forbidden"
}

curl -X POST "${WALLKIT_API_BASE}/api/v1/firebase/sign-in" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "Content-Type: application/json" \
  --data '{"email":"reader@example.com","password":"EXAMPLE_PASSWORD_DO_NOT_USE"}'

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/firebase/sign-in", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "POST",
    headers: {
      "resource": process.env.RESOURCE_KEY,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({"email":"reader@example.com","password":"EXAMPLE_PASSWORD_DO_NOT_USE"})
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/firebase/sign-in')
body = {'email': 'reader@example.com', 'password': 'EXAMPLE_PASSWORD_DO_NOT_USE'}
request = Request(url, data=json.dumps(body, ensure_ascii=False).encode("utf-8"), headers={'resource': os.environ['RESOURCE_KEY'], "Content-Type": "application/json"}, method='POST')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{
  "firebase_user_id": "EXAMPLE_FIREBASE_UID",
  "status": true,
  "firebase_token_id": "EXAMPLE_FIREBASE_ID_TOKEN"
}

{
  "error": "incorrect_data",
  "error_description": "Body must be json format"
}

curl -X POST "${WALLKIT_API_BASE}/api/v1/firebase/verify-token" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "firebase-token: ${FIREBASE_ID_TOKEN}"

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/firebase/verify-token", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "POST",
    headers: {
      "resource": process.env.RESOURCE_KEY,
      "firebase-token": process.env.FIREBASE_ID_TOKEN
    }
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/firebase/verify-token')
request = Request(url, headers={'resource': os.environ['RESOURCE_KEY'], 'firebase-token': os.environ['FIREBASE_ID_TOKEN']}, method='POST')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{
  "status": true,
  "expired_at": "2030-01-01 00:00:00",
  "firebase_user_id": "EXAMPLE_FIREBASE_UID"
}

{
  "error": "Empty Firebase Token"
}

curl -X POST "${WALLKIT_API_BASE}/api/v1/firebase/registration" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "Content-Type: application/json" \
  --data '{"firebase_id_token":"EXAMPLE_FIREBASE_ID_TOKEN"}'

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/firebase/registration", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "POST",
    headers: {
      "resource": process.env.RESOURCE_KEY,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({"firebase_id_token":"EXAMPLE_FIREBASE_ID_TOKEN"})
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/firebase/registration')
body = {'firebase_id_token': 'EXAMPLE_FIREBASE_ID_TOKEN'}
request = Request(url, data=json.dumps(body, ensure_ascii=False).encode("utf-8"), headers={'resource': os.environ['RESOURCE_KEY'], "Content-Type": "application/json"}, method='POST')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{
  "id": 7001,
  "email": "reader@example.com",
  "token": "EXAMPLE_WALLKIT_SESSION_TOKEN",
  "expires": 1893456000
}

{
  "error": "incorrect_data",
  "error_description": "Body must be json format"
}

curl -X POST "${WALLKIT_API_BASE}/api/v1/firebase/revoke-token" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  -H "firebase-token: ${FIREBASE_ID_TOKEN}"

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/firebase/revoke-token", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "POST",
    headers: {
      "resource": process.env.RESOURCE_KEY,
      "token": process.env.USER_TOKEN,
      "firebase-token": process.env.FIREBASE_ID_TOKEN
    }
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/firebase/revoke-token')
request = Request(url, headers={'resource': os.environ['RESOURCE_KEY'], 'token': os.environ['USER_TOKEN'], 'firebase-token': os.environ['FIREBASE_ID_TOKEN']}, method='POST')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{
  "status": true
}

{
  "error": "Empty Firebase Token"
}

curl -X GET "${WALLKIT_API_BASE}/api/v1/firebase/custom-token" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  -H "firebase-token: ${FIREBASE_ID_TOKEN}"

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/firebase/custom-token", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "GET",
    headers: {
      "resource": process.env.RESOURCE_KEY,
      "token": process.env.USER_TOKEN,
      "firebase-token": process.env.FIREBASE_ID_TOKEN
    }
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/firebase/custom-token')
request = Request(url, headers={'resource': os.environ['RESOURCE_KEY'], 'token': os.environ['USER_TOKEN'], 'firebase-token': os.environ['FIREBASE_ID_TOKEN']}, method='GET')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{
  "firebase_custom_token": "EXAMPLE_FIREBASE_CUSTOM_TOKEN"
}

{
  "error": "Firebase Service Not Enabled"
}

curl -X GET "${WALLKIT_API_BASE}/api/v1/firebase/account" \
  -H "resource: ${RESOURCE_KEY}"

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/firebase/account", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "GET",
    headers: {
      "resource": process.env.RESOURCE_KEY
    }
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/firebase/account')
request = Request(url, headers={'resource': os.environ['RESOURCE_KEY']}, method='GET')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{
  "is_enabled_firebase_auth": false,
  "active": false,
  "web_app_config": null
}

{
  "is_enabled_firebase_auth": true,
  "active": true,
  "web_app_config": {
    "projectId": "example-project"
  }
}

curl -X GET "${WALLKIT_API_BASE}/api/v1/firebase/check/email?email=reader%40example.com" \
  -H "resource: ${RESOURCE_KEY}"

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/firebase/check/email?email=reader%40example.com", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "GET",
    headers: {
      "resource": process.env.RESOURCE_KEY
    }
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/firebase/check/email?email=reader%40example.com')
request = Request(url, headers={'resource': os.environ['RESOURCE_KEY']}, method='GET')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{
  "resources": [
    {
      "resource_id": 1001,
      "resource_key": "EXAMPLE_RESOURCE_PUBLIC_KEY",
      "has_user_resource_relationship": true,
      "has_firebase_relationship": true
    }
  ]
}

{
  "error": "user_not_found",
  "error_description": "User not found"
}

curl -X POST "${WALLKIT_API_BASE}/api/v1/firebase/password-reset" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "Content-Type: application/json" \
  --data '{"email":"reader@example.com"}'

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/firebase/password-reset", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "POST",
    headers: {
      "resource": process.env.RESOURCE_KEY,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({"email":"reader@example.com"})
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/firebase/password-reset')
body = {'email': 'reader@example.com'}
request = Request(url, data=json.dumps(body, ensure_ascii=False).encode("utf-8"), headers={'resource': os.environ['RESOURCE_KEY'], "Content-Type": "application/json"}, method='POST')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{
  "result": true,
  "is_sent_mail": true,
  "message": "Mail with instructions has been sent to your email address"
}

{
  "result": true,
  "is_sent_mail": false,
  "oob_code": "EXAMPLE_FIREBASE_OOB_CODE"
}

curl -X POST "${WALLKIT_API_BASE}/api/v1/firebase/email-auth-link" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "Content-Type: application/json" \
  --data '{"email":"reader@example.com"}'

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/firebase/email-auth-link", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "POST",
    headers: {
      "resource": process.env.RESOURCE_KEY,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({"email":"reader@example.com"})
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/firebase/email-auth-link')
body = {'email': 'reader@example.com'}
request = Request(url, data=json.dumps(body, ensure_ascii=False).encode("utf-8"), headers={'resource': os.environ['RESOURCE_KEY'], "Content-Type": "application/json"}, method='POST')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{
  "result": true,
  "is_sent_mail": true,
  "message": "Mail with instructions has been sent to your email address"
}

{
  "result": true,
  "is_sent_mail": false,
  "oob_code": "EXAMPLE_FIREBASE_OOB_CODE"
}

curl -X PUT "${WALLKIT_API_BASE}/api/v1/firebase/firestore/user" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  -H "firebase-token: ${FIREBASE_ID_TOKEN}" \
  -H "Content-Type: application/json" \
  --data '{"firestore":{"newsletter_opt_in":true}}'

// Node.js 18+; built-in fetch.
async function main() {
  const url = new URL("/api/v1/firebase/firestore/user", process.env.WALLKIT_API_BASE);
  const response = await fetch(url, {
    method: "PUT",
    headers: {
      "resource": process.env.RESOURCE_KEY,
      "token": process.env.USER_TOKEN,
      "firebase-token": process.env.FIREBASE_ID_TOKEN,
      "Content-Type": "application/json"
    },
    body: JSON.stringify({"firestore":{"newsletter_opt_in":true}})
  });
  console.log(response.status, await response.json());
}
main().catch(console.error);

# Python 3; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import urljoin
from urllib.request import Request, urlopen

url = urljoin(os.environ["WALLKIT_API_BASE"], '/api/v1/firebase/firestore/user')
body = {'firestore': {'newsletter_opt_in': True}}
request = Request(url, data=json.dumps(body, ensure_ascii=False).encode("utf-8"), headers={'resource': os.environ['RESOURCE_KEY'], 'token': os.environ['USER_TOKEN'], 'firebase-token': os.environ['FIREBASE_ID_TOKEN'], "Content-Type": "application/json"}, method='PUT')
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

{
  "user": {
    "id": 42,
    "email": "reader@example.com",
    "extra": {
      "firestore": {
        "newsletter_opt_in": true,
        "id": "EXAMPLE_FIREBASE_UID"
      }
    },
    "subscriptions": [],
    "teams": [],
    "subscriptions_history": []
  },
  "success": true
}

{
  "error": "firestore_not_active",
  "error_description": "Firestore service is not enabled"
}