logo
Documentation Powered by ReDoc

Common Room SCIM API (1.0.0)

Download OpenAPI specification:Download

Common Room SCIM REST APIs for accessing Community scoped resources.

To use the Common Room API, or get started with the Common Room Zapier integration, you will need to create an API token. To create an API token:

  1. Navigate to Setting | API tokens
  2. Click on “Request Access to API”. Our API is currently in beta, so you need to first apply for access.
  3. Once access is granted, return to the Settings | API tokens screen, and you will see a button to create a “New Token”.

Authentication

BearerAuth

Use a Community API JWT as a Bearer token in the Authentication header.

Tokens can be created by Community Owners through https://app.commonroom.io/

Example:

curl -H "Authorization: Bearer abcd123.xzy" \
  https://api.commonroom.io/community/v1
Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

SCIM

Active community members by role

Returns the list of active owners, filtered based on the query parameters

query Parameters
startIndex
integer
Example: startIndex=1
count
integer
Example: count=15
filter
string
Example: filter=userName eq 'test.user@domain.io'

filter on the userName.

Responses

Response samples

Content type
application/json
{
  • "schemas": [
    ],
  • "Resources": [
    ],
  • "totalResults": 0,
  • "itemsPerPage": 0,
  • "startIndex": 0
}

Creates the community member with specific role

Creates the community member with owner role

query Parameters
startIndex
integer
Example: startIndex=1
count
integer
Example: count=15
filter
string
Example: filter=userName eq 'test.user@domain.io'

filter on the userName.

Request Body schema: application/scim+json; charset=utf-8
schemas
Array of strings
userName
string
object
Array of objects
active
boolean

Indicates whether the user has a login account in the community

Responses

Request samples

Content type
application/scim+json; charset=utf-8
{
  • "schemas": [
    ],
  • "userName": "test.user@domain.io",
  • "name": {
    },
  • "emails": [
    ],
  • "active": true
}

Response samples

Content type
application/json
{
  • "id": "user@domain.com",
  • "userName": "user@domain.com",
  • "name": {
    },
  • "emails": [
    ],
  • "active": true,
  • "schemas": [
    ]
}

Retrieves a specific user account

path Parameters
email
required
string
Example: User accounts' identifier. Typically the email address

Responses

Response samples

Content type
application/json
{
  • "id": "user@domain.com",
  • "userName": "user@domain.com",
  • "name": {
    },
  • "emails": [
    ],
  • "active": true,
  • "schemas": [
    ]
}

Updates an user account

Updates the user account specified in the query

path Parameters
email
required
string
Example: User accounts' identifier. Typically the email address
Request Body schema: application/scim+json; charset=utf-8
schemas
Array of strings
Array of objects

Responses

Request samples

Content type
application/scim+json; charset=utf-8
{
  • "schemas": [
    ],
  • "Operations": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "user@domain.com",
  • "userName": "user@domain.com",
  • "name": {
    },
  • "emails": [
    ],
  • "active": true,
  • "schemas": [
    ]
}