Skip to content
APIs
/
Credential Definitions AP...
/Credential Definitions

Credential Definitions

List available credential definitions.

Operations

List credential definitions.

Request

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.

Security
BearerAuth
Headers
X-Org-Idstring, (uuid)required

Organization the call is acting on. The authenticated service user must be a member of this organization in DeepAdmin; otherwise the request returns 404.

X-Environmentstringrequired

Environment the call is scoped to. Resources are isolated per environment.

Enum:"beta""production"
curl -i -X GET \
  https://docs.deepcredentials.swiss/_mock/docs/openapi/credential-definitions-v1/b2b/v1/credential-definitions \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Environment: beta' \
  -H 'X-Org-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'

Responses

Success response

Bodyapplication/json
credential_definitionsArray of objects(b2b.b2bCredentialDefinition)required

Credential definitions available to the calling organization.

totalinteger, (int64)required

Total number of credential definitions returned.

Response
{
  "credential_definitions": [
    { … }
  ],
  "total": 0
}