> ## Documentation Index > Fetch the complete documentation index at: https://insightsoftware.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Submit registration ## OpenAPI ````yaml /simba-embedded-analytics/docs/self-service-analytics/26.3/api-swagger/ssa-api-docs-26-3.json post /api/register openapi: 3.1.0 info: title: Logi Composer Rest API description: >- The Composer REST API provides methods for retrieving, updating, and deleting Composer metadata. With the API endpoints, you can manage connections, data sources, accounts, groups, and users quickly and easily. ## Authentication This API supports the following authentication schemes: - **basicAuth** – HTTP Basic authentication using global administrator credentials (username and password). Required for most endpoints. - **trustedAccessAuth** – HTTP Basic authentication using Trusted Access client credentials. Use the **client ID** as the username and the **client secret** as the password. Required for Trusted Access token and session endpoints. - **bearerAuth** – HTTP Bearer token authentication. Supply a token previously obtained from a Trusted Access token endpoint (`/api/trusted-access/push/tokens` or `/api/trusted-access/pull/tokens`). contact: name: Logi Support url: https://help.insightsoftware.com email: logisupport@insightsoftware.com version: '1.0' servers: - url: http://10.2.4.166:8080/composer description: Generated server url security: - basicAuth: [] tags: - name: account-attributes description: Reserved Account attributes configuration - name: accounts description: Manage Accounts - name: accounts / admins description: Manage Account Administrators - name: accounts / users description: Manage Account Users - name: actions description: Manage Action Templates - name: activity description: Manages Activity Logging - name: alerts description: Manage Alerts - name: branding description: Manage branding configuration - name: branding-extentions description: Manage branding extensions (chart colors, etc.) - name: calendars description: (experimental) Manage calendars - name: comments description: Dashboard comments - name: connection-types description: Manage Connection Types - name: connections description: Manage Source Connections - name: connectors description: Manage Connectors - name: conversations description: Manage Workspace Conversations - name: customization description: Manage customization configuration - name: dashboard-conversion description: (experimental) Convert dashboards layout - name: dashboard-migration description: New Dashboards Migration API - name: dashboard-reports description: Manage Dashboard Reports - name: dashboard-sharing description: (experimental) Manage dashboard access level - name: dashboards description: Manage Dashboards - name: export description: Export Source Data - name: favorites description: Favorite Items - name: filter-sets description: Filter Visualizations Data - name: folders description: Manage folders - name: frontend / environment variables description: Get environment variables for frontend - name: global description: Manage global security configuration - name: group-membership description: Manages Group Membership - name: groups description: Manage User Groups - name: interactivity description: Dashboard interactivity - name: inventory description: Manage Composer Items - name: jobs description: List of available scheduler jobs - name: joins description: Manage joins metadata and suggestions - name: json-datasets description: Manage JSON datasets - name: kerberos description: Manage Kerberos Config - name: keyset description: Manage keysets - name: ldap description: Manage LDAP Configuration - name: license description: Manage Composer License - name: locale, currency, language description: Locale, currency, and language info - name: materialized-view description: (deprecated since 23.1) Manage Materialized Views - name: odata description: (experimental) Source Data Retrieval OData service - name: password-reset description: Self-service forgot-password flow - name: permissions description: Manage Permissions - name: Publish description: Publish Workspace Artifacts - name: quota description: Manage Quotas - name: recentlyAccessed description: Recently Accessed Elements - name: register description: User registration - name: saml description: Manage SAML - name: security description: Retrieve all sids info - name: self-service-reports description: Self Service Reports - name: sharing description: (experimental) Manage dashboard sharing - name: snapshots description: Create and manage entity snapshots - name: snippets description: (experimental) Manage snippets - name: sources description: Manage Sources - name: sources / cache-settings description: Manages sources cache settings - name: sources / custom-metrics description: Manage Source Custom Metrics - name: sources / dictionaries description: Manage Source Dictionaries - name: sources / fields description: Manage Source Fields - name: sources / global-settings description: Manages sources global settings - name: sources / migration description: Source Migration API - name: sources / preview and describe description: Source preview and describe - name: sources / raw data description: (experimental) Get source raw data - name: sources / security description: Manage Sources Security - name: sources / security / custom metrics description: (experimental) Manage Sources Custom Metric Security - name: sources / security / fields description: Manage Sources Fields Security - name: sources / security / row description: Manage Sources Row Security - name: sources / unique-key description: Manages sources unique key - name: sources / visual-types description: Manages source visual types - name: start-vis description: (experimental) Execute start-vis or meta request - name: stream description: Search stream sources - name: tags description: Manage tags - name: timezones description: Timezone Information - name: toggle description: Toggle Features - name: topics description: Manage topics - name: trusted-access-client description: Manage Trusted Access clients - name: trusted-access-session description: Manage user sessions via Trusted Access - name: trusted-access-token description: Manage Trusted Access tokens - name: uploads description: Manage Uploads - name: user description: Manage User - name: users description: Manage Users - name: users segregation description: Segregate users into tenants - name: version description: System version - name: visual-types description: Manage Visual Types - name: visuals description: Manage Visuals - name: visuals / migration description: New Visuals Migration API - name: workspaces description: Manage Workspaces paths: /api/register: post: tags: - register summary: Submit registration operationId: register parameters: - name: turnRegistrationOff in: query required: false schema: type: string - name: submitBtn in: query required: false schema: type: string responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/RedirectView' components: schemas: RedirectView: type: object properties: applicationContext: $ref: '#/components/schemas/ApplicationContext' servletContext: $ref: '#/components/schemas/ServletContext' writeOnly: true contentType: type: string requestContextAttribute: type: string staticAttributes: type: object additionalProperties: {} exposePathVariables: type: boolean exposeContextBeansAsAttributes: type: boolean writeOnly: true exposedContextBeanNames: type: array items: type: string writeOnly: true beanName: type: string url: type: string contextRelative: type: boolean writeOnly: true http10Compatible: type: boolean writeOnly: true exposeModelAttributes: type: boolean writeOnly: true encodingScheme: type: string writeOnly: true statusCode: oneOf: - $ref: '#/components/schemas/DefaultHttpStatusCode' - $ref: '#/components/schemas/HttpStatus' writeOnly: true expandUriTemplateVariables: type: boolean writeOnly: true propagateQueryParams: type: boolean writeOnly: true hosts: type: array items: type: string propagateQueryProperties: type: boolean redirectView: type: boolean attributesCSV: type: string writeOnly: true attributes: type: object additionalProperties: type: string writeOnly: true attributesMap: type: object additionalProperties: {} ApplicationContext: type: object properties: parent: $ref: '#/components/schemas/ApplicationContext' id: type: string displayName: type: string autowireCapableBeanFactory: $ref: '#/components/schemas/AutowireCapableBeanFactory' applicationName: type: string startupDate: type: integer format: int64 environment: $ref: '#/components/schemas/Environment' beanDefinitionCount: type: integer format: int32 beanDefinitionNames: type: array items: type: string parentBeanFactory: $ref: '#/components/schemas/BeanFactory' classLoader: type: object properties: name: type: string registeredAsParallelCapable: type: boolean parent: type: object properties: name: type: string registeredAsParallelCapable: type: boolean unnamedModule: type: object properties: name: type: string descriptor: type: object properties: open: type: boolean automatic: type: boolean named: type: boolean annotations: type: array items: {} declaredAnnotations: type: array items: {} packages: type: array items: type: string uniqueItems: true nativeAccessEnabled: type: boolean layer: {} definedPackages: type: array items: type: object properties: name: type: string annotations: type: array items: {} declaredAnnotations: type: array items: {} sealed: type: boolean specificationTitle: type: string specificationVersion: type: string specificationVendor: type: string implementationTitle: type: string implementationVersion: type: string implementationVendor: type: string defaultAssertionStatus: type: boolean writeOnly: true unnamedModule: type: object properties: name: type: string descriptor: type: object properties: open: type: boolean automatic: type: boolean named: type: boolean annotations: type: array items: {} declaredAnnotations: type: array items: {} packages: type: array items: type: string uniqueItems: true nativeAccessEnabled: type: boolean layer: {} definedPackages: type: array items: type: object properties: name: type: string annotations: type: array items: {} declaredAnnotations: type: array items: {} sealed: type: boolean specificationTitle: type: string specificationVersion: type: string specificationVendor: type: string implementationTitle: type: string implementationVersion: type: string implementationVendor: type: string defaultAssertionStatus: type: boolean writeOnly: true ServletContext: type: object properties: classLoader: type: object properties: name: type: string registeredAsParallelCapable: type: boolean parent: type: object properties: name: type: string registeredAsParallelCapable: type: boolean unnamedModule: type: object properties: name: type: string descriptor: type: object properties: open: type: boolean automatic: type: boolean named: type: boolean annotations: type: array items: {} declaredAnnotations: type: array items: {} packages: type: array items: type: string uniqueItems: true nativeAccessEnabled: type: boolean layer: {} definedPackages: type: array items: type: object properties: name: type: string annotations: type: array items: {} declaredAnnotations: type: array items: {} sealed: type: boolean specificationTitle: type: string specificationVersion: type: string specificationVendor: type: string implementationTitle: type: string implementationVersion: type: string implementationVendor: type: string defaultAssertionStatus: type: boolean writeOnly: true unnamedModule: type: object properties: name: type: string descriptor: type: object properties: open: type: boolean automatic: type: boolean named: type: boolean annotations: type: array items: {} declaredAnnotations: type: array items: {} packages: type: array items: type: string uniqueItems: true nativeAccessEnabled: type: boolean layer: {} definedPackages: type: array items: type: object properties: name: type: string annotations: type: array items: {} declaredAnnotations: type: array items: {} sealed: type: boolean specificationTitle: type: string specificationVersion: type: string specificationVendor: type: string implementationTitle: type: string implementationVersion: type: string implementationVendor: type: string defaultAssertionStatus: type: boolean writeOnly: true majorVersion: type: integer format: int32 minorVersion: type: integer format: int32 attributeNames: {} contextPath: type: string initParameterNames: {} effectiveMajorVersion: type: integer format: int32 effectiveMinorVersion: type: integer format: int32 serverInfo: type: string servletContextName: type: string servletRegistrations: type: object additionalProperties: $ref: '#/components/schemas/ServletRegistration' defaultSessionTrackingModes: type: array items: type: string enum: - COOKIE - URL - SSL uniqueItems: true filterRegistrations: type: object additionalProperties: $ref: '#/components/schemas/FilterRegistration' sessionCookieConfig: $ref: '#/components/schemas/SessionCookieConfig' sessionTrackingModes: type: array items: type: string enum: - COOKIE - URL - SSL uniqueItems: true writeOnly: true effectiveSessionTrackingModes: type: array items: type: string enum: - COOKIE - URL - SSL uniqueItems: true jspConfigDescriptor: $ref: '#/components/schemas/JspConfigDescriptor' virtualServerName: type: string sessionTimeout: type: integer format: int32 requestCharacterEncoding: type: string responseCharacterEncoding: type: string DefaultHttpStatusCode: allOf: - $ref: '#/components/schemas/HttpStatusCode' HttpStatus: allOf: - $ref: '#/components/schemas/HttpStatusCode' enum: - 100 CONTINUE - 101 SWITCHING_PROTOCOLS - 102 PROCESSING - 103 EARLY_HINTS - 200 OK - 201 CREATED - 202 ACCEPTED - 203 NON_AUTHORITATIVE_INFORMATION - 204 NO_CONTENT - 205 RESET_CONTENT - 206 PARTIAL_CONTENT - 207 MULTI_STATUS - 208 ALREADY_REPORTED - 226 IM_USED - 300 MULTIPLE_CHOICES - 301 MOVED_PERMANENTLY - 302 FOUND - 303 SEE_OTHER - 304 NOT_MODIFIED - 307 TEMPORARY_REDIRECT - 308 PERMANENT_REDIRECT - 400 BAD_REQUEST - 401 UNAUTHORIZED - 402 PAYMENT_REQUIRED - 403 FORBIDDEN - 404 NOT_FOUND - 405 METHOD_NOT_ALLOWED - 406 NOT_ACCEPTABLE - 407 PROXY_AUTHENTICATION_REQUIRED - 408 REQUEST_TIMEOUT - 409 CONFLICT - 410 GONE - 411 LENGTH_REQUIRED - 412 PRECONDITION_FAILED - 413 CONTENT_TOO_LARGE - 413 PAYLOAD_TOO_LARGE - 414 URI_TOO_LONG - 415 UNSUPPORTED_MEDIA_TYPE - 416 REQUESTED_RANGE_NOT_SATISFIABLE - 417 EXPECTATION_FAILED - 418 I_AM_A_TEAPOT - 421 MISDIRECTED_REQUEST - 422 UNPROCESSABLE_CONTENT - 422 UNPROCESSABLE_ENTITY - 423 LOCKED - 424 FAILED_DEPENDENCY - 425 TOO_EARLY - 426 UPGRADE_REQUIRED - 428 PRECONDITION_REQUIRED - 429 TOO_MANY_REQUESTS - 431 REQUEST_HEADER_FIELDS_TOO_LARGE - 451 UNAVAILABLE_FOR_LEGAL_REASONS - 500 INTERNAL_SERVER_ERROR - 501 NOT_IMPLEMENTED - 502 BAD_GATEWAY - 503 SERVICE_UNAVAILABLE - 504 GATEWAY_TIMEOUT - 505 HTTP_VERSION_NOT_SUPPORTED - 506 VARIANT_ALSO_NEGOTIATES - 507 INSUFFICIENT_STORAGE - 508 LOOP_DETECTED - 509 BANDWIDTH_LIMIT_EXCEEDED - 510 NOT_EXTENDED - 511 NETWORK_AUTHENTICATION_REQUIRED AutowireCapableBeanFactory: {} Environment: type: object properties: activeProfiles: type: array items: type: string defaultProfiles: type: array items: type: string BeanFactory: {} ServletRegistration: type: object properties: mappings: type: array items: type: string runAsRole: type: string name: type: string className: type: string initParameters: type: object additionalProperties: type: string FilterRegistration: type: object properties: servletNameMappings: type: array items: type: string urlPatternMappings: type: array items: type: string name: type: string className: type: string initParameters: type: object additionalProperties: type: string SessionCookieConfig: type: object properties: maxAge: type: integer format: int32 httpOnly: type: boolean secure: type: boolean domain: type: string name: type: string path: type: string attributes: type: object additionalProperties: type: string comment: type: string deprecated: true JspConfigDescriptor: type: object properties: taglibs: type: array items: $ref: '#/components/schemas/TaglibDescriptor' jspPropertyGroups: type: array items: $ref: '#/components/schemas/JspPropertyGroupDescriptor' HttpStatusCode: type: object properties: error: type: boolean is4xxClientError: type: boolean is5xxServerError: type: boolean is1xxInformational: type: boolean is2xxSuccessful: type: boolean is3xxRedirection: type: boolean TaglibDescriptor: type: object properties: taglibURI: type: string taglibLocation: type: string JspPropertyGroupDescriptor: type: object properties: isXml: type: string includePreludes: type: array items: type: string includeCodas: type: array items: type: string trimDirectiveWhitespaces: type: string errorOnUndeclaredNamespace: type: string deferredSyntaxAllowedAsLiteral: type: string elIgnored: type: string errorOnELNotFound: type: string pageEncoding: type: string scriptingInvalid: type: string defaultContentType: type: string buffer: type: string urlPatterns: type: array items: type: string securitySchemes: basicAuth: type: http description: >- HTTP Basic authentication using global administrator credentials (username and password). scheme: basic ````