{ "opencollection": "1.0.0", "info": { "name": "Grafana HTTP Access Teams API", "version": "11.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Teams", "type": "folder" }, "items": [ { "info": { "name": "Search teams", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/teams/search", "params": [ { "name": "query", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "perpage", "value": "", "type": "query" } ] }, "docs": "Search teams" }, { "info": { "name": "Create team", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/teams", "body": { "type": "json", "data": "{}" } }, "docs": "Create team" }, { "info": { "name": "Get team by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/teams/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get team by ID" }, { "info": { "name": "Update team", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/teams/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update team" }, { "info": { "name": "Delete team", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/teams/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete team" }, { "info": { "name": "Get team members", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/teams/:id/members", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get team members" }, { "info": { "name": "Add team member", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/teams/:id/members", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add team member" }, { "info": { "name": "Grafana Get Team By ID", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/teams/:team_id", "params": [ { "name": "team_id", "value": "", "type": "path" }, { "name": "accesscontrol", "value": "", "type": "query" } ] }, "docs": "This API operation retrieves detailed information about a specific team in Grafana by providing the team's unique identifier in the URL path. When a GET request is made to the /teams/{team_id} endpoint with a valid team ID, the API returns comprehensive data about that team, including properties such as the team name, email address, member count, and other relevant team metadata. This endpoint is typically used by administrators or applications that need to fetch information about a particular t" }, { "info": { "name": "Grafana Update Team", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/teams/:team_id", "params": [ { "name": "team_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing team in Grafana by modifying its properties such as name and email address. This endpoint requires the team ID as a path parameter and accepts a JSON payload containing the updated team information. The operation is typically used by administrators or users with appropriate permissions to maintain team configurations, ensuring that team metadata remains current and accurate within the Grafana organization." }, { "info": { "name": "Grafana Delete Team By ID", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/teams/:team_id", "params": [ { "name": "team_id", "value": "", "type": "path" } ] }, "docs": "This API operation removes a specific team from a Grafana instance by providing the team's unique identifier in the URL path. When executed, it performs a DELETE request to the endpoint /teams/{team_id}, where {team_id} is replaced with the numerical ID of the team to be deleted. The operation requires appropriate administrative permissions and will permanently remove the team along with its associated configurations, memberships, and permissions. Upon successful execution, the team will no long" }, { "info": { "name": "Grafana Get Team Members", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/teams/:team_id/members", "params": [ { "name": "team_id", "value": "", "type": "path" } ] }, "docs": "This API operation retrieves a list of all members belonging to a specific team in Grafana by providing the team's unique identifier in the URL path. When called, it returns detailed information about each team member including their user ID, email, login credentials, and role within the team. This is useful for administrators and team leaders who need to audit team composition, manage access permissions, or integrate Grafana team data with external systems for user management and reporting purp" }, { "info": { "name": "Grafana Add Team Member", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/teams/:team_id/members", "params": [ { "name": "team_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation adds a new member to a specific team in Grafana by making a POST request to the /teams/{team_id}/members endpoint, where {team_id} is the unique identifier of the team. The operation allows administrators or users with appropriate permissions to expand team membership by associating additional users with an existing team, typically requiring the user ID or username to be specified in the request body to identify which user should be added to the team." }, { "info": { "name": "Grafana Set Team Memberships", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/teams/:team_id/members", "params": [ { "name": "team_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The PUT operation on the /teams/{team_id}/members endpoint in Grafana allows administrators to set or update the complete membership roster for a specific team by providing the team_id parameter. This operation replaces the existing team membership list with the new set of members specified in the request body, effectively adding new members and removing any members not included in the updated list. It provides a comprehensive way to manage team composition in a single API call, rather than addi" }, { "info": { "name": "Grafana Update Team Member", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/teams/:team_id/members/:user_id", "params": [ { "name": "team_id", "value": "", "type": "path" }, { "name": "user_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the permissions of an existing team member in Grafana by specifying the team ID and user ID in the request path. This PUT operation allows administrators to modify a user's role or permission level within a specific team, such as changing them from a member to an admin or vice versa. The request typically requires authentication and appropriate administrative privileges to execute successfully, and it modifies the existing team membership record rather than creating a new one." }, { "info": { "name": "Grafana Remove Team Member", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/teams/:team_id/members/:user_id", "params": [ { "name": "team_id", "value": "", "type": "path" }, { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "Removes a specific user from a team by their user ID. This operation requires the team ID and user ID as path parameters. When executed, it deletes the membership association between the specified user and team, effectively revoking the user's access to team-specific resources and permissions. This is typically used when a user no longer needs to be part of a team or when reorganizing team structures within Grafana." }, { "info": { "name": "Grafana Get Team Preferences", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/teams/:team_id/preferences", "params": [ { "name": "team_id", "value": "", "type": "path" } ] }, "docs": "Returns the preferences for a specific Grafana team identified by the team_id parameter, which includes settings such as the team's home dashboard, timezone, and theme preferences. This GET endpoint allows administrators and team members with appropriate permissions to retrieve the current preference configuration that applies to all members of the specified team, enabling them to view or audit the team-level settings that override individual user preferences when working within the team context" }, { "info": { "name": "Grafana Update Team Preferences", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/teams/:team_id/preferences", "params": [ { "name": "team_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the preferences for a specific team in Grafana by making a PUT request to the /teams/{team_id}/preferences endpoint. This operation allows administrators or team members with appropriate permissions to modify team-level settings such as the default home dashboard, timezone, and theme preferences. The team_id parameter in the URL path identifies which team's preferences should be updated, and the request body contains the preference values to be applied. These preferences will affect the " }, { "info": { "name": "Grafana Get Team LBAC Rules Api", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/datasources/uid/:uid/lbac/teams", "params": [ { "name": "uid", "value": "", "type": "path" } ] }, "docs": "This API operation retrieves team-based Label-Based Access Control (LBAC) rules for a specific data source in Grafana identified by its unique identifier (uid). When called with a GET request to the endpoint /datasources/uid/{uid}/lbac/teams, it returns the configured LBAC rules that determine which teams have access to specific labels or subsets of data within the specified data source. This functionality is essential for managing granular permissions and ensuring teams can only query and view " }, { "info": { "name": "Grafana Update Team LBAC Rules Api", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/datasources/uid/:uid/lbac/teams", "params": [ { "name": "uid", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation updates the Label-Based Access Control (LBAC) rules for teams associated with a specific data source in Grafana. It uses the PUT method and targets a data source identified by its unique identifier (uid) in the endpoint path. The operation allows administrators to modify which teams have access to specific labels or subsets of data within the data source, enabling fine-grained access control at the team level. By updating these LBAC rules, organizations can ensure that differe" }, { "info": { "name": "Grafana List Teams Roles", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/access-control/teams/roles/search", "body": { "type": "json", "data": "{}" } }, "docs": "This API operation performs a search for team roles within Grafana's access control system. It uses a POST request to the /access-control/teams/roles/search endpoint to retrieve a list of roles that are associated with teams in the Grafana instance. The operation allows administrators to query and discover which roles have been assigned to various teams, helping them manage permissions and access control policies. This is useful for auditing team permissions, understanding role assignments, and " }, { "info": { "name": "Grafana List Team Roles", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/access-control/teams/:teamId/roles", "params": [ { "name": "teamId", "value": "", "type": "path" } ] }, "docs": "This API operation retrieves all roles assigned to a specific team in Grafana's access control system. By making a GET request to the endpoint with a team identifier, users can view the complete list of roles and their associated permissions that have been granted to that particular team. This is useful for auditing team permissions, understanding what access levels a team has across different resources, and managing role-based access control (RBAC) configurations within Grafana." }, { "info": { "name": "Grafana Add Team Role", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/access-control/teams/:teamId/roles", "params": [ { "name": "teamId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation adds a role to a specific team in Grafana's access control system. It uses a POST request to the endpoint /access-control/teams/{teamId}/roles, where {teamId} is the unique identifier of the team receiving the new role assignment. The operation allows administrators to grant specific permissions and access levels to an entire team by associating a role with that team, streamlining permission management across multiple users who belong to the same team." }, { "info": { "name": "Grafana Set Team Roles", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/access-control/teams/:teamId/roles", "params": [ { "name": "teamId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation updates the complete set of RBAC (Role-Based Access Control) roles assigned to a specific team in Grafana by replacing any existing role assignments with the new ones provided in the request. It uses the PUT method on the endpoint /access-control/teams/{teamId}/roles, where {teamId} is the unique identifier of the team whose roles are being modified. This is a destructive operation that overwrites the current role configuration rather than adding to it, making it useful for sc" }, { "info": { "name": "Grafana Remove Team Role", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/access-control/teams/:teamId/roles/:roleUID", "params": [ { "name": "roleUID", "value": "", "type": "path" }, { "name": "teamId", "value": "", "type": "path" } ] }, "docs": "This API operation removes a specific role assignment from a team in Grafana's access control system. It uses a DELETE request to the endpoint /access-control/teams/{teamId}/roles/{roleUID}, where teamId identifies the target team and roleUID specifies the role to be removed. When executed, it revokes the specified role's permissions from the team, effectively removing that role's access rights from all members of that team without affecting other role assignments the team may have." }, { "info": { "name": "Grafana Set Resource Permissions For Team", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/access-control/:resource/:resourceID/teams/:teamID", "params": [ { "name": "resource", "value": "", "type": "path" }, { "name": "resourceID", "value": "", "type": "path" }, { "name": "teamID", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation allows you to configure specific permissions for a team on a particular resource in Grafana's access control system. By making a POST request to this endpoint with the resource type, resource ID, and team ID, you can grant or update the access rights that a specific team has for that resource. This is part of Grafana's role-based access control (RBAC) functionality, enabling administrators to manage fine-grained permissions by assigning different levels of access to teams for " }, { "info": { "name": "Grafana Get Team Groups Api", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/teams/:teamId/groups", "params": [ { "name": "teamId", "value": "", "type": "path" } ] }, "docs": "This API operation retrieves the list of external groups that are synchronized with a specific team in Grafana. By providing a team ID in the path parameter, the endpoint returns all groups that have been mapped or linked to that team, which is particularly useful in environments where Grafana teams are integrated with external authentication providers like LDAP, OAuth, or SAML. This allows administrators to view and verify which external directory groups have access to a particular Grafana team" }, { "info": { "name": "Grafana Add Team Group Api", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/teams/:teamId/groups", "params": [ { "name": "teamId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The Add Team Group API is a POST operation available at the endpoint /teams/{teamId}/groups in Grafana that allows administrators to associate an external authentication group with a specific Grafana team. This operation requires the teamId parameter in the URL path to identify the target team, and typically accepts a request body containing details about the group to be added, such as the group identifier from the external authentication provider (like LDAP, OAuth, or SAML). When executed succe" }, { "info": { "name": "Grafana Remove Team Group Api Query", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/teams/:teamId/groups", "params": [ { "name": "groupId", "value": "", "type": "query" }, { "name": "teamId", "value": "", "type": "path" } ] }, "docs": "This API operation removes an external group mapping from a specified team in Grafana. When executed, it performs a DELETE request to the endpoint /teams/{teamId}/groups, where {teamId} represents the unique identifier of the team from which the group association should be removed. The operation is used to disconnect external authentication provider groups (such as LDAP, OAuth, or SAML groups) from Grafana teams, effectively revoking the automatic team membership that was granted to users belong" }, { "info": { "name": "Grafana Search Team Groups", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/teams/:teamId/groups/search", "params": [ { "name": "teamId", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "perpage", "value": "", "type": "query", "description": "Number of items per page" }, { "name": "query", "value": "", "type": "query", "description": "If set it will return results where the query value is contained in the name field. Query values with spaces need to be URL encoded." }, { "name": "name", "value": "", "type": "query", "description": "Filter by exact name match" } ] }, "docs": "This API operation performs a search for groups associated with a specific team in Grafana by making a GET request to the endpoint /teams/{teamId}/groups/search, where {teamId} is the unique identifier of the team whose groups you want to search. It allows administrators and authorized users to query and retrieve a list of groups that are linked to a particular team, which is useful for managing team memberships, permissions, and organizational structures within Grafana. The search functionality" }, { "info": { "name": "Grafana Get Signed In User Team List", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/user/teams" }, "docs": "This API operation retrieves a list of all teams that the currently authenticated user is a member of in Grafana. When called, it returns team information associated with the signed-in user's account, allowing applications to determine which teams the user belongs to and potentially their roles or permissions within those teams. This is useful for displaying team memberships in user interfaces, implementing team-based access controls, or filtering content based on team associations." }, { "info": { "name": "Grafana Get User Teams", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/users/:user_id/teams", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "This API operation retrieves a list of all teams that a specific user belongs to in Grafana. By making a GET request to the endpoint with a valid user ID parameter, the system returns information about the teams associated with that particular user, including team details such as team names, IDs, and potentially other relevant metadata. This is useful for administrators or applications that need to understand a user's team memberships and access permissions within the Grafana environment." } ] } ], "bundled": true }