{"items":[{"type":"link","label":"Credential Definitions API","link":"/docs/openapi/credential-definitions-v1","routeSlug":"/docs/openapi/credential-definitions-v1","content":{"contentType":"overview","meta":{"name":"Credential Definitions API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"credential-definitions-v1.json","url":"/_bundle/docs/openapi/credential-definitions-v1.json?download"},{"kind":"download","label":"credential-definitions-v1.yaml","url":"/_bundle/docs/openapi/credential-definitions-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/credential-definitions-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":"Credential Definitions API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"List the credential definitions available to your organization.\n\nUse this API to discover the credential definitions you can issue or verify against, and to read their claim schemas. Available to any authenticated service user."}],"sectionId":"/docs/openapi/credential-definitions-v1"}],"sectionId":"/docs/openapi/credential-definitions-v1"}]}]}},{"type":"group","label":"Credential Definitions","link":"/docs/openapi/credential-definitions-v1/credential-definitions","routeSlug":"/docs/openapi/credential-definitions-v1/credential-definitions","items":[{"label":"List credential definitions.\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/openapi/credential-definitions-v1/credential-definitions/get:b2b.listcredentialdefinitions","routeSlug":"/docs/openapi/credential-definitions-v1/credential-definitions/get:b2b.listcredentialdefinitions","metadata":{"seo":{"title":"List credential definitions.\n","description":"Returns the credential definitions available to the calling service user's organization (X-Org-Id) in its environment (X-Environment): the org's own definitions plus the system/official/public ones it may use. Available to any authenticated service user — no specific scope is required."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET:b2b.ListCredentialDefinitions","name":"List credential definitions.\n","isWebhook":false,"pointer":"/paths/~1b2b~1v1~1credential-definitions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List credential definitions.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the credential definitions available to the calling service user's organization (X-Org-Id) in its environment (X-Environment): the org's own definitions plus the system/official/public ones it may use. Available to any authenticated service user — no specific scope is required."},"children":[]}]}]}]},{"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_47","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_48","description":"Environment the call is scoped to. Resources are isolated per environment.","required":true}],"pointer":"/paths/~1b2b~1v1~1credential-definitions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/b2b/v1/credential-definitions","servers":[{"url":"/_mock/docs/openapi/credential-definitions-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_47"},{"name":"X-Environment","in":"header","required":true,"schemaId":"schema_48"}],"cookie":[]},"security":[{"schemes":[{"id":"BearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","429","500"],"pointer":"/b2b/v1/credential-definitions","href":"credential-definitions/get:b2b.listcredentialdefinitions","openApiOperationId":"GET:b2b.ListCredentialDefinitions","summary":"List credential definitions.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/docs/openapi/credential-definitions-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_49"}},"schemaId":"schema_49"},{"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~1credential-definitions/get/responses/400/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1credential-definitions/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~1credential-definitions/get/responses/401/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1credential-definitions/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~1credential-definitions/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1credential-definitions/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~1credential-definitions/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1credential-definitions/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~1credential-definitions/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1credential-definitions/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1b2b~1v1~1credential-definitions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1credential-definitions/get/responses/400/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1credential-definitions/get/responses/400/content/application~1json/example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1credential-definitions/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1credential-definitions/get/responses/401/content/application~1json/example"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1credential-definitions/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1credential-definitions/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1credential-definitions/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1credential-definitions/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1credential-definitions/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1b2b~1v1~1credential-definitions/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credential-definitions/get:b2b.listcredentialdefinitions"}],"panels":[]}]},"httpPath":"/b2b/v1/credential-definitions"}],"content":{"contentType":"group","meta":{"name":"Credential Definitions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credential Definitions","showPageActions":true},{"nodeType":"markdoc","content":"List available credential definitions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/b2b/v1/credential-definitions","summary":"List credential definitions.\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credential-definitions/get:b2b.listcredentialdefinitions","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."}}}},"components/schemas/b2b.b2bClaimDefinition":{"id":"components/schemas/b2b.b2bClaimDefinition","kind":"json-schema","title":"b2b.b2bClaimDefinition","data":{"properties":{"display":{"items":{"$ref":"#/components/schemas/b2b.b2bClaimDisplay"},"description":"Localized display names for this claim, one entry per supported locale.","type":"array"},"mandatory":{"description":"Whether this claim must be provided when creating a credential offer.","type":"boolean"},"value_type":{"description":"Expected value type: \"string\", \"boolean\", \"integer\", or \"number\".","type":"string"}},"required":["mandatory","value_type","display"],"description":"Schema definition for a single credential claim.","type":"object"}},"components/schemas/b2b.b2bCredentialDefinition":{"id":"components/schemas/b2b.b2bCredentialDefinition","kind":"json-schema","title":"b2b.b2bCredentialDefinition","data":{"properties":{"claims":{"additionalProperties":{"$ref":"#/components/schemas/b2b.b2bClaimDefinition"},"description":"Claim schema: map of claim key to claim definition.","type":"object"},"credential_definition_id":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Credential definition UUID (use as credential_definition_id in offer requests). UUID v4 identifier."},"children":[]}]}]}]},"default_validity_seconds":{"format":"int64","description":"DefaultValiditySeconds is the default validity used when issuing a credential from this credential definition if the issuance request doesn't override it. NULL means the credential is issued without an \"exp\" claim (never expires).","type":"integer"},"environments":{"items":{"type":"string"},"description":"Swiyu environments this credential definition is available in: \"beta\" and/or\n\"production\".","type":"array"},"has_logo":{"description":"Whether this credential definition currently has an uploaded logo.","type":"boolean"},"is_official":{"description":"Whether this is an official (government-issued) credential definition.","type":"boolean"},"is_system":{"description":"Whether this is a system credential definition available to all organizations.","type":"boolean"},"name":{"description":"Human-readable credential definition name.","type":"string"},"vct":{"description":"Verifiable credential type (vct).","type":"string"}},"required":["credential_definition_id","name","vct","claims","environments","default_validity_seconds","is_official","is_system","has_logo"],"description":"A credential definition available to your organization.","type":"object"}},"components/schemas/b2b.b2bClaimDisplay":{"id":"components/schemas/b2b.b2bClaimDisplay","kind":"json-schema","title":"b2b.b2bClaimDisplay","data":{"properties":{"locale":{"description":"BCP-47 locale tag (e.g. \"en\", \"de\").","type":"string"},"name":{"description":"Localized display name for this claim.","type":"string"}},"required":["name","locale"],"description":"Localized display metadata for a single credential claim.","type":"object"}},"schema_47":{"kind":"json-schema","data":{"type":"string","format":"uuid"},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"type":"string","enum":["beta","production"]},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"properties":{"credential_definitions":{"items":{"$ref":"#/components/schemas/b2b.b2bCredentialDefinition"},"description":"Credential definitions available to the calling organization.","type":"array"},"total":{"format":"int64","description":"Total number of credential definitions returned.","type":"integer"}},"required":["credential_definitions","total"],"type":"object"},"id":"schema_49"}},"exampleStore":{"paths/~1b2b~1v1~1credential-definitions/get/responses/400/content/application~1json/example":{"value":{"code":"invalid_argument","message":"X-Org-Id header is required."},"id":"paths/~1b2b~1v1~1credential-definitions/get/responses/400/content/application~1json/example"},"paths/~1b2b~1v1~1credential-definitions/get/responses/401/content/application~1json/example":{"value":{"code":"unauthenticated","message":"Missing or invalid Bearer token."},"id":"paths/~1b2b~1v1~1credential-definitions/get/responses/401/content/application~1json/example"},"paths/~1b2b~1v1~1credential-definitions/get/responses/403/content/application~1json/example":{"value":{"code":"permission_denied","message":"Token lacks the required scope."},"id":"paths/~1b2b~1v1~1credential-definitions/get/responses/403/content/application~1json/example"},"paths/~1b2b~1v1~1credential-definitions/get/responses/429/content/application~1json/example":{"value":{"code":"resource_exhausted","message":"Rate limit exceeded. Retry with backoff."},"id":"paths/~1b2b~1v1~1credential-definitions/get/responses/429/content/application~1json/example"},"paths/~1b2b~1v1~1credential-definitions/get/responses/500/content/application~1json/example":{"value":{"code":"internal","message":"An unexpected error occurred."},"id":"paths/~1b2b~1v1~1credential-definitions/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/credential-definitions-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/credential-definitions-v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/openapi/credential-definitions-v1.json?download"},{"url":"/_bundle/docs/openapi/credential-definitions-v1.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Credential Definitions API","description":"List the credential definitions available to your organization"}},"baseSlug":"/docs/openapi/credential-definitions-v1","routesMapping":{}}