Skip to content
API Reference
/
commerce
/
providers_stripe_create_organization_create

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

providers_google_pay_validate_transaction_id_create

Request

Associate a Google Pay account with a known user

Body
required
google_pay_receiptstringrequired
bundle_idstring
Default "ai.ibl.mentorai"
keystring
namestring
curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/providers/google-pay/validate-transaction-id/ \
  -H 'Content-Type: application/json' \
  -d '{
    "google_pay_receipt": "string",
    "bundle_id": "ai.ibl.mentorai",
    "key": "string",
    "name": "string"
  }'

Responses

Bodyapplication/json
successboolean
Default true
messageanyrequired
dataany
Response
application/json
{
  "success": true,
  "message": null,
  "data": null
}

providers_stripe_create_organization_create

Request

Proxy to the Platform launch API

We cannot expose launching a tenant to an unauthorized user hence the need for the API

The API validates the stripe_checkout_id and then proxies the request to the Platform Launch API

Body
required
usernamestring
emailstring(email)
firstnamestring
Default ""
lastnamestring
Default ""
passwordstring
namestringrequired

Organization name

keystringrequired

Unique key for the organization

ignore_user_existsboolean
Default false
stripe_checkout_id_altstringrequired

Stripe Checkout Id to launch the tenant

curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/providers/stripe/create-organization/ \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "string",
    "email": "user@example.com",
    "firstname": "",
    "lastname": "",
    "password": "string",
    "name": "string",
    "key": "string",
    "ignore_user_exists": false,
    "stripe_checkout_id_alt": "string"
  }'

Responses

Bodyapplication/json
successboolean
Default true
messageanyrequired
dataany
idstring
timestampstring
orgstringrequired
lms_urlstringrequired
cms_urlstringrequired
portal_urlstringrequired
edx_rolestringrequired
Response
application/json
{
  "success": true,
  "message": null,
  "data": null,
  "id": "string",
  "timestamp": "string",
  "org": "string",
  "lms_url": "string",
  "cms_url": "string",
  "portal_url": "string",
  "edx_role": "string"
}

service_launch_tenant_create

Request

User/tenant creation API

To create using any payment provider, ensure you use the StudentToken Authentication Mechanism and also include the correct provider_key in the request body:

    apple_transaction_id: str
    stripe_checkout_id: str
    x_gcp_marketplace_token: str
    aws_transaction_id: str
    google_pay_transaction_id: str

To create a tenant without a payment provider, call the API without ny of the above provider keys in the request body

Security
PlatformApiKeyAuthentication
Body
required
usernamestringrequired
emailstring(email)required
firstnamestring
Default ""
lastnamestring
Default ""
passwordstring
namestringrequired

Organization name

keystringrequired

Unique key for the organization

ignore_user_existsboolean
Default false
curl -i -X POST \
  https://docs.ibl.ai/_mock/apis/ibl/api/service/launch/tenant/ \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "string",
    "email": "user@example.com",
    "firstname": "",
    "lastname": "",
    "password": "string",
    "name": "string",
    "key": "string",
    "ignore_user_exists": false
  }'

Responses

Bodyapplication/json
successboolean
Default true
messageanyrequired
dataany
idstring
timestampstring
orgstringrequired
lms_urlstringrequired
cms_urlstringrequired
portal_urlstringrequired
edx_rolestringrequired
Response
application/json
{
  "success": true,
  "message": null,
  "data": null,
  "id": "string",
  "timestamp": "string",
  "org": "string",
  "lms_url": "string",
  "cms_url": "string",
  "portal_url": "string",
  "edx_role": "string"
}

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com