Skip to content
API Reference
/
credentials
/
credentials_orgs_users_assertions_over_time_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_assertions_retrieve

Request

Endpoint to retrieve all credential assertions for a user within an organization.

This endpoint provides access to all credential assertions (issued credentials) for a specific user within an organization, with support for filtering.

Path Parameters: org (str): The organization/tenant identifier user_id (str): The user ID to retrieve assertions for

Query Parameters: course (str, optional): Filter by course ID include_revoked (bool, optional): Include revoked assertions (default: false) include_expired (bool, optional): Include expired assertions (default: false) exclude_main_tenant_assertions (bool, optional): Exclude assertions from the main tenant (default: false)

Returns: A paginated response using the AssertionSerializer format

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

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
coursestringnon-empty
exclude_main_tenant_assertionsboolean
include_expiredboolean
include_revokedboolean
pageinteger>= 1
page_sizeinteger[ 1 .. 1000 ]
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/assertions/?course=string&exclude_main_tenant_assertions=true&include_expired=true&include_revoked=true&page=1&page_size=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
nextstringrequired
previousstringrequired
countintegerrequired
num_pagesintegerrequired
page_numberintegerrequired
max_page_sizeintegerrequired
dataArray of objects(Assertion)required
data[].​entityIdstringrequired
data[].​issuedOnstringrequired
data[].​credentialDetailsobjectread-onlyrequired
data[].​credentialDetails.​property name*stringadditional property
data[].​recipientobjectread-onlyrequired
data[].​recipient.​property name*stringadditional property
data[].​metadataany or null
data[].​courseobjectread-onlyrequired
data[].​course.​property name*stringadditional property
data[].​programobjectread-onlyrequired
data[].​program.​property name*stringadditional property
data[].​narrativestring or null
data[].​revokedboolean
data[].​revocationReasonstringrequired
data[].​acceptancestring(AcceptanceEnum)
  • Unaccepted - Unaccepted
  • Accepted - Accepted
  • Rejected - Rejected
Enum"Unaccepted""Accepted""Rejected"
data[].​expiresstringrequired
Response
application/json
{
  "next": "string",
  "previous": "string",
  "count": 0,
  "num_pages": 0,
  "page_number": 0,
  "max_page_size": 0,
  "data": [
    { … }
  ]
}

credentials_orgs_users_assertions_over_time_retrieve

Request

Get all credentials of a given tenant

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
department_idinteger

When department_mode=1 is passed, it allows to filter data for only user content groups for the specified department

end_datestringnon-empty

end date. ISO 8601

formatstringnon-empty

Format

  • json - json
Default "json"
Value"json"
include_main_platformboolean

Include main platform data

Default true
start_datestringnon-empty

start date. ISO 8601

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/credentials/orgs/{org}/users/{user_id}/assertions-over-time/?department_id=0&end_date=string&format=json&include_main_platform=true&start_date=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
dataobject

Dates are keys and values are the value for the date in the key. e,g {"2020-01-01": 30. ...}

totalinteger

Total

metaobject(OvertimeMeta)required
meta.​totalintegerrequired

Total records

meta.​change_rangeinteger

Change in range

Default 0
meta.​change_last_seven_daysinteger

Change in last 7 days

Default 0
meta.​change_last_thirty_daysinteger

Change in last 30 days

Default 0
meta.​change_last_seven_days_percentnumber(double)

Change in last 7 days in percentage

Default 0
meta.​change_last_thirty_days_percentnumber(double)

Change in last 30 days in percentage

Default 0
meta.​change_range_percentnumber(double)

Change in range in percentage

Response
application/json
{
  "data": {
    "property1": null,
    "property2": null
  },
  "total": 0,
  "meta": {
    "total": 0,
    "change_range": 0,
    "change_last_seven_days": 0,
    "change_last_thirty_days": 0,
    "change_last_seven_days_percent": 0,
    "change_last_thirty_days_percent": 0,
    "change_range_percent": 0.1
  }
}

credentials_orgs_users_assertions_retrieve_2

Request

Endpoint to retrieve and update a specific credential assertion.

This endpoint allows retrieving details of a specific credential assertion and updating its status (e.g., revoking it).

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

Methods: GET: Retrieve assertion details PUT: Update assertion status (e.g., revoke)

PUT Request Body: A JSON object containing:

  • revoked (bool): Set to true to revoke the assertion
  • revocationReason (str): Reason for revocation (required when revoking)

Returns: GET: A JSON response containing the assertion details using the AssertionSerializer format PUT: A JSON response containing the updated assertion using the AssertionSerializer format

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

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}/assertions/{entity_id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
entityIdstringrequired
issuedOnstringrequired
credentialDetailsobjectread-onlyrequired
credentialDetails.​property name*stringadditional property
recipientobjectread-onlyrequired
recipient.​property name*stringadditional property
metadataany or null
courseobjectread-onlyrequired
course.​property name*stringadditional property
programobjectread-onlyrequired
program.​property name*stringadditional property
narrativestring or null
revokedboolean
revocationReasonstringrequired
acceptancestring(AcceptanceEnum)
  • Unaccepted - Unaccepted
  • Accepted - Accepted
  • Rejected - Rejected
Enum"Unaccepted""Accepted""Rejected"
expiresstringrequired
Response
application/json
{
  "entityId": "string",
  "issuedOn": "string",
  "credentialDetails": {
    "property1": "string",
    "property2": "string"
  },
  "recipient": {
    "property1": "string",
    "property2": "string"
  },
  "metadata": null,
  "course": {
    "property1": "string",
    "property2": "string"
  },
  "program": {
    "property1": "string",
    "property2": "string"
  },
  "narrative": "string",
  "revoked": true,
  "revocationReason": "string",
  "acceptance": "Unaccepted",
  "expires": "string"
}

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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