{"items":[{"type":"link","label":"Health API","link":"/docs/openapi/health-v1","routeSlug":"/docs/openapi/health-v1","content":{"contentType":"overview","meta":{"name":"Health API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"health-v1.json","url":"/_bundle/docs/openapi/health-v1.json?download"},{"kind":"download","label":"health-v1.yaml","url":"/_bundle/docs/openapi/health-v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/docs/openapi/health-v1","description":"Mock server","isMockServer":true},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Health API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Connectivity and credential validation check.\n\nUse this endpoint to verify that your API credentials are valid and to inspect the bound tenant, environment, and scopes."}],"sectionId":"/docs/openapi/health-v1"}],"sectionId":"/docs/openapi/health-v1"}]}]}},{"type":"group","label":"Health","link":"/docs/openapi/health-v1/health","routeSlug":"/docs/openapi/health-v1/health","items":[{"label":"Validate API credentials.\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/health-v1/health/get:b2b.health","routeSlug":"/docs/openapi/health-v1/health/get:b2b.health","metadata":{"seo":{"title":"Validate API credentials.\n","description":"Returns metadata for the authenticated service user: org, environment, scopes, and label. Useful for testing connectivity and verifying your credentials are valid."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET:b2b.Health","name":"Validate API credentials.\n","isWebhook":false,"pointer":"/paths/~1b2b~1v1~1health/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate API credentials.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns metadata for the authenticated service user: org, environment, scopes, and label. Useful for testing connectivity and verifying your credentials are valid.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"BearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"DeepAdmin-issued Keycloak access token obtained via the OAuth 2.0\nResource Owner Password Credentials grant against the DeepCloud SSO\nrealm. See the Service Users guide for the exchange flow."}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Org-Id","in":"header","schemaId":"schema_63","description":"Organization the call is acting on. The authenticated service user must be a member of this organization in DeepAdmin; otherwise the request returns 404.","required":true},{"name":"X-Environment","in":"header","schemaId":"schema_64","description":"Environment the call is scoped to. Resources are isolated per environment.","required":true}],"pointer":"/paths/~1b2b~1v1~1health/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/b2b/v1/health","servers":[{"url":"/_mock/docs/openapi/health-v1","description":"Mock server","isMockServer":true},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Org-Id","in":"header","required":true,"schemaId":"schema_63"},{"name":"X-Environment","in":"header","required":true,"schemaId":"schema_64"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/b2b/v1/health","href":"health/get:b2b.health","openApiOperationId":"GET:b2b.Health","summary":"Validate API credentials.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi/health-v1","description":"Mock server","isMockServer":true},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}},"schemaId":"schema_65"},{"code":"400","description":"Invalid request. Common causes: missing or malformed X-Org-Id / X-Environment headers, or a missing required field in the request body.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/400/content/application~1json/example"]},{"code":"401","description":"Unauthenticated. The Bearer token failed validation (signature, issuer, audience, or expiry).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/401/content/application~1json/example"]},{"code":"403","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permission denied. The token does not carry the scope required by this endpoint. Check the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" claim on the token you received from the DeepCloud SSO token endpoint."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/403/content/application~1json/example"]},{"code":"429","description":"Rate limit exceeded.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Internal server error.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1b2b~1v1~1health/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_65","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1health/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/health/get:b2b.health"}],"panels":[]}]},"httpPath":"/b2b/v1/health"}],"content":{"contentType":"group","meta":{"name":"Health"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Health","showPageActions":true},{"nodeType":"markdoc","content":"Validate connectivity and credential metadata."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/b2b/v1/health","summary":"Validate API credentials.\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/health/get:b2b.health","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Machine-readable error code."},"message":{"type":"string","description":"Human-readable error description."},"details":{"type":"object","description":"Optional structured data with additional context."}}}},"schema_63":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"type":"string","enum":["beta","production"]},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"properties":{"environment":{"description":"Environment scoping the call (from X-Environment).","type":"string"},"label":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Human-readable label sourced from the JWT (e.g. preferred_username for service"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accounts)."},"children":[]}]}]}],"type":"string"},"org_id":{"type":"string","format":"uuid","description":"UUID v4 identifier.","example":"550e8400-e29b-41d4-a716-446655440000"},"scopes":{"items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scopes granted to this service user (from the JWT "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scope"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" claim)."},"children":[]}]}]}],"type":"array"},"service_user_id":{"type":"string","format":"uuid","description":"UUID v4 identifier.","example":"550e8400-e29b-41d4-a716-446655440000"},"status":{"description":"Always \"ok\" when the request is authenticated.","type":"string"},"timestamp":{"description":"Response time in RFC3339 UTC (for client logging and skew checks).","type":"string"}},"required":["status","timestamp","service_user_id","org_id","environment","label","scopes"],"type":"object"},"id":"schema_65"}},"exampleStore":{"paths/~1b2b~1v1~1health/get/responses/400/content/application~1json/example":{"value":{"code":"invalid_argument","message":"X-Org-Id header is required."},"id":"paths/~1b2b~1v1~1health/get/responses/400/content/application~1json/example"},"paths/~1b2b~1v1~1health/get/responses/401/content/application~1json/example":{"value":{"code":"unauthenticated","message":"Missing or invalid Bearer token."},"id":"paths/~1b2b~1v1~1health/get/responses/401/content/application~1json/example"},"paths/~1b2b~1v1~1health/get/responses/403/content/application~1json/example":{"value":{"code":"permission_denied","message":"Token lacks the required scope."},"id":"paths/~1b2b~1v1~1health/get/responses/403/content/application~1json/example"},"paths/~1b2b~1v1~1health/get/responses/429/content/application~1json/example":{"value":{"code":"resource_exhausted","message":"Rate limit exceeded. Retry with backoff."},"id":"paths/~1b2b~1v1~1health/get/responses/429/content/application~1json/example"},"paths/~1b2b~1v1~1health/get/responses/500/content/application~1json/example":{"value":{"code":"internal","message":"An unexpected error occurred."},"id":"paths/~1b2b~1v1~1health/get/responses/500/content/application~1json/example"}},"securitySchemeStore":{"BearerAuth":{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT","description":"DeepAdmin-issued Keycloak access token obtained via the OAuth 2.0\nResource Owner Password Credentials grant against the DeepCloud SSO\nrealm. See the Service Users guide for the exchange flow."}},"servers":[{"url":"/_mock/docs/openapi/health-v1","isMockServer":true,"description":"Mock server"},{"url":"https://api.dev.deepcredentials.swiss","description":"Development"},{"url":"https://api.int.deepcredentials.swiss","description":"Integration"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/docs/openapi/health-v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/openapi/health-v1.json?download"},{"url":"/_bundle/docs/openapi/health-v1.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Health API","description":"Connectivity and credential validation check"}},"baseSlug":"/docs/openapi/health-v1","routesMapping":{}}