CData

CData Users API

Lifecycle management for human users: create, update, deprovision, and manage direct role assignments, workspace-scoped roles, and direct resource permissions. SCIM handles group-based provisioning and user creation at scale; this API handles direct overrides and atomic deprovisioning.

Documentation GitHub OpenAPI

Business capability

Identity & Access Management BC-620.20

Operations 15

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /users Create a single user outside SCIM · Create User #

Ask an LLM

“How do I add a contractor or break-glass user when we don't use SCIM?”

“Does creating a user twice with the same external Id make a duplicate?”

Tell an agent

Create a user {first_name} {last_name} with email {email}.

Add one user {first_name} at {email} with HR employee Id {external_id}.

GET /users List the organization's human users · List Users #

Ask an LLM

“Which people have user accounts in our Connect AI organization?”

“Can I list only users provisioned through SCIM versus ones created by API?”

Tell an agent

List all human users in the organization.

Find the user with email {email}.

POST /users/batch Bulk create or update up to 500 users · Batch Create or Update Users #

Ask an LLM

“Can I import hundreds of users in one request?”

“What happens in a bulk user import when some records fail?”

Tell an agent

Bulk create or update these users: {users}.

Import this batch of up to 500 user records in one call: {users}.

GET /users/{id} Get one user and their direct permissions · Get User #

Ask an LLM

“How do I look up a single user's profile and directly assigned permissions?”

“What status is a given user in right now?”

Tell an agent

Get user {id}.

Show me the profile of person {id}.

PATCH /users/{id} Update a user's name or status · Update User #

Ask an LLM

“Why can't I change the name of a user that comes from our identity provider?”

“Does deactivating a user revoke their personal access tokens immediately?”

Tell an agent

Set the status of user {id} to {status}.

Rename user {id} to {first_name} {last_name}.

DELETE /users/{id} Deprovision a user · Delete User #

Ask an LLM

“What happens to a user's direct roles and permissions when I delete them?”

“How do I permanently offboard a person from the organization?”

Tell an agent destructive · confirm first

Delete user {id}.

Permanently deprovision the person {id} from our org.

POST /users/{id}/roles Grant the account-wide admin role to a user · Assign User Role #

Ask an LLM

“How do I make a person an organization-wide admin?”

“Which role can be given to a user at the account level rather than per workspace?”

Tell an agent

Grant account-wide role {role_id} to user {id}.

Make person {id} an organization admin using role {role_id}.

GET /users/{id}/roles List all roles a user holds, however inherited · List User Roles #

Ask an LLM

“Which roles does a person have across all workspaces, including ones from groups?”

“Is a user's access coming from a direct grant, a group, or a workspace?”

Tell an agent

List every role user {id} holds across all workspaces.

Show all direct, group and workspace role grants for person {id}.

DELETE /users/{id}/roles/{role_id} Remove a direct account-level role from a user · Remove User Role #

Ask an LLM

“How do I take the admin role away from a person?”

“Can I remove a role a user inherited from an identity provider group this way?”

Tell an agent destructive · confirm first

Remove direct role {role_id} from user {id}.

Revoke the org-wide admin role {role_id} held directly by person {id}.

POST /users/{id}/permissions Give a user access to a connection · Assign User Permission #

Ask an LLM

“How do I let one person query a specific connection without giving them a role?”

“Can I restrict a user to particular operations on a connection?”

Tell an agent

Give user {id} {operations} access to connection {resource} as a {type} permission.

Grant person {id} permission of type {type} to perform {operations} on {resource}.

GET /users/{id}/permissions List a user's direct resource permissions · List User Permissions #

Ask an LLM

“Which connections can a person access through permissions granted straight to them?”

“What direct resource permissions does a user have outside their roles?”

Tell an agent

List the direct permissions of user {id}.

Show which connections person {id} has direct access to.

DELETE /users/{id}/permissions/{permission_id} Revoke a direct permission from a user · Remove User Permission #

Ask an LLM

“How do I cut off a person's access to one connection without deleting their account?”

“Can I revoke a single direct permission from a user?”

Tell an agent destructive · confirm first

Remove permission {permission_id} from user {id}.

Revoke direct permission {permission_id} held by person {id}.

POST /users/{id}/workspaces/{workspace_id}/roles Grant a workspace role to a user · Assign User Workspace Role #

Ask an LLM

“How do I make a person a workspace_admin in one workspace?”

“Can I assign a custom access role to a user for a single workspace?”

Tell an agent

Grant role {role_id} to user {id} in workspace {workspace_id}.

Make person {id} a workspace admin of {workspace_id} with role {role_id}.

GET /users/{id}/workspaces/{workspace_id}/roles List a user's roles in one workspace · List User Workspace Roles #

Ask an LLM

“Which roles does a person hold inside one particular workspace?”

“Is a user a workspace admin in a given workspace?”

Tell an agent

List the roles user {id} holds in workspace {workspace_id}.

Show workspace-scoped role grants for person {id} in {workspace_id}.

DELETE /users/{id}/workspaces/{workspace_id}/roles/{role_id} Remove a workspace role from a user · Remove User Workspace Role #

Ask an LLM

“How do I take a workspace role away from a person in one workspace?”

“Can I strip workspace admin rights from a user without affecting other workspaces?”

Tell an agent destructive · confirm first

Remove role {role_id} from user {id} in workspace {workspace_id}.

Revoke workspace {workspace_id} role {role_id} from person {id}.

CData Users API

Operations 15

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification