{ "openapi": "3.0.3", "info": { "title": "Customer REST API", "version": "1.0.0", "description": "Server-to-server API. Keys are created in the account portal with fresh action verification. No browser session, CAPTCHA or legacy token is accepted as API authentication." }, "servers": [ { "url": "https://rest.yemot.co.il/api/v1" } ], "paths": { "/usersApi/profile": { "get": { "operationId": "usersApi.profile.read", "summary": "Read account profile", "description": "Returns the current SSO profile snapshot for the authenticated account. No billing refresh is triggered by this call.", "x-summary-he": "קריאת פרטי החשבון", "x-description-he": "מחזיר את פרטי החשבון שהמפתח שייך אליו - שם, מייל וטלפון. קריאה בלבד, ואינה מרעננת נתונים משום מקום.", "tags": [ "identity.profile" ], "security": [ { "ApiKeyBearer": [] } ], "responses": { "200": { "description": "Successful response", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "additionalProperties": false, "properties": { "customerId": { "type": "integer", "minimum": 1 }, "firstName": { "type": "string", "maxLength": 255, "nullable": true }, "lastName": { "type": "string", "maxLength": 255, "nullable": true }, "email": { "type": "string", "maxLength": 255, "nullable": true }, "phone": { "type": "string", "maxLength": 45, "nullable": true } }, "required": [ "customerId", "firstName", "lastName", "email", "phone" ] }, "error": { "type": "object", "nullable": true, "enum": [ null ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] }, "example": { "success": true, "data": { "customerId": 123, "firstName": "Example", "lastName": "Customer", "email": "customer@example.test", "phone": null }, "error": null, "coreSso": { "apiVersion": "v1", "ssoVersion": "example-build", "ssoZone": null, "ssoReplicaSetHash": null, "ssoPodSuffix": null, "requestId": "00000000-0000-4000-8000-000000000002" } } } } }, "400": { "description": "Invalid request: only documented scalar parameters are accepted; request bodies are forbidden. On a service gateway, a request may expose at most 50000 parameters to the key policy (each scalar counts twice - once under query/body, once under the merged params view) and may not nest deeper than 12 levels; split a larger bulk write into smaller batches.", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "401": { "description": "Missing or invalid API credential, or credential belongs to another reseller", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "403": { "description": "Policy, service, account or key state denies access", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "404": { "description": "Unknown host or operation", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "409": { "description": "Authorization changed while this request was being admitted; refresh your policy and retry", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "429": { "description": "A shared quota or attempt limit was reached", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } }, "Retry-After": { "schema": { "type": "integer", "minimum": 1 }, "description": "Minimum seconds before retry" } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "503": { "description": "Authentication, account data, or admission is unavailable", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } } }, "parameters": [], "x-service-key": "identity.profile", "x-access": "read", "x-timeout-ms": 5000, "x-resource-kinds": [], "x-query-parameters-allowed": false, "x-request-body-allowed": false } }, "/usersApi/security": { "get": { "operationId": "usersApi.security.read", "summary": "Read security summary", "description": "Returns verified factor types and counts. Never returns factor identifiers, destinations, OTP secrets, recovery codes or registration options.", "x-summary-he": "קריאת מצב האבטחה", "x-description-he": "מחזיר אילו סוגי אימות דו-שלבי מוגדרים בחשבון וכמה מכל סוג. לא מוחזרים היעדים עצמם, לא סודות, לא קודי שחזור ולא אפשרות לשנות משהו.", "tags": [ "identity.security" ], "security": [ { "ApiKeyBearer": [] } ], "responses": { "200": { "description": "Successful response", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "additionalProperties": false, "properties": { "twoFactorEnabled": { "type": "boolean" }, "methods": { "type": "array", "maxItems": 5, "items": { "type": "object", "additionalProperties": false, "properties": { "type": { "type": "string", "enum": [ "PASSKEY", "APP", "SMS", "VOICE", "EMAIL" ] }, "count": { "type": "integer", "minimum": 1 } }, "required": [ "type", "count" ] } } }, "required": [ "twoFactorEnabled", "methods" ] }, "error": { "type": "object", "nullable": true, "enum": [ null ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] }, "example": { "success": true, "data": { "twoFactorEnabled": true, "methods": [ { "type": "PASSKEY", "count": 1 } ] }, "error": null, "coreSso": { "apiVersion": "v1", "ssoVersion": "example-build", "ssoZone": null, "ssoReplicaSetHash": null, "ssoPodSuffix": null, "requestId": "00000000-0000-4000-8000-000000000002" } } } } }, "400": { "description": "Invalid request: only documented scalar parameters are accepted; request bodies are forbidden. On a service gateway, a request may expose at most 50000 parameters to the key policy (each scalar counts twice - once under query/body, once under the merged params view) and may not nest deeper than 12 levels; split a larger bulk write into smaller batches.", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "401": { "description": "Missing or invalid API credential, or credential belongs to another reseller", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "403": { "description": "Policy, service, account or key state denies access", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "404": { "description": "Unknown host or operation", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "409": { "description": "Authorization changed while this request was being admitted; refresh your policy and retry", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "429": { "description": "A shared quota or attempt limit was reached", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } }, "Retry-After": { "schema": { "type": "integer", "minimum": 1 }, "description": "Minimum seconds before retry" } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "503": { "description": "Authentication, account data, or admission is unavailable", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } } }, "parameters": [], "x-service-key": "identity.security", "x-access": "read", "x-timeout-ms": 5000, "x-resource-kinds": [], "x-query-parameters-allowed": false, "x-request-body-allowed": false } }, "/apiKeys/self": { "get": { "operationId": "apikey.selfRead", "summary": "Read this key", "description": "Returns metadata for the credential’s own key. Subject to its permissions, expiry, reseller settings and shared quotas.", "x-summary-he": "קריאת המפתח הזה", "x-description-he": "מחזיר את פרטי המפתח שאיתו נשלחה הבקשה - שם, מצב, גרסת ההרשאות ותוקף. כפוף להרשאות המפתח, לתוקפו ולמכסות.", "tags": [ "identity.profile" ], "security": [ { "ApiKeyBearer": [] } ], "responses": { "200": { "description": "Successful response", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "name": { "type": "string", "maxLength": 100 }, "state": { "type": "string", "enum": [ "active", "suspended", "revoked" ] }, "policyVersion": { "type": "integer", "minimum": 1 }, "expiresAt": { "type": "string", "maxLength": 24, "nullable": true } }, "required": [ "id", "name", "state", "policyVersion", "expiresAt" ] }, "error": { "type": "object", "nullable": true, "enum": [ null ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] }, "example": { "success": true, "data": { "id": "00000000-0000-4000-8000-000000000001", "name": "My integration", "state": "active", "policyVersion": 1, "expiresAt": null }, "error": null, "coreSso": { "apiVersion": "v1", "ssoVersion": "example-build", "ssoZone": null, "ssoReplicaSetHash": null, "ssoPodSuffix": null, "requestId": "00000000-0000-4000-8000-000000000002" } } } } }, "400": { "description": "Invalid request: only documented scalar parameters are accepted; request bodies are forbidden. On a service gateway, a request may expose at most 50000 parameters to the key policy (each scalar counts twice - once under query/body, once under the merged params view) and may not nest deeper than 12 levels; split a larger bulk write into smaller batches.", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "401": { "description": "Missing or invalid API credential, or credential belongs to another reseller", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "403": { "description": "Policy, service, account or key state denies access", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "404": { "description": "Unknown host or operation", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "409": { "description": "Authorization changed while this request was being admitted; refresh your policy and retry", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "429": { "description": "A shared quota or attempt limit was reached", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } }, "Retry-After": { "schema": { "type": "integer", "minimum": 1 }, "description": "Minimum seconds before retry" } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "503": { "description": "Authentication, account data, or admission is unavailable", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } } }, "parameters": [], "x-service-key": "identity.profile", "x-access": "read", "x-timeout-ms": 5000, "x-resource-kinds": [], "x-query-parameters-allowed": false, "x-request-body-allowed": false }, "delete": { "operationId": "apikey.selfRevoke", "summary": "Disconnect this credential, and the key with it", "description": "Revokes the credential the request was sent with. An application authorisation holding several device connections loses only this one; every other kind of key, and the last remaining connection of an authorisation, revokes the key itself and all of its credentials. No target parameters are accepted. Works for suspended/expired keys and when business API access is disabled. A retired credential cannot revoke an otherwise active key. A credential issued to a device must present that device. Repeating a completed revocation returns revoked=true.", "x-summary-he": "ניתוק הסוד הזה, ואיתו המפתח", "x-description-he": "מבטל את הסוד שאיתו נשלחה הבקשה, ואותו בלבד - אין פרמטר שמאפשר לבטל מפתח אחר. הרשאת אפליקציה שמחזיקה חיבורים ממספר מכשירים מאבדת את החיבור הזה בלבד; כל מפתח אחר, וכן החיבור האחרון שנותר בהרשאה, מבטלים את המפתח עצמו על כל הסודות שלו. עובד גם כשהמפתח מושהה או פג, וגם כשגישת ה-API בחשבון כבויה. סוד שהוחלף בסבב אינו יכול לבטל מפתח פעיל. סוד שהונפק למכשיר חייב להציג את אותו מכשיר. ביטול חוזר מחזיר revoked=true.", "tags": [ "identity.profile" ], "security": [ { "ApiKeyBearer": [] } ], "responses": { "200": { "description": "Successful response", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "additionalProperties": false, "properties": { "revoked": { "type": "boolean", "enum": [ true ] } }, "required": [ "revoked" ] }, "error": { "type": "object", "nullable": true, "enum": [ null ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] }, "example": { "success": true, "data": { "revoked": true }, "error": null, "coreSso": { "apiVersion": "v1", "ssoVersion": "example-build", "ssoZone": null, "ssoReplicaSetHash": null, "ssoPodSuffix": null, "requestId": "00000000-0000-4000-8000-000000000002" } } } } }, "400": { "description": "Invalid request: only documented scalar parameters are accepted; request bodies are forbidden. On a service gateway, a request may expose at most 50000 parameters to the key policy (each scalar counts twice - once under query/body, once under the merged params view) and may not nest deeper than 12 levels; split a larger bulk write into smaller batches.", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "401": { "description": "Missing or invalid API credential, or credential belongs to another reseller", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "403": { "description": "Policy, service, account or key state denies access", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "404": { "description": "Unknown host or operation", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "409": { "description": "Authorization changed while this request was being admitted; refresh your policy and retry", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "429": { "description": "A shared quota or attempt limit was reached", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } }, "Retry-After": { "schema": { "type": "integer", "minimum": 1 }, "description": "Minimum seconds before retry" } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "503": { "description": "Authentication, account data, or admission is unavailable", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } } }, "parameters": [], "x-service-key": "identity.profile", "x-access": "selfRevoke", "x-timeout-ms": 5000, "x-resource-kinds": [], "x-query-parameters-allowed": false, "x-request-body-allowed": false } }, "/switches/search": { "get": { "operationId": "ivr.switches.list", "summary": "List owned switches", "description": "Lists active, open switches from billing. Ownership and acl.switches are applied before cursor pagination. No browser switch session is created.", "x-summary-he": "רשימת המרכזיות שלכם", "x-description-he": "מחזיר את המרכזיות הפעילות שבחשבון. הבעלות וההגבלה שהגדרתם במפתח מוחלות לפני העימוד. אין כאן פתיחת סשן למרכזייה.", "tags": [ "switches.list" ], "security": [ { "ApiKeyBearer": [] } ], "responses": { "200": { "description": "Successful response", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "additionalProperties": false, "properties": { "items": { "type": "array", "maxItems": 100, "items": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, "uuid": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, "switch_type": { "type": "integer", "nullable": true }, "switch_type_name": { "type": "string", "maxLength": 255, "nullable": true }, "name": { "type": "string", "maxLength": 255, "nullable": true }, "number": { "type": "string", "maxLength": 45, "nullable": true }, "contact_name": { "type": "string", "maxLength": 255, "nullable": true }, "purpose": { "type": "string", "maxLength": 255, "nullable": true }, "update_date_by_customer": { "type": "string", "maxLength": 30, "nullable": true } }, "required": [ "id", "uuid", "switch_type", "switch_type_name", "name", "number", "contact_name", "purpose", "update_date_by_customer" ] } }, "next": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$", "nullable": true } }, "required": [ "items", "next" ] }, "error": { "type": "object", "nullable": true, "enum": [ null ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] }, "example": { "success": true, "data": { "items": [ { "id": "00000000-0000-4000-8000-000000000001", "uuid": "00000000-0000-4000-8000-000000000001", "switch_type": 11, "switch_type_name": "Free system", "name": "Office", "number": "023130003", "contact_name": null, "purpose": null, "update_date_by_customer": null } ], "next": null }, "error": null, "coreSso": { "apiVersion": "v1", "ssoVersion": "example-build", "ssoZone": null, "ssoReplicaSetHash": null, "ssoPodSuffix": null, "requestId": "00000000-0000-4000-8000-000000000002" } } } } }, "400": { "description": "Invalid request: only documented scalar parameters are accepted; request bodies are forbidden. On a service gateway, a request may expose at most 50000 parameters to the key policy (each scalar counts twice - once under query/body, once under the merged params view) and may not nest deeper than 12 levels; split a larger bulk write into smaller batches.", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "401": { "description": "Missing or invalid API credential, or credential belongs to another reseller", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "403": { "description": "Policy, service, account or key state denies access", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "404": { "description": "Unknown host or operation", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "409": { "description": "Authorization changed while this request was being admitted; refresh your policy and retry", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "429": { "description": "A shared quota or attempt limit was reached", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } }, "Retry-After": { "schema": { "type": "integer", "minimum": 1 }, "description": "Minimum seconds before retry" } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "503": { "description": "Authentication, account data, or admission is unavailable", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 }, "description": "Maximum page size. A key pin can constrain this value." }, { "name": "after", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, "description": "Exclusive cursor returned by the previous page. Does not grant access to that ID." } ], "x-service-key": "switches.list", "x-access": "read", "x-timeout-ms": 8000, "x-resource-kinds": [ "ivr.switch" ], "x-query-parameters-allowed": true, "x-request-body-allowed": false } }, "/switches/get": { "get": { "operationId": "ivr.switches.get", "summary": "Read switch metadata", "description": "Selects a switch using the existing switch-id header. Checks current billing ownership, active/open state and the key scope. No IVR credentials or switch login tokens are returned.", "x-summary-he": "קריאת פרטי מרכזייה", "x-description-he": "בוחר מרכזייה לפי כותרת switch-id. נבדקת הבעלות בפועל, שהמרכזייה פעילה, ושהיא מותרת במפתח. לא מוחזרות סיסמאות ולא אסימוני כניסה.", "tags": [ "switches.list" ], "security": [ { "ApiKeyBearer": [] } ], "responses": { "200": { "description": "Successful response", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, "uuid": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, "switch_type": { "type": "integer", "nullable": true }, "switch_type_name": { "type": "string", "maxLength": 255, "nullable": true }, "name": { "type": "string", "maxLength": 255, "nullable": true }, "number": { "type": "string", "maxLength": 45, "nullable": true }, "contact_name": { "type": "string", "maxLength": 255, "nullable": true }, "purpose": { "type": "string", "maxLength": 255, "nullable": true }, "update_date_by_customer": { "type": "string", "maxLength": 30, "nullable": true } }, "required": [ "id", "uuid", "switch_type", "switch_type_name", "name", "number", "contact_name", "purpose", "update_date_by_customer" ] }, "error": { "type": "object", "nullable": true, "enum": [ null ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] }, "example": { "success": true, "data": { "id": "00000000-0000-4000-8000-000000000001", "uuid": "00000000-0000-4000-8000-000000000001", "switch_type": 11, "switch_type_name": "Free system", "name": "Office", "number": "023130003", "contact_name": null, "purpose": null, "update_date_by_customer": null }, "error": null, "coreSso": { "apiVersion": "v1", "ssoVersion": "example-build", "ssoZone": null, "ssoReplicaSetHash": null, "ssoPodSuffix": null, "requestId": "00000000-0000-4000-8000-000000000002" } } } } }, "400": { "description": "Invalid request: only documented scalar parameters are accepted; request bodies are forbidden. On a service gateway, a request may expose at most 50000 parameters to the key policy (each scalar counts twice - once under query/body, once under the merged params view) and may not nest deeper than 12 levels; split a larger bulk write into smaller batches.", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "401": { "description": "Missing or invalid API credential, or credential belongs to another reseller", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "403": { "description": "Policy, service, account or key state denies access", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "404": { "description": "Unknown host or operation", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "409": { "description": "Authorization changed while this request was being admitted; refresh your policy and retry", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "429": { "description": "A shared quota or attempt limit was reached", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } }, "Retry-After": { "schema": { "type": "integer", "minimum": 1 }, "description": "Minimum seconds before retry" } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } }, "503": { "description": "Authentication, account data, or admission is unavailable", "headers": { "X-Request-Id": { "schema": { "type": "string" }, "description": "Server-generated support identifier" }, "X-SSO-Version": { "schema": { "type": "string" }, "description": "Responding SSO build" }, "Cache-Control": { "schema": { "type": "string", "enum": [ "no-store" ] } } }, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } } } }, "parameters": [ { "name": "switch-id", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,50}$" }, "description": "Durable billing switch UUID. Never a browser session token." } ], "x-service-key": "switches.list", "x-access": "read", "x-timeout-ms": 8000, "x-resource-kinds": [ "ivr.switch" ], "x-query-parameters-allowed": false, "x-request-body-allowed": false } } }, "components": { "securitySchemes": { "ApiKeyBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "yk___" } }, "schemas": { "CoreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] }, "ApiError": { "type": "object", "additionalProperties": false, "properties": { "success": { "type": "boolean", "enum": [ false ] }, "data": { "type": "object", "nullable": true, "enum": [ null ] }, "error": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "maxLength": 100 }, "message": { "type": "string", "maxLength": 300 }, "details": { "type": "object", "nullable": true, "additionalProperties": true } }, "required": [ "code", "message", "details" ] }, "coreSso": { "type": "object", "additionalProperties": false, "properties": { "apiVersion": { "type": "string", "nullable": true, "enum": [ "v1", null ] }, "ssoVersion": { "type": "string", "maxLength": 200 }, "ssoZone": { "type": "string", "maxLength": 128, "nullable": true }, "ssoReplicaSetHash": { "type": "string", "maxLength": 128, "nullable": true }, "ssoPodSuffix": { "type": "string", "maxLength": 128, "nullable": true }, "requestId": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "warnings": { "type": "array", "maxItems": 1, "description": "Present during the final seven days before the API key expires, including a previous key in its rotation overlap period.", "items": { "type": "object", "additionalProperties": false, "properties": { "code": { "type": "string", "enum": [ "API_KEY_EXPIRING_SOON" ] }, "message": { "type": "string", "maxLength": 500 }, "expiresAt": { "type": "string", "maxLength": 24 }, "remainingSeconds": { "type": "integer", "minimum": 1, "maximum": 604800 }, "reason": { "type": "string", "enum": [ "keyExpiry", "rotationOverlap" ] } }, "required": [ "code", "message", "expiresAt", "remainingSeconds", "reason" ] } } }, "required": [ "apiVersion", "ssoVersion", "ssoZone", "ssoReplicaSetHash", "ssoPodSuffix", "requestId" ] } }, "required": [ "success", "data", "error", "coreSso" ] } } }, "x-operation-registry-version": "77863193ef432a19f21bee32526e2aa2072eb53aee55928dfd380018cd73e074" }