Common Room · Schema

User

Represents the user account in the Common Room community This account is used for identity mangement via SCIM Specification can be found at https://datatracker.ietf.org/doc/html/rfc7643#section-4.1

Community IntelligenceGo-to-MarketMember SignalsGitHubSlackDiscordLinkedInSales IntelligenceContact ManagementWebhooks

Properties

Name Type Description
id string
userName string
name object
emails array
active boolean Indicates whether the user has a login account in the community
schemas array
View JSON Schema on GitHub

JSON Schema

common-room-scim-user-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.commonroom.io/schemas/scim/user",
  "title": "User",
  "type": "object",
  "description": "Represents the user account in the Common Room community\nThis account is used for identity mangement via SCIM\nSpecification can be found at https://datatracker.ietf.org/doc/html/rfc7643#section-4.1\n",
  "properties": {
    "id": {
      "type": "string",
      "example": "[email protected]"
    },
    "userName": {
      "type": "string",
      "example": "[email protected]"
    },
    "name": {
      "type": "object",
      "properties": {
        "givenName": {
          "type": "string",
          "example": "John"
        },
        "familyName": {
          "type": "string",
          "example": "Doe"
        }
      }
    },
    "emails": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": {
            "type": "string",
            "example": "[email protected]"
          },
          "primary": {
            "type": "boolean",
            "example": true
          },
          "type": {
            "type": "string",
            "example": "work"
          }
        }
      }
    },
    "active": {
      "type": "boolean",
      "example": true,
      "description": "Indicates whether the user has a login account in the community"
    },
    "schemas": {
      "type": "array",
      "items": {
        "type": "string",
        "example": "urn:ietf:params:scim:api:messages:2.0:User"
      }
    }
  }
}