{ "opencollection": "1.0.0", "info": { "name": "Grafana HTTP Access Users API", "version": "11.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Users", "type": "folder" }, "items": [ { "info": { "name": "Create a new user (admin)", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/admin/users", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new user (admin)" }, { "info": { "name": "Search users", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/users", "params": [ { "name": "perpage", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "query", "value": "", "type": "query" } ] }, "docs": "Search users" }, { "info": { "name": "Get user by ID", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/users/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get user by ID" }, { "info": { "name": "Update user", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/users/:id", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update user" }, { "info": { "name": "Get current user", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/user" }, "docs": "Get current user" }, { "info": { "name": "Grafana Update Signed In User", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/user", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the profile information for the currently authenticated user in Grafana, allowing modification of fields such as email address, name, login username, and theme preferences. This endpoint requires the user to be signed in and operates on the user's own account, making it a self-service operation for managing personal account details. The request accepts a JSON payload containing the user attributes to be updated, and upon successful execution, returns the updated user information along wi" }, { "info": { "name": "Grafana Get Org Users", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/orgs/:org_id/users", "params": [ { "name": "org_id", "value": "", "type": "path" } ] }, "docs": "Retrieves a list of all users that belong to a specific organization in Grafana by providing the organization ID in the URL path. This GET endpoint returns user details including their names, email addresses, roles, and permissions within the specified organization, allowing administrators to view and manage organization membership and access control." }, { "info": { "name": "Grafana Add Org User", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/orgs/:org_id/users", "params": [ { "name": "org_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new user to an existing organization in Grafana by sending a POST request to the /orgs/{org_id}/users endpoint, where {org_id} is the unique identifier of the target organization. This operation requires authentication and appropriate permissions to manage organization membership. The request body typically includes the user's login credentials or user ID along with the desired role (such as Viewer, Editor, or Admin) that determines their access level within the organization. Upon success" }, { "info": { "name": "Grafana Search Org Users", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/orgs/:org_id/users/search", "params": [ { "name": "org_id", "value": "", "type": "path" } ] }, "docs": "This API operation allows you to search for users within a specific organization in Grafana by providing the organization ID in the URL path. It uses the GET HTTP method to retrieve a filtered list of users belonging to the specified organization, enabling administrators to query and find specific users based on search criteria. The endpoint is useful for managing organization membership and performing user lookups within the context of a particular Grafana organization." }, { "info": { "name": "Grafana Update Org User", "type": "http" }, "http": { "method": "PATCH", "url": "https://{instance}.grafana.net/api/orgs/:org_id/users/:user_id", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "user_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation updates an existing user's role within a specific organization in Grafana. It uses a PATCH request to the endpoint /orgs/{org_id}/users/{user_id}, where org_id identifies the target organization and user_id specifies which user's permissions should be modified. The operation allows administrators to change a user's role (such as Viewer, Editor, or Admin) within the organization context, enabling granular control over user permissions and access levels across different Grafana " }, { "info": { "name": "Grafana Remove Org User", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/orgs/:org_id/users/:user_id", "params": [ { "name": "org_id", "value": "", "type": "path" }, { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "This API operation removes a specific user from a designated organization in Grafana by sending a DELETE request to the endpoint /orgs/{org_id}/users/{user_id}, where org_id represents the unique identifier of the organization and user_id represents the unique identifier of the user to be removed. When executed successfully, this operation revokes the user's membership and access rights within the specified organization, effectively disconnecting them from that particular organizational context " }, { "info": { "name": "Grafana Get Org Users For Current Org", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/org/users", "params": [ { "name": "query", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "This API operation retrieves a list of all users who belong to the currently authenticated organization in Grafana. When called, it returns user information for members of the organization context associated with the API request, including details such as user IDs, email addresses, login names, roles within the organization, and authentication information. This is useful for administrators who need to audit organization membership, manage user access, or integrate Grafana's user management with " }, { "info": { "name": "Grafana Add Org User To Current Org", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/org/users", "body": { "type": "json", "data": "{}" } }, "docs": "This API operation allows administrators to add a new user to the current organization in Grafana by sending a POST request to the /org/users endpoint. When invoked, it creates a new membership association between a specified user and the organization that the authenticated user currently belongs to. The request typically requires parameters such as the user's login credentials or user ID, along with the desired role (Viewer, Editor, or Admin) that the new member should have within the organizat" }, { "info": { "name": "Grafana Get Org Users For Current Org Lookup", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/org/users/lookup", "params": [ { "name": "query", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "This API operation retrieves user information for members of the current organization in Grafana by performing a lookup query. It uses a GET request to the '/org/users/lookup' endpoint and returns details about users belonging to the organization context of the authenticated request. This is typically used when you need to search for or validate specific users within your current Grafana organization without iterating through the entire user list, providing a more efficient way to find user data" }, { "info": { "name": "Grafana Update Org User For Current Org", "type": "http" }, "http": { "method": "PATCH", "url": "https://{instance}.grafana.net/api/org/users/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation allows you to update an existing organization user's details within the currently authenticated organization in Grafana. By sending a PATCH request to the endpoint with a specific user ID, you can modify properties such as the user's role within the organization without affecting their underlying Grafana user account. This is particularly useful for managing permissions and access levels of team members, allowing administrators to promote users to admin roles or adjust their o" }, { "info": { "name": "Grafana Remove Org User For Current Org", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/org/users/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "This API operation removes a specified user from the current organization in Grafana by making a DELETE request to the endpoint /org/users/{user_id}, where {user_id} is the unique identifier of the user to be removed. When executed, it disassociates the targeted user from the organization context in which the API call is made, effectively revoking their access and permissions within that specific organization. This operation requires appropriate administrative privileges within the current organ" }, { "info": { "name": "Grafana List Users Roles", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/access-control/users/roles/search", "body": { "type": "json", "data": "{}" } }, "docs": "This API operation allows you to search and retrieve a list of roles assigned to users within Grafana's access control system. By sending a POST request to the /access-control/users/roles/search endpoint, you can query and filter user role assignments based on various criteria. The operation is useful for administrators who need to audit user permissions, manage access control policies, or retrieve information about which roles are assigned to specific users across the Grafana instance. The POST" }, { "info": { "name": "Grafana List User Roles", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/access-control/users/:userId/roles", "params": [ { "name": "userId", "value": "", "type": "path" } ] }, "docs": "This API operation retrieves all roles assigned to a specific user in Grafana's access control system. By making a GET request to the endpoint with a user's unique identifier (userId) in the path, you can obtain a comprehensive list of roles that define the user's permissions and access levels within the Grafana instance. This is useful for auditing user permissions, verifying access levels, or managing role-based access control (RBAC) configurations." }, { "info": { "name": "Grafana Add User Role", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/access-control/users/:userId/roles", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation adds a role to a specific user in Grafana's access control system by sending a POST request to the endpoint /access-control/users/{userId}/roles, where {userId} is replaced with the target user's identifier. The operation allows administrators to grant additional permissions and access rights to users by assigning them predefined or custom roles within the Grafana instance. This is typically used for managing user permissions and implementing role-based access control (RBAC) t" }, { "info": { "name": "Grafana Set User Roles", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/access-control/users/:userId/roles", "params": [ { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation allows administrators to assign or modify the complete set of roles for a specific user in Grafana's access control system. By making a PUT request to the endpoint with a user's ID, you can replace all existing role assignments for that user with a new set of roles defined in the request body. This is useful for managing user permissions at scale, ensuring users have the appropriate access levels to dashboards, data sources, and other Grafana resources. The operation requires " }, { "info": { "name": "Grafana Remove User Role", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/access-control/users/:userId/roles/:roleUID", "params": [ { "name": "global", "value": "", "type": "query", "description": "A flag indicating if the assignment is global or not. If set to false, the default org ID of the authenticated user will be used from the request to remove assignment." }, { "name": "roleUID", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Removes a specific role assignment from a user in Grafana's access control system. This API endpoint deletes the association between a user (identified by userId) and a particular role (identified by roleUID), effectively revoking the permissions granted by that role from the user. The operation requires appropriate administrative privileges and is typically used when managing user permissions, reorganizing team structures, or removing access rights that are no longer needed. Upon successful exe" }, { "info": { "name": "Grafana Set Resource Permissions For User", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/access-control/:resource/:resourceID/users/:userID", "params": [ { "name": "resource", "value": "", "type": "path" }, { "name": "resourceID", "value": "", "type": "path" }, { "name": "userID", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation allows administrators to configure specific access control permissions for an individual user on a particular Grafana resource. By making a POST request to this endpoint with the resource type, resource ID, and user ID, you can grant or modify the permissions that determine what actions the specified user can perform on that resource. This granular permission management enables fine-tuned control over user access rights within Grafana, allowing administrators to implement role" }, { "info": { "name": "Grafana Post Sync User With LDAP", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/admin/ldap/sync/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "This API operation triggers a synchronization between a specific Grafana user and LDAP directory services by sending a POST request to the endpoint with the target user's ID. When invoked, it forces Grafana to retrieve the latest user information, groups, and permissions from the configured LDAP server for the specified user, updating their local Grafana profile accordingly. This is particularly useful when LDAP user attributes or group memberships have changed and you need to immediately reflec" }, { "info": { "name": "Grafana Get User From LDAP", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/admin/ldap/:user_name", "params": [ { "name": "user_name", "value": "", "type": "path" } ] }, "docs": "This API operation retrieves LDAP user information for a specific username from Grafana's admin interface. By making a GET request to the endpoint with a username parameter, administrators can query the LDAP directory to fetch detailed user data associated with that particular account. This is useful for verifying LDAP user configurations, troubleshooting authentication issues, or confirming user attributes before syncing them into Grafana. The operation requires admin-level permissions and retu" }, { "info": { "name": "Grafana Admin Delete User", "type": "http" }, "http": { "method": "DELETE", "url": "https://{instance}.grafana.net/api/admin/users/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "This API operation allows Grafana administrators with appropriate permissions to permanently delete a specific user account from the Grafana instance by making a DELETE request to the /admin/users/{user_id} endpoint, where {user_id} is the unique identifier of the target user. This is a privileged administrative function that removes the user and all associated data from the system, and should be used with caution as the deletion is typically irreversible. The operation requires admin-level auth" }, { "info": { "name": "Grafana Admin Get User Auth Tokens", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/admin/users/:user_id/auth-tokens", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "Retrieves a list of authentication tokens associated with a specific user account in Grafana. This administrative endpoint requires admin privileges and allows system administrators to view all active auth tokens that have been generated for a particular user identified by their user ID. The operation returns token metadata including creation dates, last used timestamps, and token names, which helps administrators audit user access, monitor authentication activity, and identify potentially unaut" }, { "info": { "name": "Grafana Admin Disable User", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/admin/users/:user_id/disable", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "This API operation allows Grafana administrators to disable a specific user account by sending a POST request to the /admin/users/{user_id}/disable endpoint. The operation requires administrative privileges and targets a user identified by their unique user_id parameter in the URL path. When executed, this endpoint deactivates the specified user account, preventing them from logging in or accessing Grafana resources while preserving their user data and configurations for potential future reactiv" }, { "info": { "name": "Grafana Admin Enable User", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/admin/users/:user_id/enable", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "This API operation is used by Grafana administrators to re-enable a previously disabled user account. It requires a POST request to the endpoint with the specific user ID as a path parameter. Only users with admin privileges can execute this operation, which restores access for users who may have been temporarily disabled due to security concerns, policy violations, or administrative purposes. Upon successful execution, the specified user account is activated and the user can log in and access G" }, { "info": { "name": "Grafana Admin Logout User", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/admin/users/:user_id/logout", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "This API operation allows a Grafana administrator to forcibly log out a specific user by sending a POST request to the endpoint with the target user's ID. When invoked, it invalidates all active sessions for the specified user, effectively disconnecting them from Grafana and requiring them to re-authenticate before accessing the system again. This is typically used for security purposes, such as immediately revoking access when a user account is compromised, when enforcing policy changes, or whe" }, { "info": { "name": "Grafana Admin Update User Password", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/admin/users/:user_id/password", "params": [ { "name": "user_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation allows Grafana administrators to programmatically update the password for a specific user account by sending a PUT request to the endpoint with the target user's ID. The administrator must provide the new password in the request body, and this action requires admin-level privileges to execute. This operation is particularly useful for password resets, account recovery scenarios, or when administrators need to enforce password changes for security purposes without requiring the" }, { "info": { "name": "Grafana Admin Update User Permissions", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/admin/users/:user_id/permissions", "params": [ { "name": "user_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the permissions for a specific user in Grafana through an administrative endpoint. This operation requires admin privileges and allows modification of user permission settings by targeting a specific user via their user_id parameter in the URL path. The PUT method indicates this is a full update of the user's permission configuration, replacing the existing permissions with the new settings provided in the request body. This is typically used by system administrators to grant or revoke a" }, { "info": { "name": "Grafana Admin Revoke User Auth Token", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/admin/users/:user_id/revoke-auth-token", "params": [ { "name": "user_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation allows a Grafana administrator to forcibly revoke a specific authentication token for a given user by making a POST request to the endpoint with the target user's ID. When executed, it invalidates the specified auth token, effectively logging out that user from any session using that particular token, which is useful for security purposes such as when a token may have been compromised or when an administrator needs to terminate a user's access immediately without affecting oth" }, { "info": { "name": "Grafana Get User Quota", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/admin/users/:user_id/quotas", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "This API operation retrieves the current quota limits and usage statistics for a specific user in Grafana. By making a GET request to the /admin/users/{user_id}/quotas endpoint with a valid user ID, administrators can view resource allocation details such as the maximum number of dashboards, data sources, or organizations that the specified user is allowed to create or use. The response provides both the configured quota limits and the current consumption for each quota type, enabling administra" }, { "info": { "name": "Grafana Update User Quota", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/admin/users/:user_id/quotas/:quota_target", "params": [ { "name": "quota_target", "value": "", "type": "path" }, { "name": "user_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API operation allows Grafana administrators to update quota limits for a specific user by targeting a particular quota type. It uses a PUT request to modify the quota value associated with the specified user ID and quota target, which could be related to resources like dashboards, data sources, or other Grafana entities. The operation requires admin-level privileges and accepts the user ID and quota target as path parameters, along with the new quota value in the request body, enabling fine" }, { "info": { "name": "Grafana Get User Quotas", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/user/quotas" }, "docs": "This API operation retrieves the current quota limits and usage for a specific user in Grafana. Quotas define resource limitations such as the maximum number of dashboards, data sources, or organizations that a user can create or belong to. By making a GET request to the /user/quotas endpoint, administrators can view the configured quota settings for the authenticated user, which helps in monitoring resource allocation and ensuring users stay within their assigned limits. The response typically " }, { "info": { "name": "Grafana Get User Auth Tokens", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/user/auth-tokens" }, "docs": "This API operation retrieves a list of authentication tokens associated with the currently authenticated user in Grafana. When called via a GET request to the /user/auth-tokens endpoint, it returns information about active auth tokens that have been generated for the user's account, typically including details such as token IDs, creation timestamps, last used dates, and expiration information. This allows users to view and manage their active sessions and API tokens for security and access contr" }, { "info": { "name": "Grafana Get Signed In User Org List", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/user/orgs" }, "docs": "This API endpoint retrieves a list of all organizations associated with the currently authenticated user in Grafana. When called with a GET request to /user/orgs, it returns information about each organization the signed-in user belongs to, typically including details such as organization ID, name, and the user's role within each organization. This is useful for applications that need to display or process the organizational memberships of the current user, allowing them to understand which orga" }, { "info": { "name": "Grafana Change User Password", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/user/password", "body": { "type": "json", "data": "{}" } }, "docs": "Changes the password for the currently authenticated user in Grafana. This endpoint requires the user to provide their current password along with the new password they wish to set. The operation is performed as a PUT request to the /user/password endpoint and can only modify the password of the user making the request, not other users in the system. Authentication is required to access this endpoint, and the request must include both the old password for verification and the new password that m" }, { "info": { "name": "Grafana Get User Preferences", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/user/preferences" }, "docs": "This API operation retrieves the current preferences for the authenticated user in Grafana. It returns configuration settings such as the user's preferred theme (light or dark mode), home dashboard ID, timezone settings, and UI language preferences. The endpoint requires authentication and returns a JSON object containing all the preference values associated with the logged-in user's account, allowing applications to understand and respect the user's personalized Grafana interface settings." }, { "info": { "name": "Grafana Update User Preferences", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/user/preferences", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the preferences for the currently authenticated user in Grafana, allowing modification of settings such as theme (light/dark), home dashboard, timezone, and language preferences. This endpoint requires authentication and only affects the preferences of the user making the request. The operation accepts a JSON payload containing the preference fields to be updated, and returns the updated preference object upon successful modification. Changes take effect immediately for the user's sessio" }, { "info": { "name": "Grafana Patch User Preferences", "type": "http" }, "http": { "method": "PATCH", "url": "https://{instance}.grafana.net/api/user/preferences", "body": { "type": "json", "data": "{}" } }, "docs": "Updates the preferences for the currently authenticated user by allowing partial modifications to settings such as theme (light/dark), timezone, home dashboard ID, and UI preferences. This PATCH endpoint enables users to customize their Grafana experience by submitting only the specific preference fields they want to change, without needing to provide all preference values. The operation requires authentication and only affects the preferences of the user making the request, leaving unchanged an" }, { "info": { "name": "Grafana Revoke User Auth Token", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/user/revoke-auth-token", "body": { "type": "json", "data": "{}" } }, "docs": "This API operation allows for the revocation of a specific authentication token associated with a user in Grafana. When invoked via a POST request to the /user/revoke-auth-token endpoint, it invalidates the specified auth token, effectively logging out the user from any session using that particular token. This is useful for security purposes when a user wants to manually terminate access from a specific device or session, or when an administrator needs to force a logout. The operation requires " }, { "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 User Set Using Org", "type": "http" }, "http": { "method": "POST", "url": "https://{instance}.grafana.net/api/user/using/:org_id", "params": [ { "name": "org_id", "value": "", "type": "path" } ] }, "docs": "This API operation allows a user to switch their current active organization context in Grafana by specifying a target organization ID in the request path. When executed via a POST request to the /user/using/{org_id} endpoint, it changes the user's working context to the specified organization, making that organization the active one for subsequent operations. This is particularly useful in multi-tenant Grafana deployments where users belong to multiple organizations and need to switch between t" }, { "info": { "name": "Grafana Update User Email", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/user/email/update" }, "docs": "This API operation allows for updating the email address associated with a user account in Grafana. When invoked via a GET request to the /user/email/update endpoint, it modifies the email address of the currently authenticated user. The operation requires the user to be logged in and typically needs the new email address to be provided as a parameter. This endpoint is useful for maintaining accurate user contact information and ensuring proper communication channels within the Grafana platform." }, { "info": { "name": "Grafana Get User By Login Or Email", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/users/lookup", "params": [ { "name": "loginOrEmail", "value": "", "type": "query", "description": "loginOrEmail of the user" } ] }, "docs": "The Grafana API endpoint /users/lookup with the GET method allows administrators to retrieve detailed information about a specific user by providing either their login username or email address as a query parameter. This operation is particularly useful when you need to fetch user details but only have their login credentials or email rather than their numeric user ID. The endpoint returns comprehensive user information including the user's ID, email, name, login, theme preferences, organization" }, { "info": { "name": "Grafana Search Users With Paging", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/users/search" }, "docs": "This API operation performs a paginated search of users within a Grafana instance, allowing administrators or authorized users to retrieve a list of user accounts based on specific search criteria. The GET request to the /users/search endpoint returns user information in a structured format with pagination support, making it efficient to handle large numbers of users by breaking results into manageable pages. This operation is commonly used in administrative interfaces, user management dashboard" }, { "info": { "name": "Grafana Get User By ID", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/users/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "This API operation retrieves detailed information about a specific Grafana user by their unique user identifier. By sending a GET request to the endpoint with a valid user_id parameter, administrators or authorized users can fetch comprehensive user data including username, email, authentication details, organization memberships, and user preferences. This operation is typically used for user management tasks, displaying user profiles, or verifying user information within Grafana instances, and " }, { "info": { "name": "Grafana Update User", "type": "http" }, "http": { "method": "PUT", "url": "https://{instance}.grafana.net/api/users/:user_id", "params": [ { "name": "user_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "The PUT operation on the /users/{user_id} endpoint in Grafana allows administrators to update an existing user's account information by specifying the user's unique identifier in the URL path. This endpoint enables modification of user attributes such as email address, login username, display name, and theme preferences. The request requires appropriate administrative privileges and accepts a JSON payload containing the fields to be updated. Upon successful execution, the API returns the updated" }, { "info": { "name": "Grafana Get User Org List", "type": "http" }, "http": { "method": "GET", "url": "https://{instance}.grafana.net/api/users/:user_id/orgs", "params": [ { "name": "user_id", "value": "", "type": "path" } ] }, "docs": "Retrieves a list of all organizations associated with a specific user identified by their user ID in Grafana. This endpoint returns organization membership information for the specified user, including details about each organization they belong to. It requires appropriate authentication and permissions to access user-organization relationship data, making it useful for administrators who need to audit user access across multiple organizations or for displaying a user's organizational affiliatio" }, { "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 }