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:
Use a Core API JWT as a Bearer token in the Authentication header.
Tokens can be created by room Admins through https://app.commonroom.io/
Example:
curl -H "Authorization: Bearer abcd123.xzy" \
https://api.commonroom.io/community/v1/api-token-status
Security Scheme Type | HTTP |
---|---|
HTTP Authorization Scheme | bearer |
Bearer format | "JWT" |
Returns the list of active owners, filtered based on the 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. |
{- "schemas": [
- "urn:ietf:params:scim:api:messages:2.0:ListResponse"
], - "Resources": [
- {
- "id": "user@domain.com",
- "userName": "user@domain.com",
- "name": {
- "givenName": "John",
- "familyName": "Doe"
}, - "emails": [
- {
- "value": "user@domain.com",
- "primary": true,
- "type": "work"
}
], - "active": true,
- "schemas": [
- "urn:ietf:params:scim:api:messages:2.0:User"
]
}
], - "totalResults": 0,
- "itemsPerPage": 0,
- "startIndex": 0
}
Creates the contact with owner role
startIndex | integer Example: startIndex=1 |
count | integer Example: count=15 |
filter | string Example: filter=userName eq 'test.user@domain.io' filter on the userName. |
schemas | Array of strings |
userName | string |
object | |
Array of objects | |
active | boolean Indicates whether the user has a login account in the community |
{- "schemas": [
- "urn:ietf:params:scim:schemas:core:2.0:User"
], - "userName": "test.user@domain.io",
- "name": {
- "givenName": "John",
- "familyName": "Doe"
}, - "emails": [
- {
- "value": "user@domain.com",
- "primary": true,
- "type": "work"
}
], - "active": true
}
{- "id": "user@domain.com",
- "userName": "user@domain.com",
- "name": {
- "givenName": "John",
- "familyName": "Doe"
}, - "emails": [
- {
- "value": "user@domain.com",
- "primary": true,
- "type": "work"
}
], - "active": true,
- "schemas": [
- "urn:ietf:params:scim:api:messages:2.0:User"
]
}
email required | string Example: User accounts' identifier. Typically the email address |
{- "id": "user@domain.com",
- "userName": "user@domain.com",
- "name": {
- "givenName": "John",
- "familyName": "Doe"
}, - "emails": [
- {
- "value": "user@domain.com",
- "primary": true,
- "type": "work"
}
], - "active": true,
- "schemas": [
- "urn:ietf:params:scim:api:messages:2.0:User"
]
}
Updates the user account specified in the query
email required | string Example: User accounts' identifier. Typically the email address |
schemas | Array of strings |
Array of objects |
{- "schemas": [
- "urn:ietf:params:scim:schemas:core:2.0:PatchOp"
], - "Operations": [
- {
- "op": "replace",
- "value": {
- "active": true
}
}
]
}
{- "id": "user@domain.com",
- "userName": "user@domain.com",
- "name": {
- "givenName": "John",
- "familyName": "Doe"
}, - "emails": [
- {
- "value": "user@domain.com",
- "primary": true,
- "type": "work"
}
], - "active": true,
- "schemas": [
- "urn:ietf:params:scim:api:messages:2.0:User"
]
}