> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Xyleme

> How to set up the Xyleme connector, plus the actions that are available.

![Xyleme](https://stackone-logos.com/api/xyleme/filled/svg)

v1.1.0[See changelog](https://docs.stackone.com/connectors/xyleme/changelog.md)

[79 actions](#actions) · 1 auth method

LMS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Basic Auth · Connector Profile](https://docs.stackone.com/connectors/xyleme/guides/connector-profile/basic-auth.md)
>
> Use your Xyleme account username and password to authenticate. The API will return a context token for subsequent reques...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Basic Auth · Link Account](https://docs.stackone.com/connectors/xyleme/guides/link-account/basic-auth.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

79 actions

ActionDescription

List Channel Classifications`xyleme_list_channel_classifications`

Retrieve a list of classifications for a specific channel

Add Channel Classification`xyleme_add_channel_classification`

Add a classification to a channel

Remove Channel Classification`xyleme_remove_channel_classification`

Remove a classification from a channel

List Channel Permissions`xyleme_list_channel_permissions`

Retrieve a list of permissions for a specific channel

List Channels`xyleme_list_channels`

Retrieve a list of channels accessible to the user

Create Channel`xyleme_create_channel`

Create a new channel

Get Channel`xyleme_get_channel`

Retrieve details of a specific channel

Update Channel`xyleme_update_channel`

Update a channel's configuration and display settings

Delete Channel`xyleme_delete_channel`

Delete a channel from the platform

Search Channel`xyleme_search_channel`

Perform a search within a specific channel

List Channel Facets`xyleme_list_channel_facets`

Retrieve all facets for a specific channel

List Classifications`xyleme_list_classifications`

Retrieve a list of all classifications

List Classification Descendants`xyleme_list_classification_descendants`

Retrieve a list of a classification and its descendants

List Classification Children`xyleme_list_classification_children`

Retrieve a list of a classification's children

List Classification Ancestors`xyleme_list_classification_ancestors`

Retrieve a list of a classification's ancestors

List Classification Document Versions`xyleme_list_classification_document_versions`

Retrieve a list of document versions for a classification

List Classification Content Objects`xyleme_list_classification_content_objects`

Retrieve a list of content objects for a classification

Get Classification`xyleme_get_classification`

Retrieve details of a specific classification

Create Classification`xyleme_create_classification`

Create a new classification

Update Classification`xyleme_update_classification`

Update or move a classification

Delete Classification`xyleme_delete_classification`

Delete a classification and its descendants

List Root Classifications`xyleme_list_root_classifications`

Retrieve a list of root classifications

Search Classifications`xyleme_search_classifications`

Search the list of classifications

Get Comment`xyleme_get_comment`

Retrieve details of a specific comment

Update Comment`xyleme_update_comment`

Edit a comment

Delete Comment`xyleme_delete_comment`

Delete a comment

List Custom Attributes`xyleme_list_custom_attributes`

Retrieve a list of all custom attributes

Create Custom Attribute`xyleme_create_custom_attribute`

Create a new custom attribute

Get Custom Attribute`xyleme_get_custom_attribute`

Retrieve details of a specific custom attribute

Update Custom Attribute`xyleme_update_custom_attribute`

Update an existing custom attribute

Delete Custom Attribute`xyleme_delete_custom_attribute`

Delete a custom attribute

List Document History`xyleme_list_document_history`

Retrieve a document's history

Get Document History`xyleme_get_document_history`

Retrieve details of a specific document history event

List All Document History Events`xyleme_list_all_document_history`

Retrieve a list of all document history events

List All Documents`xyleme_list_all_documents`

Retrieve a list of all documents

List Accessible Documents`xyleme_list_accessible_documents`

Get list of accessible documents

List Document Languages`xyleme_list_document_languages`

Get list of supported and unsupported languages

List Document Resource Types`xyleme_list_document_resource_types`

Get list of supported and unsupported resource types

Get Document`xyleme_get_document`

Get document details

Add Document To Favorites`xyleme_add_document_to_favorites`

Add the specified document to the current user's favorites

Remove Document From Favorites`xyleme_remove_document_from_favorites`

Remove the specified document from the current user's favorites

Update Document`xyleme_update_document`

Update or move document

Delete Document`xyleme_delete_document`

Delete document

List Document Versions`xyleme_list_document_versions`

Get list of a document's versions

Get Latest Document Version`xyleme_get_latest_document_version`

Get the latest version details for a document

Get Document Version`xyleme_get_document_version`

Get details of a document version

Update Document Version`xyleme_update_document_version`

Update details of a document version

List Document Version Content Objects`xyleme_list_document_version_content_objects`

Get list of a document version's content objects

Get Document Version Content Object`xyleme_get_document_version_content_object`

Get details of a document version's content object

Update Document Version Content Object`xyleme_update_document_version_content_object`

Update a document version's content object

List Document Version Content Object Classifications`xyleme_list_document_version_content_object_classifications`

Get list of classifications for a document version's content object

Add Classification To Document Version Content Object`xyleme_add_classification_to_document_version_content_object`

Add a classification to a document version's content object

Remove Classification From Document Version Content Object`xyleme_remove_classification_from_document_version_content_object`

Remove a classification from a document version's content object

List Document Version Content Object Custom Attributes`xyleme_list_document_version_content_object_custom_attributes`

Get list of custom attributes for a document version's content object

List Document Version Content Links`xyleme_list_document_version_content_links`

Get list of content links for a document version

List Document Version Comments`xyleme_list_document_version_comments`

Get list of comments for a document version

Create Document Version Comment`xyleme_create_document_version_comment`

Create a new comment on a document version

List Document Version Classifications`xyleme_list_document_version_classifications`

List version classifications

Add Classifications To Document Version`xyleme_add_classifications_to_document_version`

Add classifications from version

Remove Classifications From Document Version`xyleme_remove_classifications_from_document_version`

Remove classifications from version

Add Classification To Document Version`xyleme_add_classification_to_document_version`

Add classification to version

Remove Classification From Document Version`xyleme_remove_classification_from_document_version`

Remove classification from version

List Document Version Custom Attributes`xyleme_list_document_version_custom_attributes`

Get list of custom attributes for a document version

Add Custom Attributes To Document Version`xyleme_add_custom_attributes_to_document_version`

Add custom attributes to a document version

Remove Custom Attributes From Document Version`xyleme_remove_custom_attributes_from_document_version`

Remove custom attributes from a document version

List Groups`xyleme_list_groups`

Retrieve a list of all groups

Get Group`xyleme_get_group`

Get details of a specific group

Create Group`xyleme_create_group`

Create a new group

Update Group`xyleme_update_group`

Update a group

Delete Group`xyleme_delete_group`

Delete a group

List Group Members`xyleme_list_group_members`

Get list of a group's users

Add User To Group`xyleme_add_user_to_group`

Add a user to a group

Remove User From Group`xyleme_remove_user_from_group`

Remove a user from a group

Search Content`xyleme_search_content`

Search for documents and learning objects across the platform

List Users`xyleme_list_users`

Retrieve a paginated list of all users with access to the Xyleme system

Get User`xyleme_get_user`

Get user details

Create User`xyleme_create_user`

Create a new user

Update User`xyleme_update_user`

Update the specified user

Delete User`xyleme_delete_user`

Delete a user


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.