"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":"global",
"in":"query"
},
{
"type":"integer",
"format":"int64",
"x-go-name":"UserID",
"name":"user_id",
"in":"path",
"required":true
}
],
"responses":{
@ -1025,7 +1025,7 @@
"basic":[]
}
],
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:delete` and scope `global:users:*`.",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:delete` and scope `global.users:*`.",
"tags":["admin_users"],
"summary":"Delete global User.",
"operationId":"deleteUser",
@ -1065,7 +1065,7 @@
"basic":[]
}
],
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:list` and scope `global:users:*`.",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:list` and scope `global.users:*`.",
"tags":["admin_users"],
"summary":"Return a list of all auth tokens (devices) that the user currently have logged in from.",
"operationId":"getAuthTokens",
@ -1102,7 +1102,7 @@
"basic":[]
}
],
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:disable` and scope `global:users:1` (userIDScope).",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:disable` and scope `global.users:1` (userIDScope).",
"tags":["admin_users"],
"summary":"Disable user.",
"operationId":"disableUser",
@ -1142,7 +1142,7 @@
"basic":[]
}
],
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:enable` and scope `global:users:1` (userIDScope).",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:enable` and scope `global.users:1` (userIDScope).",
"tags":["admin_users"],
"summary":"Enable user.",
"operationId":"enableUser",
@ -1182,7 +1182,7 @@
"basic":[]
}
],
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.logout` and scope `global:users:*`.",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.logout` and scope `global.users:*`.",
"tags":["admin_users"],
"summary":"Logout user revokes all auth tokens (devices) for the user. User of issued auth tokens (devices) will no longer be logged in and will be required to authenticate again upon next activity.",
"operationId":"logoutUser",
@ -1225,7 +1225,7 @@
"basic":[]
}
],
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.password:update` and scope `global:users:*`.",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.password:update` and scope `global.users:*`.",
"tags":["admin_users"],
"summary":"Set password for user.",
"operationId":"setPassword",
@ -1269,7 +1269,7 @@
},
"/admin/users/{user_id}/permissions":{
"put":{
"description":"Only works with Basic Authentication (username and password). See introduction for an explanation.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.permissions:update` and scope `global:users:*`.",
"description":"Only works with Basic Authentication (username and password). See introduction for an explanation.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.permissions:update` and scope `global.users:*`.",
"tags":["admin_users"],
"summary":"Set permissions for user.",
"operationId":"setPermissions",
@ -1318,7 +1318,7 @@
"basic":[]
}
],
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:list` and scope `global:users:1` (userIDScope).",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:list` and scope `global.users:1` (userIDScope).",
"tags":["admin_users"],
"summary":"Fetch user quota.",
"operationId":"getUserQuota",
@ -1358,7 +1358,7 @@
"basic":[]
}
],
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:update` and scope `global:users:1` (userIDScope).",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:update` and scope `global.users:1` (userIDScope).",
"tags":["admin_users"],
"summary":"Update user quota.",
"operationId":"updateUserQuota",
@ -1414,7 +1414,7 @@
"basic":[]
}
],
"description":"Revokes the given auth token (device) for the user. User of issued auth token (device) will no longer be logged in and will be required to authenticate again upon next activity.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:update` and scope `global:users:*`.",
"description":"Revokes the given auth token (device) for the user. User of issued auth token (device) will no longer be logged in and will be required to authenticate again upon next activity.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:update` and scope `global.users:*`.",
"description":"Proxies all calls to the actual data source.",
@ -4273,7 +4404,7 @@
},
"/datasources/{datasource_id}":{
"get":{
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:1` (single data source).",
"tags":["datasources"],
"summary":"Get a single data source by Id.",
"operationId":"getDatasourceByID",
@ -4308,7 +4439,7 @@
}
},
"put":{
"description":"Similar to creating a data source, `password` and `basicAuthPassword` should be defined under\nsecureJsonData in order to be stored securely as an encrypted blob in the database. Then, the\nencrypted fields are listed under secureJsonFields section in the response.\n\nIf you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:write` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).",
"description":"Similar to creating a data source, `password` and `basicAuthPassword` should be defined under\nsecureJsonData in order to be stored securely as an encrypted blob in the database. Then, the\nencrypted fields are listed under secureJsonFields section in the response.\n\nIf you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:write` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:1` (single data source).",
"tags":["datasources"],
"summary":"Update an existing data source.",
"operationId":"updateDatasource",
@ -4345,7 +4476,7 @@
}
},
"delete":{
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:delete` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:delete` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:1` (single data source).",
"tags":["datasources"],
"summary":"Delete an existing data source by id.",
"description":"SigV4Config is the configuration for signing remote write requests with\nAWS's SigV4 verification process. Empty values will be retrieved using the\nAWS default credentials chain.",
"description":"The general form represented is:\n\n[scheme:][//[userinfo@]host][/]path[?query][#fragment]\n\nURLs that do not start with a slash after the scheme are interpreted as:\n\nscheme:opaque[?query][#fragment]\n\nNote that the Path field is stored in decoded form: /%47%6f%2f becomes /Go/.\nA consequence is that it is impossible to tell which slashes in the Path were\nslashes in the raw URL and which were %2f. This distinction is rarely important,\nbut when it is, the code should use RawPath, an optional field which only gets\nset if the default encoding is different from Path.\n\nURL's String method uses the EscapedPath method to obtain the path. See the\nEscapedPath method for more details.",
"type":"object",
"title":"A URL represents a parsed URL (technically, a URI reference).",
"title":"URL is a custom URL type that allows validation at configuration load time.",
"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":"global",
"in":"query"
},
{
"type":"integer",
"format":"int64",
"x-go-name":"UserID",
"name":"user_id",
"in":"path",
"required":true
}
],
"responses":{
@ -1025,7 +1025,7 @@
"basic":[]
}
],
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:delete` and scope `global:users:*`.",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:delete` and scope `global.users:*`.",
"tags":["admin_users"],
"summary":"Delete global User.",
"operationId":"deleteUser",
@ -1065,7 +1065,7 @@
"basic":[]
}
],
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:list` and scope `global:users:*`.",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:list` and scope `global.users:*`.",
"tags":["admin_users"],
"summary":"Return a list of all auth tokens (devices) that the user currently have logged in from.",
"operationId":"getAuthTokens",
@ -1102,7 +1102,7 @@
"basic":[]
}
],
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:disable` and scope `global:users:1` (userIDScope).",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:disable` and scope `global.users:1` (userIDScope).",
"tags":["admin_users"],
"summary":"Disable user.",
"operationId":"disableUser",
@ -1142,7 +1142,7 @@
"basic":[]
}
],
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:enable` and scope `global:users:1` (userIDScope).",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users:enable` and scope `global.users:1` (userIDScope).",
"tags":["admin_users"],
"summary":"Enable user.",
"operationId":"enableUser",
@ -1182,7 +1182,7 @@
"basic":[]
}
],
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.logout` and scope `global:users:*`.",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.logout` and scope `global.users:*`.",
"tags":["admin_users"],
"summary":"Logout user revokes all auth tokens (devices) for the user. User of issued auth tokens (devices) will no longer be logged in and will be required to authenticate again upon next activity.",
"operationId":"logoutUser",
@ -1225,7 +1225,7 @@
"basic":[]
}
],
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.password:update` and scope `global:users:*`.",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.password:update` and scope `global.users:*`.",
"tags":["admin_users"],
"summary":"Set password for user.",
"operationId":"setPassword",
@ -1269,7 +1269,7 @@
},
"/admin/users/{user_id}/permissions":{
"put":{
"description":"Only works with Basic Authentication (username and password). See introduction for an explanation.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.permissions:update` and scope `global:users:*`.",
"description":"Only works with Basic Authentication (username and password). See introduction for an explanation.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.permissions:update` and scope `global.users:*`.",
"tags":["admin_users"],
"summary":"Set permissions for user.",
"operationId":"setPermissions",
@ -1318,7 +1318,7 @@
"basic":[]
}
],
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:list` and scope `global:users:1` (userIDScope).",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:list` and scope `global.users:1` (userIDScope).",
"tags":["admin_users"],
"summary":"Fetch user quota.",
"operationId":"getUserQuota",
@ -1358,7 +1358,7 @@
"basic":[]
}
],
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:update` and scope `global:users:1` (userIDScope).",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.quotas:update` and scope `global.users:1` (userIDScope).",
"tags":["admin_users"],
"summary":"Update user quota.",
"operationId":"updateUserQuota",
@ -1414,7 +1414,7 @@
"basic":[]
}
],
"description":"Revokes the given auth token (device) for the user. User of issued auth token (device) will no longer be logged in and will be required to authenticate again upon next activity.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:update` and scope `global:users:*`.",
"description":"Revokes the given auth token (device) for the user. User of issued auth token (device) will no longer be logged in and will be required to authenticate again upon next activity.\nIf you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `users.authtoken:update` and scope `global.users:*`.",
"description":"Proxies all calls to the actual data source.",
@ -3323,7 +3454,7 @@
},
"/datasources/{datasource_id}":{
"get":{
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:read` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:1` (single data source).",
"tags":["datasources"],
"summary":"Get a single data source by Id.",
"operationId":"getDatasourceByID",
@ -3358,7 +3489,7 @@
}
},
"put":{
"description":"Similar to creating a data source, `password` and `basicAuthPassword` should be defined under\nsecureJsonData in order to be stored securely as an encrypted blob in the database. Then, the\nencrypted fields are listed under secureJsonFields section in the response.\n\nIf you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:write` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).",
"description":"Similar to creating a data source, `password` and `basicAuthPassword` should be defined under\nsecureJsonData in order to be stored securely as an encrypted blob in the database. Then, the\nencrypted fields are listed under secureJsonFields section in the response.\n\nIf you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:write` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:1` (single data source).",
"tags":["datasources"],
"summary":"Update an existing data source.",
"operationId":"updateDatasource",
@ -3395,7 +3526,7 @@
}
},
"delete":{
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:delete` and scopes: `datasources:*`, `datasources:id:*` and `datasources:id:1` (single data source).",
"description":"If you are running Grafana Enterprise and have Fine-grained access control enabled\nyou need to have a permission with action: `datasources:delete` and scopes: `datasources:*`, `datasources:uid:*` and `datasources:uid:1` (single data source).",
"tags":["datasources"],
"summary":"Delete an existing data source by id.",