Skip to main content
Server path: /grafana-organization | Type: Application | PCID required: Yes

Tools

ToolDescription
grafana_organization_add_org_inviteAdd invite.
grafana_organization_add_org_user_to_current_orgAdd a new user to the current organization.
grafana_organization_add_team_memberAdd Team Member.
grafana_organization_create_service_accountCreate service account
grafana_organization_create_teamAdd Team.
grafana_organization_create_tokenCreateNewToken adds a token to a service account
grafana_organization_delete_service_accountDelete service account
grafana_organization_delete_team_by_idDelete Team By ID.
grafana_organization_delete_tokenDeleteToken deletes service account tokens
grafana_organization_get_current_orgGet current Organization.
grafana_organization_get_current_org_quotaFetch Organization quota.
grafana_organization_get_org_preferencesGet Current Org Prefs.
grafana_organization_get_org_users_for_current_orgGet all users within the current organization.
grafana_organization_get_org_users_for_current_org_lookupGet all users within the current organization (lookup)
grafana_organization_get_pending_org_invitesGet pending invites.
grafana_organization_get_team_by_idGet Team By ID.
grafana_organization_get_team_membersGet Team Members.
grafana_organization_get_team_preferencesGet Team Preferences.
grafana_organization_get_user_by_idGet user by id.
grafana_organization_get_user_by_login_or_emailGet user by login or email.
grafana_organization_get_user_org_listGet organizations for user.
grafana_organization_get_user_teamsGet teams for user.
grafana_organization_list_tokensGet service account tokens
grafana_organization_patch_org_preferencesPatch Current Org Prefs.
grafana_organization_remove_org_user_for_current_orgDelete user in current organization.
grafana_organization_remove_team_memberRemove Member From Team.
grafana_organization_retrieve_service_accountGet single serviceaccount by Id
grafana_organization_revoke_inviteRevoke invite.
grafana_organization_search_org_service_accounts_with_pagingSearch service accounts with paging
grafana_organization_search_teamsTeam Search With Paging.
grafana_organization_search_usersGet users.
grafana_organization_search_users_with_pagingGet users with paging.
grafana_organization_set_team_membershipsSet team memberships.
grafana_organization_update_current_orgUpdate current Organization.
grafana_organization_update_current_org_addressUpdate current Organization’s address.
grafana_organization_update_org_preferencesUpdate Current Org Prefs.
grafana_organization_update_org_user_for_current_orgUpdates the given user.
grafana_organization_update_service_accountUpdate service account
grafana_organization_update_teamUpdate Team.
grafana_organization_update_team_memberUpdate Team Member.
grafana_organization_update_team_preferencesUpdate Team Preferences.
grafana_organization_update_userUpdate user.

grafana_organization_add_org_invite

Add invite. Parameters:
ParameterTypeRequiredDefaultDescription
loginOrEmailstringNoLogin Or Email
namestringNoThe name value
rolestringNoThe role value
sendEmailbooleanNoSend Email

grafana_organization_add_org_user_to_current_org

Add a new user to the current organization. Parameters:
ParameterTypeRequiredDefaultDescription
loginOrEmailstringNoLogin Or Email
rolestringNoThe role value

grafana_organization_add_team_member

Add Team Member. Parameters:
ParameterTypeRequiredDefaultDescription
team_idstringYesTeam Id
userIdintegerYesUser Id

grafana_organization_create_service_account

Create service account Parameters:
ParameterTypeRequiredDefaultDescription
isDisabledbooleanNoIs Disabled
namestringNoThe name value
rolestringNoThe role value

grafana_organization_create_team

Add Team. Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoThe email value
namestringYesThe name value

grafana_organization_create_token

CreateNewToken adds a token to a service account Parameters:
ParameterTypeRequiredDefaultDescription
serviceAccountIdintegerYesService Account Id
namestringNoThe name value
secondsToLiveintegerNoSeconds To Live

grafana_organization_delete_service_account

Delete service account Parameters:
ParameterTypeRequiredDefaultDescription
serviceAccountIdintegerYesService Account Id

grafana_organization_delete_team_by_id

Delete Team By ID. Parameters:
ParameterTypeRequiredDefaultDescription
team_idstringYesTeam Id

grafana_organization_delete_token

DeleteToken deletes service account tokens Parameters:
ParameterTypeRequiredDefaultDescription
tokenIdintegerYesToken Id
serviceAccountIdintegerYesService Account Id

grafana_organization_get_current_org

Get current Organization.

grafana_organization_get_current_org_quota

Fetch Organization quota.

grafana_organization_get_org_preferences

Get Current Org Prefs.

grafana_organization_get_org_users_for_current_org

Get all users within the current organization. Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoSearch query string
limitintegerNoMaximum number of results to return

grafana_organization_get_org_users_for_current_org_lookup

Get all users within the current organization (lookup) Parameters:
ParameterTypeRequiredDefaultDescription
querystringNoSearch query string
limitintegerNoMaximum number of results to return

grafana_organization_get_pending_org_invites

Get pending invites.

grafana_organization_get_team_by_id

Get Team By ID. Parameters:
ParameterTypeRequiredDefaultDescription
team_idstringYesTeam Id
accesscontrolbooleanNoThe accesscontrol value

grafana_organization_get_team_members

Get Team Members. Parameters:
ParameterTypeRequiredDefaultDescription
team_idstringYesTeam Id

grafana_organization_get_team_preferences

Get Team Preferences. Parameters:
ParameterTypeRequiredDefaultDescription
team_idstringYesTeam Id

grafana_organization_get_user_by_id

Get user by id. Parameters:
ParameterTypeRequiredDefaultDescription
user_idintegerYesUser Id

grafana_organization_get_user_by_login_or_email

Get user by login or email. Parameters:
ParameterTypeRequiredDefaultDescription
loginOrEmailstringYesloginOrEmail of the user

grafana_organization_get_user_org_list

Get organizations for user. Parameters:
ParameterTypeRequiredDefaultDescription
user_idintegerYesUser Id

grafana_organization_get_user_teams

Get teams for user. Parameters:
ParameterTypeRequiredDefaultDescription
user_idintegerYesUser Id

grafana_organization_list_tokens

Get service account tokens Parameters:
ParameterTypeRequiredDefaultDescription
serviceAccountIdintegerYesService Account Id

grafana_organization_patch_org_preferences

Patch Current Org Prefs. Parameters:
ParameterTypeRequiredDefaultDescription
homeDashboardIdintegerNoThe numerical :id of a favorited dashboard
homeDashboardUIDstringNoHome Dashboard UID
languagestringNoThe language value
navbarobjectNoThe navbar value
queryHistoryobjectNoQuery History
regionalFormatstringNoRegional Format
themestringNoThe theme value
timezonestringNoAny IANA timezone string (e.g. America/New_York), ‘utc’, ‘browser’, or empty string
weekStartstringNoWeek Start

grafana_organization_remove_org_user_for_current_org

Delete user in current organization. Parameters:
ParameterTypeRequiredDefaultDescription
user_idintegerYesUser Id

grafana_organization_remove_team_member

Remove Member From Team. Parameters:
ParameterTypeRequiredDefaultDescription
team_idstringYesTeam Id
user_idintegerYesUser Id

grafana_organization_retrieve_service_account

Get single serviceaccount by Id Parameters:
ParameterTypeRequiredDefaultDescription
serviceAccountIdintegerYesService Account Id

grafana_organization_revoke_invite

Revoke invite. Parameters:
ParameterTypeRequiredDefaultDescription
invitation_codestringYesInvitation Code

grafana_organization_search_org_service_accounts_with_paging

Search service accounts with paging Parameters:
ParameterTypeRequiredDefaultDescription
DisabledbooleanNoThe disabled value
expiredTokensbooleanNoExpired Tokens
querystringNoIt will return results where the query value is contained in one of the name. Query values with spaces need to be URL encoded.
perpageintegerNoThe default value is 1000.
pageintegerNoThe default value is 1.

grafana_organization_search_teams

Team Search With Paging. Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination
perpageintegerNoNumber of items per page The totalCount field in the response can be used for pagination list E.g. if totalCount is equal to 100 teams and the perpage parameter is set to 10 then there are 10 pages of teams.
namestringNoThe name value
querystringNoIf set it will return results where the query value is contained in the name field. Query values with spaces need to be URL encoded.
accesscontrolbooleanNoThe accesscontrol value
sortstringNoSort order for results

grafana_organization_search_users

Get users. Parameters:
ParameterTypeRequiredDefaultDescription
perpageintegerNoLimit the maximum number of users to return per page
pageintegerNoPage index for starting fetching users

grafana_organization_search_users_with_paging

Get users with paging. Parameters:
ParameterTypeRequiredDefaultDescription
perpageintegerNoLimit the maximum number of users to return per page
pageintegerNoPage index for starting fetching users
querystringNoFilter users by login, email, name, or last seen before a certain date
sortstringNoOrder results by login, email or name fields. “login”, “-login”, “email”, “-email”, “name”, “-name”.

grafana_organization_set_team_memberships

Set team memberships. Parameters:
ParameterTypeRequiredDefaultDescription
team_idstringYesTeam Id
adminsstring[]NoThe admins value
membersstring[]NoThe members value

grafana_organization_update_current_org

Update current Organization. Parameters:
ParameterTypeRequiredDefaultDescription
namestringNoThe name value

grafana_organization_update_current_org_address

Update current Organization’s address. Parameters:
ParameterTypeRequiredDefaultDescription
address1stringNoThe address1 value
address2stringNoThe address2 value
citystringNoThe city value
countrystringNoThe country value
statestringNoThe state value
zipcodestringNoThe zipcode value

grafana_organization_update_org_preferences

Update Current Org Prefs. Parameters:
ParameterTypeRequiredDefaultDescription
homeDashboardIdintegerNoThe numerical :id of a favorited dashboard
homeDashboardUIDstringNoHome Dashboard UID
languagestringNoThe language value
navbarobjectNoThe navbar value
queryHistoryobjectNoQuery History
regionalFormatstringNoRegional Format
themestringNoThe theme value
timezonestringNoAny IANA timezone string (e.g. America/New_York), ‘utc’, ‘browser’, or empty string
weekStartstringNoWeek Start

grafana_organization_update_org_user_for_current_org

Updates the given user. Parameters:
ParameterTypeRequiredDefaultDescription
user_idintegerYesUser Id
rolestringNoThe role value

grafana_organization_update_service_account

Update service account Parameters:
ParameterTypeRequiredDefaultDescription
serviceAccountIdintegerYesService Account Id
isDisabledbooleanNoIs Disabled
namestringNoThe name value
rolestringNoThe role value

grafana_organization_update_team

Update Team. Parameters:
ParameterTypeRequiredDefaultDescription
team_idstringYesTeam Id
emailstringNoThe email value
namestringNoThe name value

grafana_organization_update_team_member

Update Team Member. Parameters:
ParameterTypeRequiredDefaultDescription
team_idstringYesTeam Id
user_idintegerYesUser Id
permissionintegerNoThe permission value

grafana_organization_update_team_preferences

Update Team Preferences. Parameters:
ParameterTypeRequiredDefaultDescription
team_idstringYesTeam Id
homeDashboardIdintegerNoThe numerical :id of a favorited dashboard
homeDashboardUIDstringNoHome Dashboard UID
languagestringNoThe language value
navbarobjectNoThe navbar value
queryHistoryobjectNoQuery History
regionalFormatstringNoRegional Format
themestringNoThe theme value
timezonestringNoAny IANA timezone string (e.g. America/New_York), ‘utc’, ‘browser’, or empty string
weekStartstringNoWeek Start

grafana_organization_update_user

Update user. Parameters:
ParameterTypeRequiredDefaultDescription
user_idintegerYesUser Id
emailstringNoThe email value
loginstringNoThe login value
namestringNoThe name value
themestringNoThe theme value