← Tools Reference

Roam SCIM

Roam SCIM integration (Security, Productivity). Imported from open-connector.

API key11 toolshttps://api.ro.am/scim/v2
GET
roam_scim_get_service_provider_config
Get the Roam SCIM service provider configuration.

/ServiceProviderConfig

GET
roam_scim_list_users
List Roam SCIM users with optional SCIM filtering and pagination.

/Users

3 parameters
ParamTypeRequiredDescription
filterstringoptionalA SCIM filter expression accepted by Roam SCIM.
startIndexintegeroptionalThe one-based SCIM startIndex pagination value.
countintegeroptionalThe maximum number of SCIM resources to return.
GET
roam_scim_get_user
Get one Roam SCIM user by Roam Person ID.

/Users/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Roam SCIM resource ID.
POST
roam_scim_create_user
Create a Roam SCIM user from name, email, and optional role metadata.

/Users

6 parameters
ParamTypeRequiredDescription
emailstringrequiredThe user's primary email address. Roam uses this as both userName and emails[0]…
givenNamestringrequiredThe user's SCIM name.givenName value.
familyNamestringrequiredThe user's SCIM name.familyName value.
externalIdstringoptionalThe optional external identifier used to correlate this user with an identity p…
activebooleanoptionalWhether the Roam user should be active. Set false to archive access.
rolestringoptionalThe Roam Administration role assigned through the SCIM extension.
PUT
roam_scim_replace_user
Fully replace supported attributes for a Roam SCIM user.

/Users/{id}

7 parameters
ParamTypeRequiredDescription
idstringrequiredThe Roam SCIM resource ID.
emailstringrequiredThe user's primary email address. Roam uses this as both userName and emails[0]…
givenNamestringrequiredThe user's SCIM name.givenName value.
familyNamestringrequiredThe user's SCIM name.familyName value.
externalIdstringoptionalThe optional external identifier used to correlate this user with an identity p…
activebooleanoptionalWhether the Roam user should be active. Set false to archive access.
rolestringoptionalThe Roam Administration role assigned through the SCIM extension.
DELETE
roam_scim_delete_user
Archive a Roam SCIM user by Roam Person ID.

/Users/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Roam SCIM resource ID.
GET
roam_scim_list_groups
List Roam SCIM groups with optional pagination.

/Groups

3 parameters
ParamTypeRequiredDescription
filterstringoptionalA SCIM filter expression accepted by Roam SCIM.
startIndexintegeroptionalThe one-based SCIM startIndex pagination value.
countintegeroptionalThe maximum number of SCIM resources to return.
GET
roam_scim_get_group
Get one Roam SCIM group by Roam Address ID.

/Groups/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Roam SCIM resource ID.
POST
roam_scim_create_group
Create a Roam SCIM group with optional initial members.

/Groups

2 parameters
ParamTypeRequiredDescription
displayNamestringrequiredThe Roam SCIM group displayName value.
memberIdsarrayoptionalRoam Person IDs to include as SCIM group members.
PUT
roam_scim_replace_group
Fully replace a Roam SCIM group display name and member list.

/Groups/{id}

3 parameters
ParamTypeRequiredDescription
idstringrequiredThe Roam SCIM resource ID.
displayNamestringrequiredThe Roam SCIM group displayName value.
memberIdsarrayoptionalRoam Person IDs to include as SCIM group members.
DELETE
roam_scim_delete_group
Archive a Roam SCIM group by Roam Address ID.

/Groups/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe Roam SCIM resource ID.