Function view

aleph/views/roles_api.py:167–204

Retrieve role details. --- post: summary: Retrieve role details description: > Fetch detailed information about a role that the user is entitled to access, e.g. their own role, or a group they are part of. parameters: - in: path name: i

(id)

@blueprint.route("/api/2/roles/<int:id>", methods=["GET"])
def view(id):
    """Retrieve role details.
    ---
    post:
      summary: Retrieve role details
      description: >
        Fetch detailed information about a role that the user is
        entitled to access, e.g. their own role, or a group they
        are part of.
      parameters:
      - in: path
        name: id
        required: true
        description: role ID
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
      tags:
      - Role
    """
    role = obj_or_404(Role.by_id(id))
    require(request.authz.can_read_role(role.id))
    data = role.to_dict()
    if request.authz.can_write_role(role.id):
        data.update(get_deep_role(role))
    if SETTINGS.MAINTENANCE:
        # Prevent continuous fetching of profile information in maintenance mode.
        # This is a workaround for the improper permission system (see "write" access).
        # This results in the email address not being shown on the profile page in
        # maintenance mode, but there is no other way to prevent constant re-fetching.
        data.update({"shallow": False})
    return RoleSerializer.jsonify(data)


@blueprint.route("/api/2/roles/<int:id>", methods=["POST", "PUT"])