Function index

aleph/views/groups_api.py:13–42

--- get: summary: List groups description: >- Get the list of groups the user belongs to. Groups are used for authorization. responses: '200': description: OK content: application/json: schema:

()

@blueprint.route("/api/2/groups", methods=["GET"])
def index():
    """
    ---
    get:
      summary: List groups
      description: >-
        Get the list of groups the user belongs to. Groups are used for
        authorization.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                allOf:
                - $ref: '#/components/schemas/QueryResponse'
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Role'
      tags:
      - Role
    """
    require(request.authz.logged_in)
    q = Role.all_groups(request.authz)
    return jsonify(
        {"total": q.count(), "results": RoleSerializer().serialize_many(q.all())}
    )