Skip to content

Ingest New Documentation #2456

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 10, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -118,19 +118,29 @@ This mapping ensures that the identity of users remains consistent and secure ac
The externalID in SCIM must correspond to the subfield in OIDC. Any deviation from this mapping may result
in incorrect user identification and authentication failures.

## FAQ
## Supported SCIM User properties

### Why aren’t users automatically added to Netdata spaces when they’re created through SCIM?
Our SCIM server supports the following User attributes:

- userName (required)
- externalId (required)
- name.formatted
- name.familyName
- name.givenName
- active
- emails (we only store the primary email)

Currently, our SCIM server supports only the User resource. We plan to add support for the Group resource in the future.
**Important Considerations**
- Configure supported attributes only: Your SCIM client must be configured to send only the attributes listed above. Requests containing unsupported attributes will fail with a `400 Bad Request` error.
- Okta users: No additional setup needed. The Netdata integration includes the correct attribute configuration automatically.

In a Netdata space, users can belong to multiple rooms and have different roles (e.g., admin, manager). Additionally, the same organization may have multiple spaces.
## FAQ

As we don't yet support groups, when a user is created through SCIM, we don’t have a way to determine which spaces, rooms, and roles the user should be assigned to.
### Why aren’t users automatically added to Netdata spaces when they’re created through SCIM?

Once we implement support for the Group resource, admins will be able to map SCIM groups to Netdata memberships, so this assignment will be done automatically.
Users created through SCIM are not automatically assigned to spaces. You need to configure Membership Rules to control space assignments.

Until then, SCIM can only be used to grant or block access to Netdata for users in your organization. After a user is created, it is up to the Netdata administrator to manually invite them to spaces, rooms and assign roles.
See Setting Up Membership Rules section above for setup instructions.

### Reference
[SCIM Specification](https://scim.org)
Expand Down