Delete a user (not supported)

ai-account
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

ai-analytics
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

ai-bot
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

ai-finetuning
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

ai-index
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

ai-marketing
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

ai-media
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

ai-mentor
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

ai-prompt
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

ai-search
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

analytics
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

career
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

catalog
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

core
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

credentials
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

custom-domains
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

features
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

media
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

notifications
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

scim
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

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

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