> ## Documentation Index > Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt > Use this file to discover all available pages before exploring further. # List roles > Fetch all roles defined in Fusion, or filter by role name ## OpenAPI ````yaml /api-reference/5.9/fusion-api-api-docs.json get /roles openapi: 3.0.1 info: title: Fusion Proxy API description: Manage Fusion users, roles, realms, access tokens, and API keys. contact: name: Lucidworks url: www.lucidworks.com email: support@lucidworks.com license: name: License of API url: https://lucidworks.com/legal/developer-license-agreement/ version: '5.9' servers: - url: https://{FUSION HOST}/api description: Fusion variables: FUSION HOST: default: FUSION_HOST description: Your environment host. security: [] tags: - name: Realm management description: >- Endpoints for creating, configuring, and managing authentication realms such as LDAP, SAML, OIDC, and others. - name: User management description: >- Endpoints for creating, updating, deleting, and retrieving Fusion users and their associated metadata. - name: Suggestions description: >- Endpoints that provide query suggestions or autocomplete results to improve search experiences. - name: API key management description: >- Endpoints for managing API keys used to authenticate Fusion services and integrations. - name: OAuth 2.0 description: >- Endpoints that support OAuth 2.0 authentication, including token issuance and validation. - name: Role management description: >- Endpoints for creating and managing user roles and their associated permissions within Fusion. - name: System status description: >- Endpoints for retrieving basic system health, configuration, and authentication status. externalDocs: description: Lucidworks Documentation url: https://doc.lucidworks.com/ paths: /roles: get: tags: - Role management summary: List roles description: Fetch all roles defined in Fusion, or filter by role name operationId: getRoles parameters: - name: name description: Optional role name or partial role name to filter by. in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: type: array items: $ref: '#/components/schemas/Role' example: - id: 04d7acc2-a22a-4042-2827-2e82c2a8babf name: developer createdAt: '2025-10-31T22:03:10Z' desc: >- Developer access with read/write permission required for building/running applications. permissions: - methods: - GET - PUT - POST path: /system/** - methods: - GET - PUT - HEAD - DELETE - POST path: /stopwords/** - methods: - GET - PUT - POST path: /usage/** - methods: - GET path: /features/** - methods: - GET - PUT - HEAD - DELETE - POST path: /blobs/** - methods: - GET - PUT - HEAD - DELETE - POST path: /scheduler/** - methods: - GET - PUT - HEAD - DELETE - POST path: /experiments - methods: - GET path: /introspect/** - methods: - PUT path: /usage/** - methods: - GET - PUT - HEAD - DELETE - POST path: /index-stages/** - methods: - GET - PUT - HEAD - DELETE - POST path: /index-stage-plugins/** - methods: - GET - PUT - HEAD - DELETE - POST path: /messaging/** - methods: - GET - PUT - HEAD - DELETE - POST path: /catalog - methods: - GET - PUT - HEAD - DELETE - POST path: /parsers/** - methods: - GET - PUT - POST path: /appkit/** - methods: - GET - PUT - HEAD - DELETE - POST path: /index-profiles/** - methods: - GET - PUT - POST path: /recommend/** - methods: - GET - PUT - HEAD - DELETE - POST path: /history/** - methods: - GET - PUT - HEAD - DELETE - POST path: /apps/** - methods: - GET - POST path: /dynamicSchema/** - methods: - GET - PUT - HEAD - DELETE - POST path: /solr/** - methods: - GET - POST path: /query/** - methods: - GET - PUT - POST path: /signals/** - methods: - GET - PUT - POST path: /searchLogs/** - methods: - GET - PUT - HEAD - DELETE - POST path: /query-pipelines/** - methods: - GET - PUT - POST path: /configurations/** - methods: - GET path: /suggestions/** - methods: - GET - PUT - HEAD - DELETE - POST path: /searchCluster/** - methods: - GET - PUT - HEAD - DELETE - POST path: /index-pipelines/** - methods: - GET path: /license - methods: - GET - PUT - HEAD - DELETE - POST path: /spark/** - methods: - GET - PUT - HEAD - DELETE - POST path: /query-stages/** - methods: - GET - PUT - HEAD - DELETE - POST path: /prefs/apps/search/* - methods: - GET path: /nodes/** - methods: - GET - PUT - HEAD - DELETE - POST path: /solrAdmin/** - methods: - GET - PUT - POST path: /synonyms/** - methods: - GET - PUT - HEAD - DELETE - POST path: /jobs/** - methods: - OPTIONS - GET - PUT - HEAD - DELETE - POST path: /collections/** - methods: - GET - PUT - HEAD - DELETE - POST path: /connectors/** - methods: - GET - PUT - HEAD - DELETE - POST path: /groups/** - methods: - GET - PUT - HEAD - DELETE - POST path: /query-profiles/** - methods: - GET - PUT - POST path: /templates/** - methods: - GET - PUT - HEAD - DELETE - POST path: /tasks/** - methods: - GET - PUT - HEAD - DELETE - POST path: /links/** - methods: - PATCH path: /users/{id} params: id: - '#ID' - methods: - GET - PUT - POST path: /registration/** - methods: - POST path: /index/** - methods: - GET - PUT - POST path: /objects/** - methods: - GET - PUT - HEAD - DELETE - POST path: /insights/apps/** - methods: - GET - PUT - HEAD - DELETE - POST path: /devops/** - methods: - GET - PUT - HEAD - DELETE - POST path: /rules/apps/** uiPermissions: - about-fusion - logout - experiments - devops - insights - log-viewer - object-explorer - rules - messaging - solr-clusters - collections - collections.commit - collections.clear - collections.delete - datasources - solr-config - stopwords - synonyms - query-workbench - quickstart - index-workbench - scheduler - dashboards - launcher - blobs - jobs - tasks - links - groups - fields - aggregations - parsers - index-workbench - index-pipelines - index-pipelines.delete - index-profiles - query-workbench - query-pipelines - query-pipelines.delete - query-profiles - system - id: 483a42b2-8f02-42b8-aab2-a4f20f242af2 name: rules createdAt: '2025-10-31T22:03:10Z' desc: Provides query-rewrite API access to the all Fusion apps. permissions: - methods: - GET path: /apps/*/query-profiles/** - methods: - GET - PUT - PATCH - HEAD - DELETE - POST path: /apps/*/query-rewrite/** - methods: - GET path: /solr/** - methods: - GET path: /query/** - methods: - GET path: /collections/** - methods: - GET path: /apps/** uiPermissions: [] - id: e87870f2-2848-4bb2-be87-22d3fa8b5f24 name: lw-ai createdAt: '2024-09-25T14:39:25Z' updatedAt: '2025-08-07T23:17:32Z' permissions: - methods: - GET - PUT - HEAD - POST path: /lw-docs/** - methods: - POST path: /lw-docs uiPermissions: [] - id: d855ab53-2775-4c4b-bfbe-dba8280b02bf name: entitlements-consumption createdAt: '2023-10-05T20:09:50Z' desc: >- Provides access to the consumption dashboard, perform queries and download the consumption report permissions: - methods: - GET path: /apps-manager/** - methods: - GET path: /apps/** - methods: - GET path: /links/** - methods: - GET path: /collections/** - methods: - GET path: /configurations/** - methods: - GET path: /license uiPermissions: - consumption - launcher - id: d8a0538d-2322-4b22-8832-afac2f88d278 name: internal createdAt: '2025-10-31T22:03:10Z' desc: >- Internal role for any service account; cannot be used from outside the gateway. permissions: - methods: - GET - PUT - PATCH - HEAD - DELETE - POST path: /** uiPermissions: [] - id: 2a322287-2287-42d2-2ad8-205043ee7d35 name: lwp_user createdAt: '2025-08-13T20:59:15Z' updatedAt: '2025-09-15T16:22:15Z' desc: >- The lwp_user account is required to access and use Commerce Studio. It is a super user account, but does not include the ability to get, modify, or delete the HEAD section of the site. permissions: - methods: - GET - PUT - HEAD - DELETE - POST path: /query/experience-manager/** - methods: - GET - POST path: /query/* - methods: - POST path: /query/*/preview - methods: - GET path: /suggestions/** - methods: - GET path: /solr/*/terms - methods: - GET - PUT - POST path: /apps/*/query-pipelines/** - methods: - GET path: /apps/*/query-profiles/** - methods: - GET - PUT path: /apps/* - methods: - GET path: /solr/*/admin/luke - methods: - GET path: /solr/** - methods: - GET - PUT - HEAD - POST path: /lw-docs/** - methods: - POST path: /lw-docs uiPermissions: [] - id: ae3be0a0-8722-427a-85f5-2ca72ae547ee name: stage-plugin-developer createdAt: '2023-10-05T20:09:50Z' desc: >- Allows to create and modify custom pipeline stages in Fusion environment. This role should be combined with developer role. permissions: - methods: - GET - PUT - HEAD - DELETE - POST path: /index-stage-plugins/** - methods: - GET - PUT - HEAD - DELETE - POST path: /query-stage-plugins/** uiPermissions: - user-profile - about-fusion - logout - object-explorer - datasources - scheduler - launcher - blobs - tasks - collections - index-workbench - index-pipelines - index-pipelines.delete - index-profiles - query-workbench - query-pipelines - query-pipelines.delete - query-profiles - id: 2222f84d-4202-47c8-8288-0fa42e272d3f name: remote-connectors createdAt: '2025-10-31T22:03:10Z' desc: Authorize the remote connector access to Fusion permissions: [] uiPermissions: [] - id: a8d8f82c-5e8c-4bf8-8f2c-848c8d58842c name: webapps-role createdAt: '2023-10-05T20:09:50Z' desc: Can list and download webapps permissions: - methods: - GET - HEAD path: /webapps/** - methods: - GET - HEAD path: /license uiPermissions: [] - id: readonly name: readonly createdAt: '2025-10-31T22:03:10Z' permissions: - methods: - PUT - DELETE path: /apps/*/blobs/prefs-*._lw_tmp_* - methods: - PUT - DELETE path: /prefs/apps/search/*._lw*_tmp_* - methods: - PUT - DELETE path: /apps/*/query-pipelines/_lw*_tmp_* - methods: - POST path: /prefs/apps/search - methods: - PUT - DELETE path: /apps/*/index-pipelines/_lw*_tmp_* - methods: - POST path: /apps/*/query-pipelines - methods: - POST path: /query-pipelines/_system/collections/*/select - methods: - POST path: /apps/*/parsers - methods: - POST path: /apps/*/index-pipelines - methods: - PUT path: /usage/counters/* - methods: - GET path: /** - methods: - PUT - DELETE path: /apps/*/parsers/_lw*_tmp_* - methods: - GET - PUT - POST path: /signals/** uiPermissions: - '*' - id: 4c2ec2f0-c78a-4abe-b2fa-2ce0fe2b2cd4 name: search createdAt: '2025-10-31T22:03:10Z' desc: >- Provides read-only query and write-only signal API access to the all Fusion apps. permissions: - methods: - POST path: /apps/*/signals/** - methods: - GET - POST path: /query/** - methods: - POST path: /signals/** - methods: - PATCH path: /users/{id} params: id: - '#ID' - methods: - GET - POST path: /apps/*/query/** uiPermissions: [] - id: 32cb202c-d052-43be-2ee3-703227b82882 name: lwp_service_account createdAt: '2025-08-13T20:59:47Z' updatedAt: '2025-09-15T16:22:31Z' desc: >- The lwp_service_account contains all of the lwp_user permissions as well as the privileges to migrate Fusion Predictive Merchandiser components to Lucidworks Commerce Studio. permissions: - methods: - GET - PUT - HEAD - DELETE - POST path: /query/experience-manager/** - methods: - GET - POST path: /query/* - methods: - POST path: /query/*/preview - methods: - GET path: /suggestions/** - methods: - GET path: /solr/*/terms - methods: - GET - PUT - POST path: /apps/*/query-pipelines/** - methods: - GET path: /apps/*/query-profiles/** - methods: - GET - PUT path: /apps/* - methods: - GET - PUT - PATCH - HEAD - DELETE - POST path: /apps/*/query-rewrite/** - methods: - GET - HEAD path: /templating/** - methods: - GET path: /solr/*/admin/luke - methods: - GET - PUT - HEAD - POST path: /lw-docs/** - methods: - POST path: /lw-docs uiPermissions: [] - id: 0a28a7e8-2004-4d8b-bdf2-3f2f2ded8428 name: admin createdAt: '2023-10-05T20:09:50Z' desc: Full access to every service. This is the super-admin role. permissions: - methods: - GET - PUT - PATCH - HEAD - DELETE - POST path: /** - methods: - GET - PUT - HEAD - DELETE - POST path: /solrAdmin/** uiPermissions: - '*' - id: 27d8fb88-77c2-42fb-a24c-2e2cfc3adbea name: spark-developer createdAt: '2023-10-05T20:09:50Z' desc: >- Allows to create and modify the Spark, Python scripts and execute them in Fusion environment. It also allows to control the Experiments. This role should be combined with developer role. permissions: - methods: - GET - PUT - HEAD - DELETE - POST path: /spark/** - methods: - GET - PUT - HEAD - DELETE - POST path: /apps/*/spark/** - methods: - GET - PUT - PATCH - HEAD - DELETE - POST path: /data-models/** - methods: - GET - PUT - HEAD - DELETE - POST path: /experiments/** - methods: - GET - PUT - HEAD - DELETE - POST path: /apps/*/experiments/** uiPermissions: - user-profile - about-fusion - logout - object-explorer - datasources - experiments - scheduler - launcher - blobs - jobs - tasks - collections - datamodels - id: bcb220d2-2ba0-455a-85b7-ce22e2ce2288 name: search-template createdAt: '2025-10-31T22:03:10Z' desc: >- Search role template for a particular app. Copy and replace app-name with your Fusion app permissions: - methods: - GET - POST path: /apps/MYAPP/query/** - methods: - POST path: /apps/MYAPP/signals/** - methods: - POST path: /signals/MYAPP - methods: - GET - POST path: /query/MYAPP - methods: - PATCH path: /users/{id} params: id: - '#ID' uiPermissions: [] - id: 254d7770-8aa8-4244-2b38-75c25cc4c2a8 name: script-developer createdAt: '2023-10-05T20:09:50Z' desc: >- Allows to create and modify the JavaScript stages in query and indexing pipelines in Fusion environment. This role should be combined with developer role. permissions: - methods: - GET - PUT - HEAD - DELETE - POST path: /index-pipelines/** - methods: - GET - PUT - HEAD - DELETE - POST path: /query-pipelines/** uiPermissions: - user-profile - about-fusion - logout - object-explorer - datasources - scheduler - launcher - blobs - tasks - collections - index-workbench - index-pipelines - index-pipelines.delete - index-profiles - query-workbench - query-pipelines - query-pipelines.delete - query-profiles components: schemas: Role: required: - name type: object properties: id: type: string name: type: string createdAt: type: string format: date-time example: '2025-09-23T17:48:07Z' updatedAt: type: string format: date-time example: '2025-10-31T12:28:04Z' desc: type: string permissions: type: array items: $ref: '#/components/schemas/GlobPermission' uiPermissions: type: array items: type: string GlobPermission: type: object properties: methods: uniqueItems: true type: array items: type: string enum: - GET - POST - PUT - DELETE - HEAD - PATCH - OPTIONS path: type: string params: type: object additionalProperties: type: array items: type: string ````