{ "components": { "schemas": { "api.ManagedBillingCheckoutRequest": { "properties": { "plan": { "description": "Plan identifier offered by the managed StatiBeat billing account.", "type": "string" }, "success_url": { "description": "Optional safe return URL after checkout. StatiBeat derives one from the request host when omitted.", "format": "uri", "type": "string" } }, "required": [ "plan" ], "type": "object" }, "api.MessageResponse": { "properties": { "message": { "type": "string" } }, "type": "object" }, "api.StatusPageSummary": { "properties": { "active_custom_domain": { "type": "string" }, "active_custom_url": { "type": "string" }, "custom_domains": { "items": { "type": "string" }, "type": "array" }, "fallback_domain": { "type": "string" }, "fallback_url": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "organization_id": { "type": "integer" }, "organization_slug": { "type": "string" }, "page_id": { "type": "integer" }, "page_slug": { "type": "string" }, "public_domain": { "type": "string" }, "public_slug": { "type": "string" }, "public_url": { "type": "string" }, "viewer_auth_mode": { "type": "string" }, "viewer_password_configured": { "type": "boolean" }, "visibility": { "type": "string" } }, "type": "object" }, "entitlements.Features": { "properties": { "advanced_rbac_enabled": { "type": "boolean" }, "ai_enabled": { "type": "boolean" }, "audit_logs": { "type": "string" }, "custom_domains_enabled": { "type": "boolean" }, "custom_favicon_enabled": { "type": "boolean" }, "custom_smtp_enabled": { "type": "boolean" }, "dedicated_infra": { "type": "boolean" }, "group_mapping_enabled": { "type": "boolean" }, "multilingual_enabled": { "type": "boolean" }, "multilingual_message_authoring_enabled": { "type": "boolean" }, "slack_enabled": { "type": "boolean" }, "sms_notifications_enabled": { "type": "boolean" }, "sso_enabled": { "type": "boolean" }, "synthetic_monitoring_enabled": { "type": "boolean" }, "terraform_enabled": { "type": "boolean" }, "unlimited_limits_enabled": { "type": "boolean" } }, "type": "object" }, "entitlements.LimitKey": { "enum": [ "status_pages", "admin_users", "components", "subscribers", "custom_views", "rss_feeds", "custom_domains", "api_tokens", "synthetic_monitors" ], "type": "string" }, "entitlements.Limits": { "properties": { "admin_users": { "type": "integer" }, "api_tokens": { "type": "integer" }, "components": { "type": "integer" }, "custom_domains": { "type": "integer" }, "custom_views": { "type": "integer" }, "rss_feeds": { "type": "integer" }, "status_pages": { "type": "integer" }, "subscribers": { "type": "integer" }, "synthetic_monitors": { "type": "integer" } }, "type": "object" }, "entitlements.Upgrade": { "properties": { "available": { "type": "boolean" }, "recommended_plan": { "type": "string" } }, "type": "object" }, "handlers.ErrorResponse": { "properties": { "error": { "type": "string" } }, "type": "object" }, "handlers.ScopedUserCreateRequest": { "properties": { "display_name": { "type": "string" }, "email": { "type": "string" }, "org_role": { "$ref": "#/components/schemas/models.OrganizationRole" }, "org_role_key": { "type": "string" }, "page_id": { "type": "integer" }, "page_role": { "$ref": "#/components/schemas/models.StatusPageRole" }, "page_role_key": { "type": "string" }, "password": { "format": "password", "type": "string", "writeOnly": true } }, "required": [ "email", "password" ], "type": "object" }, "handlers.UserResponse": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "disabled_at": { "format": "date-time", "type": "string" }, "display_name": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "integer" }, "last_login_at": { "format": "date-time", "type": "string" }, "organization_permissions": { "items": { "type": "string" }, "type": "array" }, "organization_role": { "type": "string" }, "platform_permissions": { "items": { "type": "string" }, "type": "array" }, "role": { "type": "string" }, "status_page_permissions": { "items": { "type": "string" }, "type": "array" }, "status_page_role": { "type": "string" } }, "type": "object" }, "handlers.adminAuthProviderResponse": { "properties": { "client_id": { "type": "string" }, "client_secret_set": { "type": "boolean" }, "email_claim": { "type": "string" }, "enabled": { "type": "boolean" }, "groups_claim": { "type": "string" }, "id": { "type": "integer" }, "issuer_url": { "type": "string" }, "protocol": { "type": "string" }, "redirect_uri": { "type": "string" }, "saml_acs_url": { "type": "string" }, "saml_email_attribute": { "type": "string" }, "saml_entity_id": { "type": "string" }, "saml_groups_attribute": { "type": "string" }, "saml_nameid_format": { "type": "string" }, "saml_sp_entity_id": { "type": "string" }, "saml_sso_url": { "type": "string" }, "saml_x509_certificate": { "type": "string" }, "saml_x509_certificate_set": { "type": "boolean" }, "subject_claim": { "type": "string" } }, "type": "object" }, "handlers.approveTrialDeletionRequest": { "properties": { "token": { "format": "password", "type": "string", "writeOnly": true } }, "type": "object" }, "handlers.authzBindingResponse": { "properties": { "auth_type": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "display_name": { "type": "string" }, "email": { "type": "string" }, "role_key": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "user_id": { "type": "integer" } }, "type": "object" }, "handlers.authzCatalogPermissionResponse": { "properties": { "default_roles": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "entitlement": { "type": "string" }, "exportable": { "type": "boolean" }, "feature_group": { "type": "string" }, "name": { "type": "string" }, "scope": { "type": "string" }, "terraformable": { "type": "boolean" } }, "type": "object" }, "handlers.authzCatalogResponse": { "properties": { "organization_roles": { "items": { "$ref": "#/components/schemas/handlers.authzCatalogRoleResponse" }, "type": "array" }, "page_roles": { "items": { "$ref": "#/components/schemas/handlers.authzCatalogRoleResponse" }, "type": "array" }, "permissions": { "items": { "$ref": "#/components/schemas/handlers.authzCatalogPermissionResponse" }, "type": "array" }, "platform_roles": { "items": { "$ref": "#/components/schemas/handlers.authzCatalogRoleResponse" }, "type": "array" } }, "type": "object" }, "handlers.authzCatalogRoleResponse": { "properties": { "description": { "type": "string" }, "display_name": { "type": "string" }, "key": { "type": "string" }, "legacy_value": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" }, "scope": { "type": "string" } }, "type": "object" }, "handlers.billingScheduledChangeResponse": { "properties": { "dispatch_at": { "type": "string" }, "dispatched_at": { "type": "string" }, "effective_at": { "type": "string" }, "requested_at": { "type": "string" }, "status": { "type": "string" }, "target_plan": { "type": "string" } }, "type": "object" }, "handlers.billingStatusResponse": { "properties": { "account_mode": { "type": "string" }, "account_plan": { "type": "string" }, "account_plan_type": { "type": "string" }, "account_readonly_ends_at": { "type": "string" }, "account_status_page_limit": { "type": "string" }, "account_trial_ends_at": { "type": "string" }, "billing_delinquent": { "type": "boolean" }, "billing_delinquent_since": { "type": "string" }, "billing_grace_ends_at": { "type": "string" }, "billing_status": { "type": "string" }, "features": { "$ref": "#/components/schemas/entitlements.Features" }, "free_compliance": { "$ref": "#/components/schemas/service.EntitlementComplianceSnapshot" }, "grace_ends_at": { "type": "string" }, "lifecycle_state": { "type": "string" }, "limits": { "$ref": "#/components/schemas/entitlements.Limits" }, "readonly_reason": { "type": "string" }, "subscription": { "$ref": "#/components/schemas/handlers.billingSubscriptionResponse" }, "subscription_error": { "type": "string" }, "trial_deletion": { "$ref": "#/components/schemas/handlers.trialDeletionStatusResponse" }, "trial_deletion_error": { "type": "string" }, "trial_eligible": { "type": "boolean" }, "trial_used": { "type": "boolean" }, "upgrade": { "$ref": "#/components/schemas/entitlements.Upgrade" }, "upgrade_available": { "type": "boolean" } }, "type": "object" }, "handlers.billingSubscriptionResponse": { "properties": { "cancel_at_period_end": { "type": "boolean" }, "current_plan": { "type": "string" }, "eligible": { "type": "boolean" }, "ends_at": { "type": "string" }, "reason": { "type": "string" }, "renews_at": { "type": "string" }, "scheduled_change": { "$ref": "#/components/schemas/handlers.billingScheduledChangeResponse" }, "transition_at": { "type": "string" }, "transition_target": { "type": "string" } }, "type": "object" }, "handlers.createStatusPageRequest": { "properties": { "is_default": { "type": "boolean" }, "name": { "type": "string" }, "public_slug": { "type": "string" }, "slug": { "type": "string" }, "viewer_auth_mode": { "type": "string" }, "viewer_password": { "format": "password", "type": "string", "writeOnly": true }, "visibility": { "type": "string" } }, "required": [ "name", "public_slug" ], "type": "object" }, "handlers.currentContextResponse": { "properties": { "canonical_host": { "type": "string" }, "canonical_url": { "type": "string" }, "organization_id": { "type": "integer" }, "organization_routing_slug": { "type": "string" }, "organization_slug": { "type": "string" }, "page_id": { "type": "integer" }, "page_slug": { "type": "string" }, "public_slug": { "type": "string" }, "public_url": { "type": "string" }, "request_host": { "type": "string" }, "routing_slug": { "type": "string" } }, "type": "object" }, "handlers.importAtlassianStatuspageRequest": { "properties": { "is_default": { "type": "boolean" }, "name": { "type": "string" }, "public_slug": { "type": "string" }, "replace_page_id": { "type": "integer" }, "slug": { "type": "string" }, "source_url": { "type": "string" }, "viewer_auth_mode": { "type": "string" }, "viewer_password": { "format": "password", "type": "string", "writeOnly": true }, "visibility": { "type": "string" } }, "required": [ "public_slug", "source_url" ], "type": "object" }, "handlers.organizationResponse": { "properties": { "account_readonly_ends_at": { "format": "date-time", "type": "string" }, "account_trial_ends_at": { "format": "date-time", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "external_id": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "routing_slug": { "type": "string" }, "slug": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "type": "object" }, "handlers.organizationSettingsResponse": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "routing_slug": { "type": "string" } }, "type": "object" }, "handlers.statusPageAdminResponse": { "properties": { "active_custom_domain": { "type": "string" }, "active_custom_url": { "type": "string" }, "can_restore": { "type": "boolean" }, "canonical_host": { "type": "string" }, "canonical_url": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "custom_domains": { "items": { "type": "string" }, "type": "array" }, "deleted_at": { "format": "date-time", "type": "string" }, "external_id": { "type": "string" }, "fallback_domain": { "type": "string" }, "fallback_url": { "type": "string" }, "id": { "type": "integer" }, "is_default": { "type": "boolean" }, "legacy_path_url": { "type": "string" }, "legacy_root_url": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "type": "integer" }, "organization_routing_slug": { "type": "string" }, "organization_slug": { "type": "string" }, "page_id": { "type": "integer" }, "page_slug": { "type": "string" }, "public_domain": { "type": "string" }, "public_slug": { "type": "string" }, "public_url": { "type": "string" }, "purge_after_at": { "format": "date-time", "type": "string" }, "purge_failed": { "type": "boolean" }, "purge_started_at": { "format": "date-time", "type": "string" }, "restore_blockers": { "items": { "$ref": "#/components/schemas/service.StatusPageRestoreBlocker" }, "type": "array" }, "routing_slug": { "type": "string" }, "slug": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "viewer_auth_mode": { "type": "string" }, "viewer_password_configured": { "type": "boolean" }, "visibility": { "type": "string" } }, "type": "object" }, "handlers.trialDeletionRequestResponse": { "properties": { "approval_expires_at": { "type": "string" }, "approved_at": { "type": "string" }, "delete_at": { "type": "string" }, "executed_at": { "type": "string" }, "requested_at": { "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "handlers.trialDeletionStatusResponse": { "properties": { "eligible": { "type": "boolean" }, "explicit_deletion": { "type": "boolean" }, "reason": { "type": "string" }, "request": { "$ref": "#/components/schemas/handlers.trialDeletionRequestResponse" } }, "type": "object" }, "handlers.updateAdminAuthProviderRequest": { "properties": { "client_id": { "type": "string" }, "client_secret": { "format": "password", "type": "string", "writeOnly": true }, "email_claim": { "type": "string" }, "enabled": { "type": "boolean" }, "groups_claim": { "type": "string" }, "issuer_url": { "type": "string" }, "protocol": { "type": "string" }, "redirect_uri": { "type": "string" }, "saml_acs_url": { "type": "string" }, "saml_email_attribute": { "type": "string" }, "saml_entity_id": { "type": "string" }, "saml_groups_attribute": { "type": "string" }, "saml_nameid_format": { "type": "string" }, "saml_sp_entity_id": { "type": "string" }, "saml_sso_url": { "type": "string" }, "saml_x509_certificate": { "type": "string" }, "subject_claim": { "type": "string" } }, "type": "object" }, "handlers.updateOrganizationSettingsRequest": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" }, "handlers.updateRoutingSlugRequest": { "properties": { "routing_slug": { "type": "string" } }, "required": [ "routing_slug" ], "type": "object" }, "handlers.upsertAuthzBindingRequest": { "properties": { "role_key": { "type": "string" } }, "type": "object" }, "handlers.upsertAuthzRoleRequest": { "properties": { "description": { "type": "string" }, "display_name": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "handlers.upsertOrganizationMembershipRequest": { "properties": { "role": { "$ref": "#/components/schemas/models.OrganizationRole" }, "user_id": { "type": "integer" } }, "required": [ "role", "user_id" ], "type": "object" }, "models.AtlassianImportJob": { "properties": { "attempt": { "type": "integer" }, "completed_at": { "format": "date-time", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "error_message": { "type": "string" }, "failure_kind": { "type": "string" }, "id": { "type": "string" }, "imported_page_id": { "type": "integer" }, "max_attempts": { "type": "integer" }, "next_attempt_at": { "format": "date-time", "type": "string" }, "organization_id": { "type": "integer" }, "progress_percent": { "type": "integer" }, "replace_page_id": { "type": "integer" }, "requested_by_user_id": { "type": "integer" }, "stage": { "type": "string" }, "started_at": { "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/models.AtlassianImportJobStatus" }, "updated_at": { "format": "date-time", "type": "string" }, "upstream_status": { "type": "string" } }, "type": "object" }, "models.AtlassianImportJobStatus": { "enum": [ "queued", "running", "retry_wait", "succeeded", "failed" ], "type": "string" }, "models.AuthzRoleBinding": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by_user_id": { "type": "integer" }, "external_id": { "type": "string" }, "id": { "type": "integer" }, "organization_id": { "type": "integer" }, "role_key": { "type": "string" }, "scope": { "$ref": "#/components/schemas/models.AuthzRoleScope" }, "status_page_id": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "updated_by_user_id": { "type": "integer" }, "user_id": { "type": "integer" } }, "type": "object" }, "models.AuthzRoleDefinition": { "properties": { "built_in": { "type": "boolean" }, "created_at": { "format": "date-time", "type": "string" }, "created_by_user_id": { "type": "integer" }, "description": { "type": "string" }, "display_name": { "type": "string" }, "external_id": { "type": "string" }, "id": { "type": "integer" }, "key": { "type": "string" }, "organization_id": { "type": "integer" }, "permissions": { "$ref": "#/components/schemas/models.StringArray" }, "scope": { "$ref": "#/components/schemas/models.AuthzRoleScope" }, "status_page_id": { "type": "integer" }, "updated_at": { "format": "date-time", "type": "string" }, "updated_by_user_id": { "type": "integer" } }, "type": "object" }, "models.AuthzRoleScope": { "enum": [ "organization", "page" ], "type": "string" }, "models.JSONMap": { "additionalProperties": true, "description": "Arbitrary JSON object keyed by string. Values may be any valid JSON value.", "type": "object" }, "models.OrganizationMembership": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "id": { "type": "integer" }, "organization_id": { "type": "integer" }, "role": { "$ref": "#/components/schemas/models.OrganizationRole" }, "updated_at": { "format": "date-time", "type": "string" }, "user_id": { "type": "integer" } }, "type": "object" }, "models.OrganizationMembershipDetail": { "properties": { "auth_type": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "disabled_at": { "format": "date-time", "type": "string" }, "display_name": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "integer" }, "organization_id": { "type": "integer" }, "role": { "$ref": "#/components/schemas/models.OrganizationRole" }, "role_key": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "user_id": { "type": "integer" } }, "type": "object" }, "models.OrganizationRole": { "enum": [ "org_admin" ], "type": "string" }, "models.StatusPageRole": { "enum": [ "viewer", "manager", "admin" ], "type": "string" }, "models.StringArray": { "items": { "type": "string" }, "type": "array" }, "service.EntitlementComplianceSnapshot": { "properties": { "available": { "type": "boolean" }, "catalog_version": { "type": "integer" }, "compliant": { "type": "boolean" }, "fresh": { "type": "boolean" }, "fresh_until": { "format": "date-time", "type": "string" }, "generated_at": { "format": "date-time", "type": "string" }, "items": { "additionalProperties": { "$ref": "#/components/schemas/service.EntitlementUsageItem" }, "type": "object" }, "lifecycle_state": { "type": "string" }, "organization_id": { "type": "integer" }, "plan": { "type": "string" }, "plan_type": { "type": "string" }, "schema_version": { "type": "string" }, "unavailable_reason": { "type": "string" } }, "type": "object" }, "service.EntitlementUsageItem": { "properties": { "compliant": { "type": "boolean" }, "counting_rule": { "type": "string" }, "current": { "type": "integer" }, "excess": { "type": "integer" }, "key": { "$ref": "#/components/schemas/entitlements.LimitKey" }, "label": { "type": "string" }, "limit": { "type": "integer" }, "may_increase": { "type": "boolean" }, "remediation_url": { "type": "string" }, "unlimited": { "type": "boolean" } }, "type": "object" }, "service.ManagedBillingChangePlanRequest": { "properties": { "plan": { "type": "string" } }, "type": "object" }, "service.ManagedBillingCheckoutResponse": { "properties": { "checkout_url": { "type": "string" } }, "type": "object" }, "service.ManagedTrialActivationCustomer": { "properties": { "lifecycle_state": { "type": "string" }, "plan": { "type": "string" }, "plan_type": { "type": "string" }, "trial_ends_at": { "format": "date-time", "type": "string" }, "trial_started_at": { "format": "date-time", "type": "string" }, "trial_used_at": { "format": "date-time", "type": "string" } }, "type": "object" }, "service.ManagedTrialActivationStatus": { "properties": { "activated": { "type": "boolean" }, "customer": { "$ref": "#/components/schemas/service.ManagedTrialActivationCustomer" }, "warning": { "type": "string" } }, "type": "object" }, "service.StatusPageRestoreBlocker": { "properties": { "code": { "type": "string" }, "conflicting_page_id": { "type": "integer" }, "current_count": { "type": "integer" }, "field": { "type": "string" }, "limit": { "type": "integer" }, "message": { "type": "string" }, "value": { "type": "string" } }, "type": "object" } }, "securitySchemes": { "BearerAuth": { "bearerFormat": "API token", "description": "Provide an API token using the Authorization: Bearer \u003ctoken\u003e header.", "scheme": "bearer", "type": "http" } } }, "info": { "contact": { "name": "StatiBeat support" }, "description": "Authenticated customer APIs for administering the organisation associated with the request host.", "license": { "name": "Proprietary" }, "title": "StatiBeat Organisation Administration API", "version": "1.0.0" }, "openapi": "3.0.3", "paths": { "/api/v1/org/auth/admin": { "get": { "description": "Authentication: bearer token required.", "operationId": "statusPage_GetOrganizationAdminAuthProvider_get_org_auth_admin", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.adminAuthProviderResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Organization Admin Auth Provider", "tags": [ "auth-providers" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:read" ] }, "put": { "description": "Authentication: bearer token required.", "operationId": "statusPage_UpsertOrganizationAdminAuthProvider_put_org_auth_admin", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.updateAdminAuthProviderRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.adminAuthProviderResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Upsert Organization Admin Auth Provider", "tags": [ "auth-providers" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/authz/bindings/users": { "get": { "description": "Authentication: bearer token required.", "operationId": "authzAdmin_ListOrganizationUserBindings_get_org_authz_bindings_users", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/handlers.authzBindingResponse" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "List organization RBAC user bindings", "tags": [ "authz" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:read" ] } }, "/api/v1/org/authz/bindings/users/{user_id}": { "delete": { "description": "Authentication: bearer token required.", "operationId": "authzAdmin_DeleteOrganizationUserBinding_delete_org_authz_bindings_users_user_id", "parameters": [ { "description": "user id", "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.JSONMap" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete organization RBAC user binding", "tags": [ "authz" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] }, "put": { "description": "Authentication: bearer token required.", "operationId": "authzAdmin_UpsertOrganizationUserBinding_put_org_authz_bindings_users_user_id", "parameters": [ { "description": "user id", "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.upsertAuthzBindingRequest" } } }, "description": "Organization RBAC binding payload", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.AuthzRoleBinding" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create or update organization RBAC user binding", "tags": [ "authz" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/authz/catalog": { "get": { "description": "Authentication: bearer token required. Returns only the roles and permissions available in the current admin scope.", "operationId": "authzCatalog_GetCatalog_get_org_authz_catalog", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.authzCatalogResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get RBAC catalog", "tags": [ "authz" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:read" ] } }, "/api/v1/org/authz/roles": { "get": { "description": "Authentication: bearer token required.", "operationId": "authzAdmin_ListOrganizationRoles_get_org_authz_roles", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/models.AuthzRoleDefinition" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "List organization RBAC roles", "tags": [ "authz" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:read" ] } }, "/api/v1/org/authz/roles/{key}": { "delete": { "description": "Authentication: bearer token required.", "operationId": "authzAdmin_DeleteOrganizationRole_delete_org_authz_roles_key", "parameters": [ { "description": "key", "in": "path", "name": "key", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.JSONMap" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete organization RBAC role", "tags": [ "authz" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] }, "put": { "description": "Authentication: bearer token required.", "operationId": "authzAdmin_UpsertOrganizationRole_put_org_authz_roles_key", "parameters": [ { "description": "key", "in": "path", "name": "key", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.upsertAuthzRoleRequest" } } }, "description": "Organization RBAC role payload", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.AuthzRoleDefinition" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create or update organization RBAC role", "tags": [ "authz" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/billing/checkout": { "post": { "description": "Authentication: bearer token required. Creates a hosted checkout session for the current organisation. The caller must have `org.billing.manage` and an API token accepted for `admin:write`. `success_url` is optional when StatiBeat can derive a safe return URL from the request host.", "operationId": "billing_CreateCheckout_post_org_billing_checkout", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.ManagedBillingCheckoutRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/service.ManagedBillingCheckoutResponse" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create a billing checkout session", "tags": [ "billing" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-required-permission": "org.billing.manage", "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/billing/status": { "get": { "description": "Authentication: bearer token required.", "operationId": "billing_GetBillingStatus_get_org_billing_status", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.billingStatusResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Billing Status", "tags": [ "billing" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-required-permission": "org.billing.read", "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:read" ] } }, "/api/v1/org/billing/subscription/cancel": { "post": { "description": "Authentication: bearer token required. Cancels the managed subscription at the end of the current billing period.", "operationId": "billing_CancelSubscription_post_org_billing_subscription_cancel", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.billingSubscriptionResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Cancel Subscription", "tags": [ "billing" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-required-permission": "org.billing.manage", "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/billing/subscription/cancel-change": { "post": { "description": "Authentication: bearer token required. Cancels a pending managed subscription plan change before it takes effect.", "operationId": "billing_CancelScheduledSubscriptionChange_post_org_billing_subscription_cancel_change", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.billingSubscriptionResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Cancel Scheduled Subscription Change", "tags": [ "billing" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-required-permission": "org.billing.manage", "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/billing/subscription/change-plan": { "post": { "description": "Authentication: bearer token required.", "operationId": "billing_ChangeSubscriptionPlan_post_org_billing_subscription_change_plan", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/service.ManagedBillingChangePlanRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.billingSubscriptionResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Change Subscription Plan", "tags": [ "billing" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-required-permission": "org.billing.manage", "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/billing/subscription/resume": { "post": { "description": "Authentication: bearer token required. Resumes a managed subscription that was previously set to cancel.", "operationId": "billing_ResumeSubscription_post_org_billing_subscription_resume", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.billingSubscriptionResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Resume Subscription", "tags": [ "billing" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-required-permission": "org.billing.manage", "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/billing/trial-deletion/approve": { "post": { "description": "Authentication: bearer token required. Approves a pending managed trial-deletion request using the issued approval token.", "operationId": "billing_ApproveTrialDeletion_post_org_billing_trial_deletion_approve", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.approveTrialDeletionRequest" } } }, "description": "Trial deletion approval token", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.trialDeletionStatusResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Approve Trial Deletion", "tags": [ "billing" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/billing/trial-deletion/request": { "post": { "description": "Authentication: bearer token required. Creates or refreshes a trial-deletion request and emails its approval link.", "operationId": "billing_RequestTrialDeletion_post_org_billing_trial_deletion_request", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.trialDeletionStatusResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Request Trial Deletion", "tags": [ "billing" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/billing/trial/activate": { "post": { "description": "Authentication: bearer token required. Activates the organization's one-time, card-free 30-day Business trial. The verified actor email is taken from the authenticated request context.", "operationId": "billing_ActivateTrial_post_org_billing_trial_activate", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/service.ManagedTrialActivationStatus" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Activate Business Trial", "tags": [ "billing" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/context": { "get": { "description": "Authentication: bearer token required. Return the organization and current page scope derived from the request host for org-scoped automation.", "operationId": "statusPage_GetOrganizationContext_get_org_context", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.currentContextResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get current organization context", "tags": [ "context" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:read" ] } }, "/api/v1/org/membership/me": { "get": { "description": "Authentication: bearer token required.", "operationId": "statusPage_GetMyOrganizationMembership_get_org_membership_me", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.OrganizationMembership" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get My Organization Membership", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:read" ] } }, "/api/v1/org/memberships": { "get": { "description": "Authentication: bearer token required.", "operationId": "statusPage_ListOrganizationMemberships_get_org_memberships", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/models.OrganizationMembershipDetail" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "List Organization Memberships", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:read" ] }, "put": { "description": "Authentication: bearer token required.", "operationId": "statusPage_UpsertOrganizationMembership_put_org_memberships", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.upsertOrganizationMembershipRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.OrganizationMembership" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Upsert Organization Membership", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/memberships/{user_id}": { "delete": { "description": "Authentication: bearer token required.", "operationId": "statusPage_DeleteOrganizationMembership_delete_org_memberships_user_id", "parameters": [ { "description": "user id", "in": "path", "name": "user_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Delete Organization Membership", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/pages": { "get": { "description": "Authentication: bearer token required.", "operationId": "statusPage_ListStatusPages_get_org_pages", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/api.StatusPageSummary" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "List Status Pages", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:read" ] }, "post": { "description": "Authentication: bearer token required.", "operationId": "statusPage_CreateStatusPage_post_org_pages", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.createStatusPageRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.StatusPageSummary" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Create Status Page", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/pages/deleted": { "get": { "description": "Authentication: bearer token required. Returns soft-deleted pages for the organization that are still within the recovery window.", "operationId": "statusPage_ListDeletedStatusPages_get_org_pages_deleted", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/handlers.statusPageAdminResponse" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "List Deleted Status Pages", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:read" ] } }, "/api/v1/org/pages/directory": { "get": { "description": "Authentication: bearer token required.", "operationId": "statusPage_ListAllStatusPagesForOrganization_get_org_pages_directory", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/api.StatusPageSummary" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "List All Status Pages For Organization", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:read" ] } }, "/api/v1/org/pages/import/atlassian-statuspage": { "post": { "description": "Authentication: bearer token required.", "operationId": "statusPage_ImportAtlassianStatuspage_post_org_pages_import_atlassian_statuspage", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.importAtlassianStatuspageRequest" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.AtlassianImportJob" } } }, "description": "Accepted" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Import Atlassian Statuspage", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/pages/import/atlassian-statuspage/jobs/active": { "get": { "description": "Authentication: bearer token required.", "operationId": "statusPage_GetActiveAtlassianStatuspageImportJob_get_org_pages_import_atlassian_statuspage_jobs_active", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.AtlassianImportJob" } } }, "description": "OK" }, "204": { "description": "No active import job" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Active Atlassian Statuspage Import Job", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:read" ] } }, "/api/v1/org/pages/import/atlassian-statuspage/jobs/{job_id}": { "get": { "description": "Authentication: bearer token required.", "operationId": "statusPage_GetAtlassianStatuspageImportJob_get_org_pages_import_atlassian_statuspage_jobs_job_id", "parameters": [ { "description": "job id", "in": "path", "name": "job_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.AtlassianImportJob" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get Atlassian Statuspage Import Job", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:read" ] } }, "/api/v1/org/pages/{page_id}": { "delete": { "description": "Authentication: bearer token required. Soft-deletes the status page, keeps its identifiers reserved for 7 days, and schedules an automatic purge.", "operationId": "statusPage_DeleteStatusPage_delete_org_pages_page_id", "parameters": [ { "description": "Status page identifier", "in": "path", "name": "page_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api.MessageResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Trash Status Page", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/pages/{page_id}/permanent": { "delete": { "description": "Authentication: bearer token required. Permanently removes a previously soft-deleted status page and releases its reserved identifiers. This action cannot be undone.", "operationId": "statusPage_PermanentlyDeleteStatusPage_delete_org_pages_page_id_permanent", "parameters": [ { "description": "Status page identifier", "in": "path", "name": "page_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "No Content" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Permanently Delete Status Page", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/pages/{page_id}/restore": { "post": { "description": "Authentication: bearer token required. Restores a soft-deleted status page and reactivates any reserved managed routing for it.", "operationId": "statusPage_RestoreStatusPage_post_org_pages_page_id_restore", "parameters": [ { "description": "Status page identifier", "in": "path", "name": "page_id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.statusPageAdminResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Restore Status Page", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/routing-slug": { "put": { "description": "Authentication: bearer token required. Change only the human-facing admin route handle. Stable machine, UUID, and numeric identifiers remain unchanged, and the previous handle remains a resolving alias.", "operationId": "statusPage_UpdateOrganizationRoutingSlug_put_org_routing_slug", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.updateRoutingSlugRequest" } } }, "description": "Routing slug", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.organizationResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Conflict" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Change an organization's internal routing slug", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/settings": { "get": { "description": "Authentication: bearer token required. Return the mutable display name and human-facing admin URL handle. The stable tenant identity is intentionally excluded.", "operationId": "statusPage_GetOrganizationSettings_get_org_settings", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.organizationSettingsResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Not Found" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Get organization settings", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:read" ] }, "put": { "description": "Authentication: bearer token required. Update the organization display name without changing its stable tenant identity or admin URL handle.", "operationId": "statusPage_UpdateOrganizationSettings_put_org_settings", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.updateOrganizationSettingsRequest" } } }, "description": "Organization settings", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.organizationSettingsResponse" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Update organization settings", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/org/users": { "get": { "description": "Authentication: bearer token required.", "operationId": "statusPage_ListUsersForOrganization_get_org_users", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/handlers.UserResponse" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "List Users For Organization", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:read" ] }, "post": { "description": "Authentication: bearer token required.", "operationId": "auth_RegisterScopedUser_post_org_users", "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ScopedUserCreateRequest" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.UserResponse" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "Register Scoped User", "tags": [ "auth" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:write" ] } }, "/api/v1/orgs": { "get": { "description": "Authentication: bearer token required.", "operationId": "statusPage_ListOrganizations_get_orgs", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/handlers.organizationResponse" }, "type": "array" } } }, "description": "OK" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Forbidden" }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Too Many Requests" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/handlers.ErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "BearerAuth": [] } ], "summary": "List Organizations", "tags": [ "organizations" ], "x-statibeat-audience": "customer-automation", "x-statibeat-auth": "bearer", "x-statibeat-compatibility": false, "x-statibeat-stability": "stable", "x-statibeat-surface": "organization-admin", "x-statibeat-token-scopes": [ "admin:read" ] } } }, "servers": [ { "description": "Use your status page or custom domain as the API host.", "url": "https://{page_host}", "variables": { "page_host": { "default": "status.example.com", "description": "Replace with your page host, for example status.example.com or status.your-company.com." } } } ], "tags": [ { "description": "Authentication and current-user operations.", "name": "auth" }, { "description": "Configure identity providers and single sign-on.", "name": "auth-providers" }, { "description": "Inspect roles, permissions, and authorization policy.", "name": "authz" }, { "description": "Inspect and manage the organisation subscription.", "name": "billing" }, { "description": "Resolve the page or organisation associated with the request host.", "name": "context" }, { "description": "Discover and administer StatiBeat organisations.", "name": "organizations" } ], "x-tagGroups": [ { "name": "Organisation Administration", "tags": [ "auth", "auth-providers", "authz", "billing", "context", "organizations" ] } ] }