Skip to main content

SCIM 2.0 Provisioning API

Senda supports the System for Cross-domain Identity Management (SCIM) 2.0 protocol for automated user and group provisioning. This allows you to integrate Senda directly with Identity Providers (IdP) like Okta, Microsoft Entra ID (Azure AD), and Google Workspace.

Base URL & Authentication​

All SCIM endpoints are available under the /v1/scim/ path and require standard API key authentication.

Base URL: https://senda.telar.ai/api/v1/scim

Authorization: Bearer sk_live_YOUR_KEY
info

Senda automatically responds with Content-Type: application/scim+json as required by the SCIM 2.0 specification.

Users API​

Manage user accounts in your Senda tenant.

List Users​

GET /v1/scim/Users

Supports basic SCIM filtering (filter=userName eq "[email protected]" or filter=externalId eq "..."), as well as pagination (startIndex, count).

Response (ListResponse):

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 1,
  "Resources": [
    {
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
      "id": "usr_abc123",
      "userName": "[email protected]",
      "name": { "formatted": "User Name" },
      "displayName": "User Name",
      "active": true,
      "emails": [{ "primary": true, "value": "[email protected]", "type": "work" }],
      "meta": { "resourceType": "User" }
    }
  ]
}

Create User​

POST /v1/scim/Users

Request:

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "userName": "[email protected]",
  "name": {
    "givenName": "John",
    "familyName": "Doe"
  },
  "active": true
}

Update User (PUT/PATCH)​

  • PUT /v1/scim/Users/:id (Full replacement)
  • PATCH /v1/scim/Users/:id (Partial update)

Deactivate a User (PATCH):

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    {
      "op": "replace",
      "value": { "active": false }
    }
  ]
}

Groups API​

Manage User Groups (Teams/Spaces) and their memberships.

List Groups​

GET /v1/scim/Groups

Supports filtering by displayName.

Response (ListResponse):

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
  "totalResults": 1,
  "Resources": [
    {
      "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
      "id": "grp_xyz789",
      "displayName": "Support Team",
      "members": [
        { "value": "usr_abc123", "display": "[email protected]" }
      ],
      "meta": { "resourceType": "Group" }
    }
  ]
}

Create Group​

POST /v1/scim/Groups

Request:

{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group"],
  "displayName": "Engineering",
  "members": [
    { "value": "usr_abc123" }
  ]
}

Update Group Membership (PATCH)​

PATCH /v1/scim/Groups/:id

Add a Member:

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [{ "value": "usr_new456" }]
    }
  ]
}

Remove a Member:

{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    {
      "op": "remove",
      "path": "members[value eq \"usr_old789\"]"
    }
  ]
}