Skip to content
API Reference
/
credentials
/
credentials_orgs_users_retrieve

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

credentials_orgs_users_retrieve

Request

Get all credentials for a platform with search and pagination support.

Query Parameters:

  • platform_org: Platform org ID (takes precedence over URL org)
  • page: Page number (default: 1)
  • page_size: Items per page (default: 10, max: 100)
  • search: Search term to filter credentials
  • course: Course ID to filter credentials
  • program: Program ID to filter credentials
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_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": [
    { … }
  ]
}

credentials_orgs_users_create

Request

API View for managing credentials across a platform.

This endpoint allows creating and retrieving credentials for a specific organization/tenant, with support for filtering, searching, and pagination.

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

Query Parameters:

Platform identification

platform_org (str, optional): Alternative platform identifier (takes precedence over URL org)

Pagination

page (int, optional): Page number (default: 1) page_size (int, optional): Items per page (default: 10, max: 100)

Filtering and search

search (str, optional): Search term to filter credentials by name or description course (str, optional): Course ID to filter credentials associated with a specific course program (str, optional): Program ID to filter credentials associated with a specific program

Methods: GET: Retrieve credentials with filtering and pagination POST: Create a new credential

POST Request Body: A JSON object containing credential details:

  • name (str): Credential name
  • description (str, optional): Credential description
  • issuer (str): Issuer entity ID
  • 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": { "next": "URL to next page", "previous": "URL to previous page", "count": 42, "data": [ {credential object}, {credential object}, ... ], "num_pages": 5, "page_number": 1, "max_page_size": 100 } }

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

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 platform doesn't exist 500 Internal Server Error: If an unexpected error occurs

Access Control:

  • Requires CredentialAssignmentPermission
  • Only public credentials are returned by default
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Body
required
entityIdstringrequired
namestring<= 1000 charactersrequired
name_overridestring or null<= 1000 characters
descriptionstring or null
criteriaUrlstring(uri)required
criteriaNarrativestring(uri)required
createdAtstring(date-time)required
icon_image_idintegerrequired
background_image_idintegerrequired
thumbnail_image_idintegerrequired
html_templatestring or null
css_templatestring or null
metadataany or null
credentialTypestringrequired
tagsany or null
signalstringrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "entityId": "string",
    "name": "string",
    "name_override": "string",
    "description": "string",
    "criteriaUrl": "http://example.com",
    "criteriaNarrative": "http://example.com",
    "createdAt": "2019-08-24T14:15:22Z",
    "icon_image_id": 0,
    "background_image_id": 0,
    "thumbnail_image_id": 0,
    "html_template": "string",
    "css_template": "string",
    "metadata": null,
    "credentialType": "string",
    "tags": null,
    "signal": "string"
  }'

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": [
    { … }
  ]
}

credentials_orgs_users_retrieve_2

Request

API View for managing individual credentials.

This endpoint allows retrieving, updating, and deleting specific credentials identified by their entity_id.

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": [
    { … }
  ]
}

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com