Niah Docs
Core APIs

SCIM 2.0

Provision users and groups from your identity provider using the same org API keys as /v1.

Base URL & auth

http
https://api.niah.si/scim/v2
Authorization: Bearer nwk_...

Required scopes: scim:read and/or scim:write. Content-Type is SCIM JSON (application/scim+json).

Discovery

get/scim/v2/ServiceProviderConfig
get/scim/v2/Schemas · /Schemas/{id}
get/scim/v2/ResourceTypes

Users

get/scim/v2/UsersList / filter
post/scim/v2/UsersCreate
get/scim/v2/Users/{id}Read
put / patch/scim/v2/Users/{id}Replace / partial update

Core attributes: userName, name.givenName, name.familyName, emails[], active.

Deactivate instead of delete. Deprovision users by sending active: false with PUT or PATCH. Niah preserves the user identity and deactivates its organization membership. DELETE /Users/{id} is intentionally unsupported; configure lifecycle actions to deactivate users rather than hard-delete them.

Groups

get/scim/v2/Groups
post/scim/v2/Groups
get/scim/v2/Groups/{id}
put / patch / delete/scim/v2/Groups/{id}

Core attributes: displayName, members[].

Identity provider recipes

Okta

Provisioning actions, mappings, and Push Groups.

Microsoft Entra ID

Enterprise app setup and attribute mappings.

JumpCloud

Custom SCIM connector and group setup.

Group limitations

  • Groups map to Niah organization teams; nested groups are not supported.
  • Group members must already be provisioned users in the same organization.
  • Groups do not assign organization roles, administrator access, or API scopes.
  • Deleting a group removes the team only; it does not deactivate its users.