curl --request POST \
--url https://app.hookie.ai/admin/api/sso \
--cookie hookie_session=const options = {method: 'POST', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/sso', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/sso"
headers = {"cookie": "hookie_session="}
response = requests.post(url, headers=headers)
print(response.text){
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"reason": "sso_not_available",
"retry_after": 123,
"upgrade_url": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}Create a workspace SSO configuration (not available)
Single sign-on is not available yet (SEC-13a, #257): there is no SAML or OIDC sign-in, so this always answers 501 with reason: "sso_not_available" and changes nothing. It answers before the plan, the role or the body is looked at. A configuration saved before then is kept as it was; list it with listSsoConfigs.
curl --request POST \
--url https://app.hookie.ai/admin/api/sso \
--cookie hookie_session=const options = {method: 'POST', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/sso', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/sso"
headers = {"cookie": "hookie_session="}
response = requests.post(url, headers=headers)
print(response.text){
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"error": "<string>",
"reason": "sso_not_available",
"retry_after": 123,
"upgrade_url": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}Authorizations
Headers
Response
Not signed in.
Machine-readable reason, where the status alone is ambiguous. workspace_suspended (403): the workspace is suspended; delivery_allowance_exhausted (429): a replay was refused because the monthly delivery allowance is used. endpoint_disabled (503): the endpoint is switched off; handshake_failed: a provider URL-verification challenge could not be answered (#193). missing_header, bad_signature, stale_timestamp (401): an endpoint's provider signature check failed; scheme names the check. portal_customer_mismatch (409): a portal token was requested for, or the vendor switched on the endpoint of, a customer other than the one the portal now serves (PORT-2g); customer_id and customer_name name that customer. Agent self-registration (#331), on /v1/agents/register: rate_limited (429), agent_registration_disabled and agent_registration_unavailable (503), invalid_body, invalid_agent_name, invalid_operator_contact, terms_not_accepted (with terms_version), proof_of_work_required, invalid_challenge, challenge_expired, invalid_proof_of_work, invalid_idempotency_key (400), body_too_large (413), already_registered, registration_in_progress, challenge_spent (409, with account_id), daily_cap_reached, source_daily_limit (429), identity_provider_error (502), registration_incomplete (503).
Present on a 403 to an OAuth-connected agent, and on a member-limit 403 to anyone. agent_scope_insufficient: the agent's grant is below what the call needs, and widening it would let the call through (see required_scope and manage_url). insufficient_role: the user's OWN workspace role does not allow the call, so no grant can — a workspace owner or admin has to change the user's role first, in the console under Settings → Members. agent_not_permitted: no connected agent or API key may do this at any scope (billing, platform admin, managing connected agents, a destination's signing secret, invites of any kind, changing a role, removing a member, transferring ownership, listing or switching a person's workspaces, and creating API keys). To a self-registered agent account nobody has claimed yet (#331) it also carries claim_required: true: a person must claim the workspace with the claim link from registration before anyone can do it. member_limit_reached (#308): the workspace already has as many members as its plan allows, so an invite cannot be created or accepted; max_members, members and upgrade_url say how many and where to upgrade.
agent_scope_insufficient, insufficient_role, agent_not_permitted, member_limit_reached