Skip to content
API Reference/
/
Partially update an exist...

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

Update a user

Request

Update a user for the specified platform

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

SCIM schema identifiers

Default ["urn:ietf:params:scim:schemas:core:2.0:User"]
userNamestringrequired

Unique username/email for the user

nameobjectrequired

User's name information

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"
activeboolean

Whether the user is active

Default true
displayNamestring

Display name

localestring

User locale

timezonestring

User timezone

titlestring

Job title

organizationstring

Organization

phoneNumbersArray of objects(SCIMPhoneNumber)

Phone numbers

addressesArray of objects(SCIMAddress)

Addresses

entitlementsArray of strings

User entitlements

rolesArray of strings

User roles

x509CertificatesArray of strings

X.509 certificates

passwordstring

User password

providerstring

Authentication provider

tpaUidstring

Third-party authentication UID

isStaffboolean

Whether the user is a staff member

Default false
updateboolean

Whether to update existing user

Default false
platformOrgsArray of strings

List of platform organizations to link the user to

departmentIdsArray of integers

List of department IDs to make the user a member of

groupIdsArray of integers

List of group IDs to add the user to

rbacGroupUniqueIdsArray of strings

List of RBAC group unique IDs to add the user to

metaobject

Resource metadata

curl -i -X PUT \
  '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": [
      "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "userName": "string",
    "name": {
      "formatted": "string",
      "familyName": "string",
      "givenName": "string"
    },
    "emails": [
      {
        "value": "user@example.com",
        "primary": true,
        "type": "work"
      }
    ],
    "active": true,
    "displayName": "string",
    "locale": "string",
    "timezone": "string",
    "title": "string",
    "organization": "string",
    "phoneNumbers": [
      {
        "value": "string",
        "type": "string"
      }
    ],
    "addresses": [
      {
        "type": "string",
        "formatted": "string",
        "streetAddress": "string",
        "locality": "string",
        "region": "string",
        "postalCode": "string",
        "country": "string"
      }
    ],
    "entitlements": [
      "string"
    ],
    "roles": [
      "string"
    ],
    "x509Certificates": [
      "string"
    ],
    "password": "string",
    "provider": "string",
    "tpaUid": "string",
    "isStaff": false,
    "update": false,
    "platformOrgs": [
      "string"
    ],
    "departmentIds": [
      0
    ],
    "groupIds": [
      0
    ],
    "rbacGroupUniqueIds": [
      "string"
    ],
    "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

User's name information

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

Enterprise user extension data

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

Resource metadata

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"
  }
}

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

User's name information

emailsArray of objects(SCIMEmail)

User's email addresses

activeboolean

Whether the user is active

urn_ietf_params_scim_schemas_extension_enterprise_2_0_Userobject

Enterprise user extension data

metaobject

Resource metadata

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

User's name information

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

Enterprise user extension data

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

Resource metadata

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

commerce

Operations

recommendations

Operations

reports

Operations

skills

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