Function isUserInOrganizationRoles

  • isUserInOrganizationRoles(roles, authSecrets, authenticate, targetField, organizationAPI, logger, context): Promise<number>

  • Is user in organization roles validator

    Parameters

    • roles: string[]

      array of roles to check

    • authSecrets: AuthSecrets

      authentication secret

    • authenticate: AuthenticationFunction

      injected authenticate function

    • targetField: TargetField

      target field to get the org id

    • organizationAPI: Pick<OrganizationDefaultAdapterAPI, "getUserOrganizations">

      injected api use to handle the organization related operations

      • getUserOrganizations
    • 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 is used to check if the user is in the organization roles by applying the following steps in sequence:

    1. Get the orgId from context

    2. Authenticate the request

    3. Get the user organizations by role (organizationAPI.getUserOrganizations)

    4. Check if the user is in the organization roles

    5. Return the status code

    Throws

    400 NBError Bad Request

    • cannot found parameter in ${targetField.type} ${targetField.name}

    Throws

    401 NBError Unauthorized

    • failed when authenticate

    Throws

    403 NBError Forbidden

    • user role is not match the expected

Settings

Member Visibility

Theme

Generated using TypeDoc