Function doesUserHaveOrganizationWithTopicPermissionViaSubscription

  • doesUserHaveOrganizationWithTopicPermissionViaSubscription(chatService, organizationAPI, options, logger, context): Promise<number>

  • Does user have organization with topic permission via subscription validator

    Parameters

    • chatService: ChatDataService

      injected service used to handle the chat related operations

      • getOneTopic
      • getOneSubcription
      • getSubscriptions
    • organizationAPI: Pick<OrganizationDefaultAdapterAPI, "isUserInOrganization">

      injected connector used to handle the organization communication

    • options: {
          authSecrets: AuthSecrets;
          authenticate: AuthenticationFunction;
          permissions: string[];
          subscriptionIdField: TargetField;
      }

      Option

      • organizationIdField which field to get the organization id from
      • permissions which permissions to check
      • subscriptionIdField which field to get the subscriptionId id from
      • authSecrets: AuthSecrets
      • authenticate: AuthenticationFunction
      • permissions: string[]
      • subscriptionIdField: TargetField
    • logger: Logger

      injected logger used to handle the logging

    • context: AdapterHandlerContext

      request context [headers, body, params, query].

    Returns Promise<number>

    200 Status OK

    Description

    This validator checks if the logged in user has any topic permission by applying the following steps in sequence:

    1. Authenticate the user (authenticate)

    2. Get subscription by id (chatService.getOneSubscription)

    3. Get topic by id (chatService.getOneTopic)

    4. Get subscriptions by topicId and permissions (chatService.getSubscriptions)

    5. Check if user is in any organizationId returned from these

    6. Return 200 if the user has organization with the topic permission

    Throws

    403 NBError Forbidden

    • organizationId: organizationId not provided.
    • organization not subscribed to the topic: ${topicId}

    Throws

    404 NBError Not Found

    • subscription: ${subscriptionId} not found.

Settings

Member Visibility

Theme

Generated using TypeDoc