portainer/portainer

View on GitHub
api/http/handler/teams/team_inspect.go

Summary

Maintainability
A
40 mins
Test Coverage
package teams

import (
    "net/http"

    portainer "github.com/portainer/portainer/api"
    "github.com/portainer/portainer/api/http/errors"
    "github.com/portainer/portainer/api/http/security"
    httperror "github.com/portainer/portainer/pkg/libhttp/error"
    "github.com/portainer/portainer/pkg/libhttp/request"
    "github.com/portainer/portainer/pkg/libhttp/response"
)

// @id TeamInspect
// @summary Inspect a team
// @description Retrieve details about a team. Access is only available for administrator and leaders of that team.
// @description **Access policy**: administrator
// @tags teams
// @security ApiKeyAuth
// @security jwt
// @produce json
// @param id path int true "Team identifier"
// @success 200 {object} portainer.Team "Success"
// @success 204 "Success"
// @failure 400 "Invalid request"
// @failure 403 "Permission denied"
// @failure 404 "Team not found"
// @failure 500 "Server error"
// @router /teams/{id} [get]
func (handler *Handler) teamInspect(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
    teamID, err := request.RetrieveNumericRouteVariableValue(r, "id")
    if err != nil {
        return httperror.BadRequest("Invalid team identifier route variable", err)
    }

    securityContext, err := security.RetrieveRestrictedRequestContext(r)
    if err != nil {
        return httperror.InternalServerError("Unable to retrieve info from request context", err)
    }

    if !security.AuthorizedTeamManagement(portainer.TeamID(teamID), securityContext) {
        return httperror.Forbidden("Access denied to team", errors.ErrResourceAccessDenied)
    }

    team, err := handler.DataStore.Team().Read(portainer.TeamID(teamID))
    if handler.DataStore.IsErrObjectNotFound(err) {
        return httperror.NotFound("Unable to find a team with the specified identifier inside the database", err)
    } else if err != nil {
        return httperror.InternalServerError("Unable to find a team with the specified identifier inside the database", err)
    }

    return response.JSON(w, team)
}