connector-spec.json

{
	"name": "discourse-connector",
	"commands": [
		"std:test-connection",
		"std:account:create",
		"std:account:read",
		"std:account:list",
		"std:account:update",
		"std:account:delete",
		"std:entitlement:list",
		"std:entitlement:read",
		"std:account:disable"
	],
	"sourceConfig": [
		{
			"type": "menu",
			"label": "Configuration",
			"items": [
				{
					"sectionTitle": "Base Configuration",
					"type": "section",
					"items": [
						{
							"key": "apiKey",
							"type": "text",
							"label": "API Key",
							"required": true
						},
						{
							"key": "apiUsername",
							"type": "text",
							"label": "API Username",
							"required": true
						},
						{
							"key": "baseUrl",
							"type": "text",
							"label": "Base URL",
							"helpText": "Base URL of the Discourse instance",
							"placeholder": "https://mydomain.com",
							"required": true
						},
						{
							"key": "primaryGroup",
							"type": "text",
							"label": "Primary Group",
							"helpText": "The primary group that contains the users to be managed by this connector.",
							"required": true
						},
						{
							"key": "employeeIdFieldId",
							"type": "text",
							"label": "Employee Id Field Id",
							"helpText": "The id of the employee Id field in the Discourse custom fields table",
							"required": true
						}
					]
				}
			]
		}
	],
	"accountSchema": {
		"displayAttribute": "username",
		"identityAttribute": "id",
		"groupAttribute": "groups",
		"attributes": [
			{
				"name": "username",
				"type": "string",
				"description": "The username of the account"
			},
			{
				"name": "employeeId",
				"type": "string",
				"description": "The internal employee ID of the account used for correlation with internal hr systems"
			},
			{
				"name": "id",
				"type": "string",
				"description": "The unique identifier of the account"
			},
			{
				"name": "email",
				"type": "string",
				"description": "Email address of the account"
			},
			{
				"name": "name",
				"type": "string",
				"description": "display name of the account"
			},
			{
				"name": "title",
				"type": "string",
				"description": "The title of the user account"
			},
			{
				"name": "groups",
				"type": "string",
				"entitlement": true,
				"managed": true,
				"multi": true,
				"description": "The groups the user belongs to"
			}
		]
	},
	"entitlementSchemas": [
		{
			"type": "group",
			"displayAttribute": "name",
			"identityAttribute": "id",
			"attributes": [
				{
					"name": "id",
					"type": "string",
					"description": "Unique ID of the group and its name (ex. 1:admin)"
				},
				{
					"name": "name",
					"type": "string",
					"description": "The name of the group (ex. admin)"
				}
			]
		}
	],
	"accountCreateTemplate": {
		"fields": [
			{
				"key": "email",
				"label": "Email",
				"type": "string",
				"required": true,
				"initialValue": {
					"type": "identityAttribute",
					"attributes": {
						"name": "email"
					}
				}
			},
			{
				"key": "employeeId",
				"label": "Employee ID",
				"type": "string",
				"required": true,
				"initialValue": {
					"type": "identityAttribute",
					"attributes": {
						"name": "employeeID"
					}
				}
			},
			{
				"key": "username",
				"label": "Username",
				"type": "string",
				"required": true,
				"initialValue": {
					"type": "identityAttribute",
					"attributes": {
						"name": "uid"
					}
				}
			},
			{
				"key": "name",
				"label": "Name",
				"type": "string",
				"required": true,
				"initialValue": {
					"type": "identityAttribute",
					"attributes": {
						"name": "displayName"
					}
				}
			},
			{
				"key": "password",
				"label": "Password",
				"type": "string",
				"required": false,
				"initialValue": {
					"type": "generator",
					"attributes": {
						"name": "Create Password"
					}
				}
			},
			{
				"key": "title",
				"label": "Title",
				"type": "string",
				"required": false,
				"initialValue": {
					"type": "identityAttribute",
					"attributes": {
						"name": "jobTitle"
					}
				}
			}
		]
	}
}