Skip to content
API Reference/
/
List existing RBAC groups

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

List existing RBAC groups

Request

List all existing RBAC groups for the specified platform. Only returns groups that have been pre-created in the RBAC system.

Security
PlatformApiKeyAuthentication
Path
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/Groups?format=json' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Body
Array [
schemasArray of stringsrequired

SCIM schema identifiers

totalResultsintegerrequired

Total number of results

ResourcesArray of objectsrequired

List of group resources

Resources[].​property name*anyadditional property
startIndexinteger

Starting index

itemsPerPageinteger

Items per page

]
Response
[
  {
    "schemas": [ … ],
    "totalResults": 0,
    "Resources": [ … ],
    "startIndex": 0,
    "itemsPerPage": 0
  }
]

Manage existing user group

Request

Add/remove users from an existing RBAC group for the specified platform. Does not create new groups.

Security
PlatformApiKeyAuthentication
Path
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:Group"]
idstringrequired

RBAC group unique ID (must match existing RBAC group)

displayNamestringrequired

RBAC group display name

descriptionstring

RBAC group description

membersArray of objects

Users to add/remove from the RBAC group

metaobject
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/orgs/{platform_key}/scim/v2/Groups?format=json' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/scim+json' \
  -d '{
    "schemas": [
      "urn:ietf:params:scim:schemas:core:2.0:Group"
    ],
    "id": "string",
    "displayName": "string",
    "description": "string",
    "members": [
      {
        "property1": null,
        "property2": null
      }
    ],
    "meta": {
      "resourceType": "string",
      "created": "string",
      "lastModified": "string",
      "version": "string",
      "location": "string"
    }
  }'

Responses

Body
schemasArray of strings

SCIM schema identifiers

Default ["urn:ietf:params:scim:schemas:core:2.0:Group"]
idstringrequired

RBAC group unique ID (must match existing RBAC group)

displayNamestringrequired

RBAC group display name

descriptionstring

RBAC group description

membersArray of objects

Users to add/remove from the RBAC group

metaobject
Response
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "string",
  "displayName": "string",
  "description": "string",
  "members": [
    { … }
  ],
  "meta": {
    "resourceType": "string",
    "created": "string",
    "lastModified": "string",
    "version": "string",
    "location": "string"
  }
}

Get details of a specific RBAC group

Request

Get details of a specific existing RBAC group by unique 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/Groups/{id}?format=json' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Body
schemasArray of strings

SCIM schema identifiers

Default ["urn:ietf:params:scim:schemas:core:2.0:Group"]
idstringrequired

RBAC group unique ID (must match existing RBAC group)

displayNamestringrequired

RBAC group display name

descriptionstring

RBAC group description

membersArray of objects

Users to add/remove from the RBAC group

metaobject
Response
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "string",
  "displayName": "string",
  "description": "string",
  "members": [
    { … }
  ],
  "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