Organizations

Create a reseller-funded child organisation

Requires a reseller owner or admin session and CSRF proof. The parent_organization_id is the reseller partner id. An approved entitlement and an existing verified customer owner are required. external_ref is required for retry-safe provisioning. The reseller funds the child through wholesale billing. This does not buy or transfer credits. Manage the returned customer through /v1/partners//customers; usage is at /v1/partners//report. Workspace API keys cannot administer a reseller.

POST

organizations

curl --request POST \
  --url https://api.sempera.org/v1/organizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "parent_organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "owner_email": "jsmith@example.com",
  "external_ref": "<string>"
}
'

import requests

url = "https://api.sempera.org/v1/organizations"

payload = {
    "parent_organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "owner_email": "jsmith@example.com",
    "external_ref": "<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({
    parent_organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    owner_email: 'jsmith@example.com',
    external_ref: '<string>'
  })
};

fetch('https://api.sempera.org/v1/organizations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "partner_id": "<string>",
  "status": "<string>",
  "created": true,
  "external_ref": "<string>",
  "workspace_id": "<string>",
  "billing_responsibility": "<string>",
  "support_responsibility": "<string>"
}

{
  "id": "<string>",
  "partner_id": "<string>",
  "status": "<string>",
  "created": true,
  "external_ref": "<string>",
  "workspace_id": "<string>",
  "billing_responsibility": "<string>",
  "support_responsibility": "<string>"
}

{
  "error": {
    "code": "AGENT_ENV_UNPINNED",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>",
    "scope": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "AGENT_ENV_UNPINNED",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>",
    "scope": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "AGENT_ENV_UNPINNED",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>",
    "scope": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "AGENT_ENV_UNPINNED",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>",
    "scope": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "AGENT_ENV_UNPINNED",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>",
    "scope": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "AGENT_ENV_UNPINNED",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>",
    "scope": "<string>",
    "reason": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A workspace API key, sent as Authorization: Bearer sempera_sk_... Each operation names the one scope it needs. Scopes, key kinds and roles are in the Authentication guide.

Body

application/json

parent_organization_id

string<uuid>

required

name

string

required

Maximum string length: 120

owner_email

string<email>

required

external_ref

string

required

Maximum string length: 120

support_responsibility

enum<string>

Available options:

partner,

sempera

Response

Existing external reference returned

string

required

partner_id

string

required

status

string

required

created

boolean

required

external_ref

string | null

workspace_id

string | null

billing_responsibility

string

support_responsibility

string

⌘I

Create a reseller-funded child organisation

curl --request POST \
  --url https://api.sempera.org/v1/organizations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "parent_organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "owner_email": "jsmith@example.com",
  "external_ref": "<string>"
}
'

import requests

url = "https://api.sempera.org/v1/organizations"

payload = {
    "parent_organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "owner_email": "jsmith@example.com",
    "external_ref": "<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({
    parent_organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    owner_email: 'jsmith@example.com',
    external_ref: '<string>'
  })
};

fetch('https://api.sempera.org/v1/organizations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "partner_id": "<string>",
  "status": "<string>",
  "created": true,
  "external_ref": "<string>",
  "workspace_id": "<string>",
  "billing_responsibility": "<string>",
  "support_responsibility": "<string>"
}

{
  "id": "<string>",
  "partner_id": "<string>",
  "status": "<string>",
  "created": true,
  "external_ref": "<string>",
  "workspace_id": "<string>",
  "billing_responsibility": "<string>",
  "support_responsibility": "<string>"
}

{
  "error": {
    "code": "AGENT_ENV_UNPINNED",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>",
    "scope": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "AGENT_ENV_UNPINNED",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>",
    "scope": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "AGENT_ENV_UNPINNED",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>",
    "scope": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "AGENT_ENV_UNPINNED",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>",
    "scope": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "AGENT_ENV_UNPINNED",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>",
    "scope": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "AGENT_ENV_UNPINNED",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>",
    "scope": "<string>",
    "reason": "<string>"
  }
}