Skip to content
API Reference/
/
Delete a user (not suppor...

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

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

Partially update an existing user

Request

Partially update an existing user's information using PATCH method

Security
PlatformApiKeyAuthentication
Path
idstringrequired
platform_keystringrequired
Query
formatstring
Enum"json""scim+json"
Body
schemasArray of strings

SCIM schema identifiers

idstring

User ID

userNamestring

Username

nameobject
emailsArray of objects(SCIMEmail)

User's email addresses

activeboolean

Whether the user is active

urn_ietf_params_scim_schemas_extension_enterprise_2_0_Userobject
metaobject
curl -i -X PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/orgs/{platform_key}/scim/v2/Users/{id}?format=json' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/scim+json' \
  -d '{
    "schemas": [
      "string"
    ],
    "id": "string",
    "userName": "string",
    "name": {
      "formatted": "string",
      "familyName": "string",
      "givenName": "string"
    },
    "emails": [
      {
        "value": "user@example.com",
        "primary": true,
        "type": "work"
      }
    ],
    "active": true,
    "urn_ietf_params_scim_schemas_extension_enterprise_2_0_User": {
      "edxData": null,
      "userData": null,
      "departments": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "groups": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "rbacGroups": [
        {
          "property1": null,
          "property2": null
        }
      ],
      "platforms": [
        {
          "property1": null,
          "property2": null
        }
      ]
    },
    "meta": {
      "resourceType": "string",
      "created": "string",
      "lastModified": "string",
      "version": "string",
      "location": "string"
    }
  }'

Responses

Body
schemasArray of stringsrequired

SCIM schema identifiers

idstringrequired

User ID

userNamestringrequired

Username

nameobjectrequired
name.​formattedstringrequired

Full formatted name

name.​familyNamestringrequired

Family/last name

name.​givenNamestringrequired

Given/first name

emailsArray of objects(SCIMEmail)required

User's email addresses

emails[].​valuestring(email)required

Email address

emails[].​primaryboolean

Whether this is the primary email

Default true
emails[].​typestring

Email type (work, home, etc.)

Default "work"
activebooleanrequired

Whether the user is active

urn_ietf_params_scim_schemas_extension_enterprise_2_0_Userobjectrequired
urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.​edxDataany

edX user data

urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.​userDataany

User metadata

urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.​departmentsArray of objects

List of department memberships

urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.​groupsArray of objects

List of group memberships

urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.​rbacGroupsArray of objects

List of RBAC groups the user belongs to

urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.​platformsArray of objects

List of platforms the user has access to

metaobject
Response
{
  "schemas": [
    "string"
  ],
  "id": "string",
  "userName": "string",
  "name": {
    "formatted": "string",
    "familyName": "string",
    "givenName": "string"
  },
  "emails": [
    { … }
  ],
  "active": true,
  "urn_ietf_params_scim_schemas_extension_enterprise_2_0_User": {
    "edxData": null,
    "userData": null,
    "departments": [ … ],
    "groups": [ … ],
    "rbacGroups": [ … ],
    "platforms": [ … ]
  },
  "meta": {
    "resourceType": "string",
    "created": "string",
    "lastModified": "string",
    "version": "string",
    "location": "string"
  }
}

Delete a user (not supported)

Request

Delete a user for the specified platform (not supported)

Security
PlatformApiKeyAuthentication
Path
idstringrequired
platform_keystringrequired
Query
formatstring
Enum"json""scim+json"
curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/orgs/{platform_key}/scim/v2/Users/{id}?format=json' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Body
any

Method not allowed - User deletion is not supported via SCIM

Response
null

Get details of a specific user

Request

Get details of a specific user by ID for the specified platform

Security
PlatformApiKeyAuthentication
Path
idstringrequired
platform_keystringrequired
Query
formatstring
Enum"json""scim+json"
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/orgs/{platform_key}/scim/v2/Users/{id}/?format=json' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Body
schemasArray of stringsrequired

SCIM schema identifiers

idstringrequired

User ID

userNamestringrequired

Username

nameobjectrequired
name.​formattedstringrequired

Full formatted name

name.​familyNamestringrequired

Family/last name

name.​givenNamestringrequired

Given/first name

emailsArray of objects(SCIMEmail)required

User's email addresses

emails[].​valuestring(email)required

Email address

emails[].​primaryboolean

Whether this is the primary email

Default true
emails[].​typestring

Email type (work, home, etc.)

Default "work"
activebooleanrequired

Whether the user is active

urn_ietf_params_scim_schemas_extension_enterprise_2_0_Userobjectrequired
urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.​edxDataany

edX user data

urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.​userDataany

User metadata

urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.​departmentsArray of objects

List of department memberships

urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.​groupsArray of objects

List of group memberships

urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.​rbacGroupsArray of objects

List of RBAC groups the user belongs to

urn_ietf_params_scim_schemas_extension_enterprise_2_0_User.​platformsArray of objects

List of platforms the user has access to

metaobject
Response
{
  "schemas": [
    "string"
  ],
  "id": "string",
  "userName": "string",
  "name": {
    "formatted": "string",
    "familyName": "string",
    "givenName": "string"
  },
  "emails": [
    { … }
  ],
  "active": true,
  "urn_ietf_params_scim_schemas_extension_enterprise_2_0_User": {
    "edxData": null,
    "userData": null,
    "departments": [ … ],
    "groups": [ … ],
    "rbacGroups": [ … ],
    "platforms": [ … ]
  },
  "meta": {
    "resourceType": "string",
    "created": "string",
    "lastModified": "string",
    "version": "string",
    "location": "string"
  }
}

commerce

Operations

recommendations

Operations

reports

Operations

skills

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