Variable: removed __user.name/___.user.email from global variables and added docs for the rest of the __user variable. (#25275)

* added docs for new global variable.

* reverting the name + email so we only expose the bare minumum that should be enough for most cases.
This commit is contained in:
Marcus Andersson 2020-06-02 12:05:05 +02:00 committed by GitHub
parent 1d9f47b6a6
commit add1bcb59c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 6 additions and 6 deletions

View File

@ -52,6 +52,12 @@ This variable is only available in the Singlestat panel and can be used in the p
This variable is the ID of the current organization. This variable is the ID of the current organization.
`${__org.name}` is the name of the current organization. `${__org.name}` is the name of the current organization.
## $__user
> Only available in Grafana v7.1+
`${__user.id}` is the ID of the current user.
`${__user.login}` is the login handle of the current user.
## $__range ## $__range
> Only available in Grafana v5.3+ > Only available in Grafana v5.3+

View File

@ -15,8 +15,6 @@ export class User {
timezone: string; timezone: string;
helpFlags1: number; helpFlags1: number;
lightTheme: boolean; lightTheme: boolean;
name?: string;
email?: string;
hasEditPermissionInFolders: boolean; hasEditPermissionInFolders: boolean;
constructor() { constructor() {

View File

@ -73,9 +73,7 @@ export class VariableSrv {
}); });
this.templateSrv.setGlobalVariable('__user', { this.templateSrv.setGlobalVariable('__user', {
value: { value: {
name: contextSrv.user.name,
login: contextSrv.user.login, login: contextSrv.user.login,
email: contextSrv.user.email,
id: contextSrv.user.id, id: contextSrv.user.id,
toString: function() { toString: function() {
return this.id; return this.id;

View File

@ -104,9 +104,7 @@ export const completeDashboardTemplating = (dashboard: DashboardModel): ThunkRes
}); });
templateSrv.setGlobalVariable('__user', { templateSrv.setGlobalVariable('__user', {
value: { value: {
name: contextSrv.user.name,
login: contextSrv.user.login, login: contextSrv.user.login,
email: contextSrv.user.email,
id: contextSrv.user.id, id: contextSrv.user.id,
toString: function() { toString: function() {
return this.id; return this.id;