Skip to content
API Reference/
/
credentials_orgs_users_up...

ibl-data-manager (4.84.1-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

analytics

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

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
credential_idstringrequired
credential_urlstringrequired
namestringrequired
credential_typestring or null
issuerstring or null
issued_onstring or null(date-time)
expires_atstring or null(date-time)
revokedbooleanrequired
Response
application/json
{
  "credential_id": "string",
  "credential_url": "string",
  "name": "string",
  "credential_type": "string",
  "issuer": "string",
  "issued_on": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "revoked": true
}

credentials_orgs_users_update

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
Body
required
credential_idstringrequired
credential_urlstringrequired
namestringrequired
credential_typestring or null
issuerstring or null
issued_onstring or null(date-time)
expires_atstring or null(date-time)
revokedbooleanrequired
curl -i -X PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/{entity_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "credential_id": "string",
    "credential_url": "string",
    "name": "string",
    "credential_type": "string",
    "issuer": "string",
    "issued_on": "2019-08-24T14:15:22Z",
    "expires_at": "2019-08-24T14:15:22Z",
    "revoked": true
  }'

Responses

Bodyapplication/json
credential_idstringrequired
credential_urlstringrequired
namestringrequired
credential_typestring or null
issuerstring or null
issued_onstring or null(date-time)
expires_atstring or null(date-time)
revokedbooleanrequired
Response
application/json
{
  "credential_id": "string",
  "credential_url": "string",
  "name": "string",
  "credential_type": "string",
  "issuer": "string",
  "issued_on": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "revoked": true
}

credentials_orgs_users_destroy

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 DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/{entity_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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