Provision an app user

curl --request POST \
  --url https://app.base44.com/api/apps/{app_id}/users/provisions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "role": "<string>",
  "full_name": "<string>"
}
'

import requests

url = "https://app.base44.com/api/apps/{app_id}/users/provisions"

payload = {
    "email": "jsmith@example.com",
    "role": "<string>",
    "full_name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email: 'jsmith@example.com', role: '<string>', full_name: '<string>'})
};

fetch('https://app.base44.com/api/apps/{app_id}/users/provisions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.base44.com/api/apps/{app_id}/users/provisions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'jsmith@example.com',
    'role' => '<string>',
    'full_name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.base44.com/api/apps/{app_id}/users/provisions"

	payload := strings.NewReader("{\n  \"email\": \"jsmith@example.com\",\n  \"role\": \"<string>\",\n  \"full_name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.base44.com/api/apps/{app_id}/users/provisions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jsmith@example.com\",\n  \"role\": \"<string>\",\n  \"full_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.base44.com/api/apps/{app_id}/users/provisions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"jsmith@example.com\",\n  \"role\": \"<string>\",\n  \"full_name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "created",
  "email": "dana@example.com",
  "role": "user"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Users

Provision an app user

This API is in beta. Endpoints, fields, and behavior may still change, so avoid depending on it in production.

Gives a person access to this app ahead of their first sign-in, so the app can be embedded signed in as them. Returns created for a new email, and exists for an email that already has an access request, whatever its state: a request still pending approval stays pending, and an embed sign-in token for it answers unknown_user. Call it with a personal access token whose owner can edit the app, or with a workspace API key that has the Provision app users permission. Limited to 120 requests a minute per app, shared with deprovisioning. Higher plans get a higher limit.

POST

api

apps

{app_id}

users

provisions

Provision an app user

curl --request POST \
  --url https://app.base44.com/api/apps/{app_id}/users/provisions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "role": "<string>",
  "full_name": "<string>"
}
'

import requests

url = "https://app.base44.com/api/apps/{app_id}/users/provisions"

payload = {
    "email": "jsmith@example.com",
    "role": "<string>",
    "full_name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({email: 'jsmith@example.com', role: '<string>', full_name: '<string>'})
};

fetch('https://app.base44.com/api/apps/{app_id}/users/provisions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.base44.com/api/apps/{app_id}/users/provisions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'email' => 'jsmith@example.com',
    'role' => '<string>',
    'full_name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.base44.com/api/apps/{app_id}/users/provisions"

	payload := strings.NewReader("{\n  \"email\": \"jsmith@example.com\",\n  \"role\": \"<string>\",\n  \"full_name\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.base44.com/api/apps/{app_id}/users/provisions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"jsmith@example.com\",\n  \"role\": \"<string>\",\n  \"full_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.base44.com/api/apps/{app_id}/users/provisions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"jsmith@example.com\",\n  \"role\": \"<string>\",\n  \"full_name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "created",
  "email": "dana@example.com",
  "role": "user"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id

string

required

ID of the app.

Body

application/json

Payload for server-to-server app-user provisioning (embedded platforms).

string<email>

required

The app user's email — their identity in this app

role

string

required

Application-level role for in-app permissions

full_name

string | null

Maximum string length: 256

Response

Successful Response

The app user an email was provisioned as.

status

enum<string>

required

created for a new email, exists for one that already had an access request.

Available options:

created,

exists

Example:

"created"

string

required

The email, lowercased.

Example:

"dana@example.com"

role

string

required

The role the email holds in the app. For exists, the role it already had.

Example:

"user"

Base44 APIs

Apps API (Beta)

Workspace API (Beta)

Superagents API (Beta)

Monitoring API

Audit Logs API

Outbound webhooks

Provision an app user

Authorizations

Path Parameters

Body

Response