credentials_orgs_users

Path Parameters: org (str): The organization/tenant identifier user_id (str): The user ID making the request entity_id (str): The credential entity ID

Methods: GET: Retrieve a specific credential PUT: Update a specific credential DELETE: Delete a specific credential

PUT Request Body: A JSON object containing credential details to update:

name (str, optional): Credential name
description (str, optional): Credential description
credential_type (str, optional): Type of credential
html_template (str, optional): HTML template for credential rendering
css_template (str, optional): CSS template for credential styling
icon_image (str, optional): URL to credential icon
background_image (str, optional): URL to credential background
thumbnail_image (str, optional): URL to credential thumbnail
criteria_url (str, optional): URL to credential criteria
criteria_text (str, optional): Text description of credential criteria
issuing_signal (str, optional): Signal that triggers credential issuance

Returns: GET: A JSON response containing: { "status": {"success": true, "description": "Ok"}, "result": {credential object} }

PUT: A JSON response containing: { "status": {"success": true, "description": "Updated"}, "result": {credential object} }

DELETE: No content (204)

Error Responses: 400 Bad Request: If the request data is invalid 401 Unauthorized: If the user is not authenticated 403 Forbidden: If the user does not have permission to access this resource 404 Not Found: If the credential doesn't exist 500 Internal Server Error: If an unexpected error occurs

Access Control:

Requires CredentialAssignmentPermission
Users can only manage credentials they have permission to access

Security

PlatformApiKeyAuthentication

Path

entity_idstringrequired

orgstringrequired

user_idstringrequired

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/{entity_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

entityIdstringrequired

namestring<= 1000 charactersrequired

name_overridestring or null<= 1000 characters

descriptionstring or null

criteriaUrlstring(uri)required

criteriaNarrativestring(uri)required

createdAtstring(date-time)required

iconImagestringread-onlyrequired

icon_image_idintegerrequired

backgroundImagestringread-onlyrequired

background_image_idintegerrequired

thumbnailImagestringread-onlyrequired

thumbnail_image_idintegerrequired

catalog_itemsArray of stringsread-onlyrequired

coursesArray of objectsread-onlyrequired

courses[].property name*stringadditional property

programsstringread-onlyrequired

issuerDetailsobjectread-onlyrequired

issuerDetails.property name*stringadditional property

html_templatestring or null

css_templatestring or null

metadataany or null

credentialTypestringrequired

expiresobjectread-onlyrequired

expires.property name*integeradditional property

tagsany or null

signatoriesArray of objectsread-onlyrequired

signatories[].property name*stringadditional property

signalstringrequired

pathwaysArray of objectsread-onlyrequired

pathways[].property name*stringadditional property

Response

application/json

{
  "entityId": "string",
  "name": "string",
  "name_override": "string",
  "description": "string",
  "criteriaUrl": "http://example.com",
  "criteriaNarrative": "http://example.com",
  "createdAt": "2019-08-24T14:15:22Z",
  "iconImage": "string",
  "icon_image_id": 0,
  "backgroundImage": "string",
  "background_image_id": 0,
  "thumbnailImage": "string",
  "thumbnail_image_id": 0,
  "catalog_items": [
    "string"
  ],
  "courses": [
    { … }
  ],
  "programs": "string",
  "issuerDetails": {
    "property1": "string",
    "property2": "string"
  },
  "html_template": "string",
  "css_template": "string",
  "metadata": null,
  "credentialType": "string",
  "expires": {
    "property1": 0,
    "property2": 0
  },
  "tags": null,
  "signatories": [
    { … }
  ],
  "signal": "string",
  "pathways": [
    { … }
  ]
}