workspace

Embed
Preview of the card
<a href="https://hermetica.15.204.158.166.sslip.io/docs/ref-workspace"><img src="https://hermetica.15.204.158.166.sslip.io/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/a0ad69ab-5e0e-47f8-9717-de2a13b4ca3d/social-card.svg?v=3e7ae33eec8b" alt="workspace" width="600" height="315"></a>
GEThttps://hermetica.15.204.158.166.sslip.io/v1/workspace/sso

Single sign-on status: whether the workspace has an Atlas organization and its SSO connections

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/workspace/sso" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "available": true,
  "configured": true,
  "connections": [
    {
      "id": "string",
      "type": "string",
      "status": "string"
    }
  ]
}
Schema
availablebooleanrequired
configuredbooleanrequired
connectionsobject[]required
Show child parameters
idstringrequired
typestringrequired
statusstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/workspace/sso

POSThttps://hermetica.15.204.158.166.sslip.io/v1/workspace/sso/setup-link

Code samples

cURL
curl -X POST "https://hermetica.15.204.158.166.sslip.io/v1/workspace/sso/setup-link" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "url": "string",
  "expiresAt": "string"
}
Schema
urlstringrequired
expiresAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/workspace/sso

5XX Default Response

Same as 4XX · GET /v1/workspace/sso

GEThttps://hermetica.15.204.158.166.sslip.io/v1/workspace/test-mode

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/workspace/test-mode" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "enabled": true
}
Schema
enabledbooleanrequired
4XX Default Response

Same as 4XX · GET /v1/workspace/sso

5XX Default Response

Same as 4XX · GET /v1/workspace/sso

PUThttps://hermetica.15.204.158.166.sslip.io/v1/workspace/test-mode

While on, no message reaches a real provider; sends are logged as test sends

Request body

application/json
enabledbooleanrequired
{
  "enabled": true
}

Code samples

cURL
curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/workspace/test-mode" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/workspace/test-mode

4XX Default Response

Same as 4XX · GET /v1/workspace/sso

5XX Default Response

Same as 4XX · GET /v1/workspace/sso

GEThttps://hermetica.15.204.158.166.sslip.io/v1/workspace/ip-allowlist

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/workspace/ip-allowlist" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "entries": [
    "string"
  ],
  "yourIp": "string"
}
Schema
entriesstring[]required
yourIpstringrequired
4XX Default Response

Same as 4XX · GET /v1/workspace/sso

5XX Default Response

Same as 4XX · GET /v1/workspace/sso

PUThttps://hermetica.15.204.158.166.sslip.io/v1/workspace/ip-allowlist

Restrict sessions and secret API keys to these IPs/CIDRs (empty = open). Refuses a list that excludes the caller.

Request body

application/json
entriesstring[]required
{
  "entries": [
    "string"
  ]
}

Code samples

cURL
curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/workspace/ip-allowlist" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"entries":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/workspace/ip-allowlist

4XX Default Response

Same as 4XX · GET /v1/workspace/sso

5XX Default Response

Same as 4XX · GET /v1/workspace/sso

GEThttps://hermetica.15.204.158.166.sslip.io/v1/white-label

Product name, logo and colours shown in the app and on hosted pages

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/white-label" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "productName": "string",
  "logoUrl": "string",
  "faviconUrl": "string",
  "appCss": "string",
  "loginMessage": "string",
  "primaryColor": "string",
  "accentColor": "string",
  "customCss": "string",
  "footerScripts": "string",
  "preferenceTemplate": "string"
}
Schema
productNamestringrequired
logoUrlstringrequired
faviconUrlstringrequired
appCssstringrequired
loginMessagestringrequired
primaryColorstringrequired
accentColorstringrequired
customCssstringrequired
footerScriptsstringrequired
preferenceTemplatestringrequired
4XX Default Response

Same as 4XX · GET /v1/workspace/sso

5XX Default Response

Same as 4XX · GET /v1/workspace/sso

PUThttps://hermetica.15.204.158.166.sslip.io/v1/white-label

Set the white-label look; send null to clear a field

Request body

application/json
productNamestring
logoUrlstring
faviconUrlstring
appCssstring
loginMessagestring
primaryColorstring
accentColorstring
customCssstring
footerScriptsstring
preferenceTemplatestring
{
  "productName": "string",
  "logoUrl": "string",
  "faviconUrl": "string",
  "appCss": "string",
  "loginMessage": "string",
  "primaryColor": "string",
  "accentColor": "string",
  "customCss": "string",
  "footerScripts": "string",
  "preferenceTemplate": "string"
}

Code samples

cURL
curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/white-label" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"productName":"string","logoUrl":"string","faviconUrl":"string","appCss":"string","loginMessage":"string","primaryColor":"string","accentColor":"string","customCss":"string","footerScripts":"string","preferenceTemplate":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/white-label

4XX Default Response

Same as 4XX · GET /v1/workspace/sso

5XX Default Response

Same as 4XX · GET /v1/workspace/sso

GEThttps://hermetica.15.204.158.166.sslip.io/v1/currencies

Registered currencies with their rate to the display currency

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/currencies" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "displayCurrency": "string",
  "items": [
    {
      "code": "string",
      "name": "string",
      "symbol": "string",
      "rate": 0,
      "isDisplay": true
    }
  ]
}
Schema
displayCurrencystringrequired
itemsobject[]required
Show child parameters
codestringrequired
namestringrequired
symbolstringrequired
ratenumberrequired
isDisplaybooleanrequired
4XX Default Response

Same as 4XX · GET /v1/workspace/sso

5XX Default Response

Same as 4XX · GET /v1/workspace/sso

PUThttps://hermetica.15.204.158.166.sslip.io/v1/currencies/{code}

Register a currency or change its rate (1 unit = rate display-currency units)

Parameters

codestringpathrequired

Request body

application/json
ratenumberrequired
{
  "rate": 0
}

Code samples

cURL
curl -X PUT "https://hermetica.15.204.158.166.sslip.io/v1/currencies/{code}" \
  -H "Authorization: Bearer $SSLIP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rate":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/currencies

4XX Default Response

Same as 4XX · GET /v1/workspace/sso

5XX Default Response

Same as 4XX · GET /v1/workspace/sso

DELETEhttps://hermetica.15.204.158.166.sslip.io/v1/currencies/{code}

Remove a currency rate; amounts in it show in their own currency again

Parameters

codestringpathrequired

Code samples

cURL
curl -X DELETE "https://hermetica.15.204.158.166.sslip.io/v1/currencies/{code}" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/currencies

4XX Default Response

Same as 4XX · GET /v1/workspace/sso

5XX Default Response

Same as 4XX · GET /v1/workspace/sso

GEThttps://hermetica.15.204.158.166.sslip.io/v1/workspace/dashboard-domain

Code samples

cURL
curl -X GET "https://hermetica.15.204.158.166.sslip.io/v1/workspace/dashboard-domain" \
  -H "Authorization: Bearer $SSLIP_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "host": "string",
  "status": "pending",
  "cnameTarget": "string",
  "verifiedAt": "2024-01-01T00:00:00Z",
  "lastCheckedAt": "2024-01-01T00:00:00Z",
  "lastError": "string"
}
Schema
hoststringrequired
statusstringrequired
pending | verified | failed
cnameTargetstringrequired
verifiedAtstringrequired
lastCheckedAtstringrequired
lastErrorstringrequired
4XX Default Response

Same as 4XX · GET /v1/workspace/sso

5XX Default Response

Same as 4XX · GET /v1/workspace/sso

Updated