Skip to main content
API docs by Redocly

ToolJet SCIM API (1.0.0)

Download OpenAPI specification:Download

ToolJet supports SCIM 2.0 for automated user and group provisioning. All standard SCIM endpoints are supported — including /Schemas, /ResourceTypes, /Users, and /Groups.

List Users

Responses

Response samples

Content type
application/scim+json
{
  • "totalResults": 0,
  • "startIndex": 0,
  • "itemsPerPage": 0,
  • "Resources": [
    ]
}

Create User

Request Body schema: application/scim+json
required
schemas
required
Array of strings
userName
required
string
object
active
boolean
password
string

User password for creation.

Array of objects
Array of objects
object
object

ToolJet’s custom SCIM extension (only used in requests)

Responses

Request samples

Content type
application/scim+json
{
  • "schemas": [
    ],
  • "userName": "string",
  • "name": {
    },
  • "active": true,
  • "password": "string",
  • "emails": [
    ],
  • "groups": [
    ],
  • "meta": {
    },
  • "urn:ietf:params:scim:schemas:extension:tooljet:User:2.0": {
    }
}

Response samples

Content type
application/scim+json
{
  • "schemas": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userName": "string",
  • "name": {
    },
  • "active": true,
  • "emails": [
    ],
  • "meta": {
    }
}

Get User by ID

path Parameters
id
required
string

Responses

Response samples

Content type
application/scim+json
{
  • "schemas": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userName": "string",
  • "name": {
    },
  • "active": true,
  • "emails": [
    ],
  • "meta": {
    }
}

Replace User

path Parameters
id
required
string
Request Body schema: application/scim+json
required
schemas
required
Array of strings
userName
required
string
object
active
boolean
password
string

User password for creation.

Array of objects
Array of objects
object
object

ToolJet’s custom SCIM extension (only used in requests)

Responses

Request samples

Content type
application/scim+json
{
  • "schemas": [
    ],
  • "userName": "string",
  • "name": {
    },
  • "active": true,
  • "password": "string",
  • "emails": [
    ],
  • "groups": [
    ],
  • "meta": {
    },
  • "urn:ietf:params:scim:schemas:extension:tooljet:User:2.0": {
    }
}

Response samples

Content type
application/scim+json
{
  • "schemas": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userName": "string",
  • "name": {
    },
  • "active": true,
  • "emails": [
    ],
  • "meta": {
    }
}

Patch User

path Parameters
id
required
string
Request Body schema: application/scim+json
required
schemas
required
Array of strings
required
Array of objects

Responses

Request samples

Content type
application/scim+json
{
  • "schemas": [
    ],
  • "Operations": [
    ]
}

Response samples

Content type
application/scim+json
{
  • "schemas": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "userName": "string",
  • "name": {
    },
  • "active": true,
  • "emails": [
    ],
  • "meta": {
    }
}

Delete User

path Parameters
id
required
string

Responses

List Groups

Responses

Response samples

Content type
application/scim+json
{
  • "totalResults": 0,
  • "startIndex": 0,
  • "itemsPerPage": 0,
  • "Resources": [
    ]
}

Create Group

Request Body schema: application/scim+json
required
schemas
required
Array of strings
displayName
required
string
Array of objects

List of User members belonging to this group.

Responses

Request samples

Content type
application/scim+json
{
  • "schemas": [
    ],
  • "displayName": "Developers",
  • "members": [
    ]
}

Response samples

Content type
application/scim+json
{
  • "schemas": [
    ],
  • "displayName": "Developers",
  • "members": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "meta": {
    }
}

Get Group by ID

path Parameters
id
required
string

Responses

Response samples

Content type
application/scim+json
{
  • "schemas": [
    ],
  • "displayName": "Developers",
  • "members": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "meta": {
    }
}

Replace Group

path Parameters
id
required
string
Request Body schema: application/scim+json
required
schemas
required
Array of strings
displayName
required
string
Array of objects

List of User members belonging to this group.

Responses

Request samples

Content type
application/scim+json
{
  • "schemas": [
    ],
  • "displayName": "Developers",
  • "members": [
    ]
}

Response samples

Content type
application/scim+json
{
  • "schemas": [
    ],
  • "displayName": "Developers",
  • "members": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "meta": {
    }
}

Patch Group

path Parameters
id
required
string
Request Body schema: application/scim+json
required
schemas
required
Array of strings
required
Array of objects

Responses

Request samples

Content type
application/scim+json
{
  • "schemas": [
    ],
  • "Operations": [
    ]
}

Response samples

Content type
application/scim+json
{
  • "schemas": [
    ],
  • "displayName": "Developers",
  • "members": [
    ],
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "meta": {
    }
}

Delete Group

path Parameters
id
required
string

Responses