/grafana-organization | Type: Application | PCID required: Yes
Tools
grafana_organization_add_org_invite
Add invite. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
loginOrEmail | string | No | — | Login Or Email |
name | string | No | — | The name value |
role | string | No | — | The role value |
sendEmail | boolean | No | — | Send Email |
grafana_organization_add_org_user_to_current_org
Add a new user to the current organization. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
loginOrEmail | string | No | — | Login Or Email |
role | string | No | — | The role value |
grafana_organization_add_team_member
Add Team Member. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | string | Yes | — | Team Id |
userId | integer | Yes | — | User Id |
grafana_organization_create_service_account
Create service account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
isDisabled | boolean | No | — | Is Disabled |
name | string | No | — | The name value |
role | string | No | — | The role value |
grafana_organization_create_team
Add Team. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | The email value |
name | string | Yes | — | The name value |
grafana_organization_create_token
CreateNewToken adds a token to a service account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAccountId | integer | Yes | — | Service Account Id |
name | string | No | — | The name value |
secondsToLive | integer | No | — | Seconds To Live |
grafana_organization_delete_service_account
Delete service account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAccountId | integer | Yes | — | Service Account Id |
grafana_organization_delete_team_by_id
Delete Team By ID. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | string | Yes | — | Team Id |
grafana_organization_delete_token
DeleteToken deletes service account tokens Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tokenId | integer | Yes | — | Token Id |
serviceAccountId | integer | Yes | — | Service 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | No | — | Search query string |
limit | integer | No | — | Maximum number of results to return |
grafana_organization_get_org_users_for_current_org_lookup
Get all users within the current organization (lookup) Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | No | — | Search query string |
limit | integer | No | — | Maximum 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | string | Yes | — | Team Id |
accesscontrol | boolean | No | — | The accesscontrol value |
grafana_organization_get_team_members
Get Team Members. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | string | Yes | — | Team Id |
grafana_organization_get_team_preferences
Get Team Preferences. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | string | Yes | — | Team Id |
grafana_organization_get_user_by_id
Get user by id. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | integer | Yes | — | User Id |
grafana_organization_get_user_by_login_or_email
Get user by login or email. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
loginOrEmail | string | Yes | — | loginOrEmail of the user |
grafana_organization_get_user_org_list
Get organizations for user. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | integer | Yes | — | User Id |
grafana_organization_get_user_teams
Get teams for user. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | integer | Yes | — | User Id |
grafana_organization_list_tokens
Get service account tokens Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAccountId | integer | Yes | — | Service Account Id |
grafana_organization_patch_org_preferences
Patch Current Org Prefs. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
homeDashboardId | integer | No | — | The numerical :id of a favorited dashboard |
homeDashboardUID | string | No | — | Home Dashboard UID |
language | string | No | — | The language value |
navbar | object | No | — | The navbar value |
queryHistory | object | No | — | Query History |
regionalFormat | string | No | — | Regional Format |
theme | string | No | — | The theme value |
timezone | string | No | — | Any IANA timezone string (e.g. America/New_York), ‘utc’, ‘browser’, or empty string |
weekStart | string | No | — | Week Start |
grafana_organization_remove_org_user_for_current_org
Delete user in current organization. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | integer | Yes | — | User Id |
grafana_organization_remove_team_member
Remove Member From Team. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | string | Yes | — | Team Id |
user_id | integer | Yes | — | User Id |
grafana_organization_retrieve_service_account
Get single serviceaccount by Id Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAccountId | integer | Yes | — | Service Account Id |
grafana_organization_revoke_invite
Revoke invite. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
invitation_code | string | Yes | — | Invitation Code |
grafana_organization_search_org_service_accounts_with_paging
Search service accounts with paging Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Disabled | boolean | No | — | The disabled value |
expiredTokens | boolean | No | — | Expired Tokens |
query | string | No | — | It will return results where the query value is contained in one of the name. Query values with spaces need to be URL encoded. |
perpage | integer | No | — | The default value is 1000. |
page | integer | No | — | The default value is 1. |
grafana_organization_search_teams
Team Search With Paging. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number for pagination |
perpage | integer | No | — | Number 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. |
name | string | No | — | The name value |
query | string | No | — | 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. |
accesscontrol | boolean | No | — | The accesscontrol value |
sort | string | No | — | Sort order for results |
grafana_organization_search_users
Get users. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
perpage | integer | No | — | Limit the maximum number of users to return per page |
page | integer | No | — | Page index for starting fetching users |
grafana_organization_search_users_with_paging
Get users with paging. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
perpage | integer | No | — | Limit the maximum number of users to return per page |
page | integer | No | — | Page index for starting fetching users |
query | string | No | — | Filter users by login, email, name, or last seen before a certain date |
sort | string | No | — | Order results by login, email or name fields. “login”, “-login”, “email”, “-email”, “name”, “-name”. |
grafana_organization_set_team_memberships
Set team memberships. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | string | Yes | — | Team Id |
admins | string[] | No | — | The admins value |
members | string[] | No | — | The members value |
grafana_organization_update_current_org
Update current Organization. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | No | — | The name value |
grafana_organization_update_current_org_address
Update current Organization’s address. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address1 | string | No | — | The address1 value |
address2 | string | No | — | The address2 value |
city | string | No | — | The city value |
country | string | No | — | The country value |
state | string | No | — | The state value |
zipcode | string | No | — | The zipcode value |
grafana_organization_update_org_preferences
Update Current Org Prefs. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
homeDashboardId | integer | No | — | The numerical :id of a favorited dashboard |
homeDashboardUID | string | No | — | Home Dashboard UID |
language | string | No | — | The language value |
navbar | object | No | — | The navbar value |
queryHistory | object | No | — | Query History |
regionalFormat | string | No | — | Regional Format |
theme | string | No | — | The theme value |
timezone | string | No | — | Any IANA timezone string (e.g. America/New_York), ‘utc’, ‘browser’, or empty string |
weekStart | string | No | — | Week Start |
grafana_organization_update_org_user_for_current_org
Updates the given user. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | integer | Yes | — | User Id |
role | string | No | — | The role value |
grafana_organization_update_service_account
Update service account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceAccountId | integer | Yes | — | Service Account Id |
isDisabled | boolean | No | — | Is Disabled |
name | string | No | — | The name value |
role | string | No | — | The role value |
grafana_organization_update_team
Update Team. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | string | Yes | — | Team Id |
email | string | No | — | The email value |
name | string | No | — | The name value |
grafana_organization_update_team_member
Update Team Member. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | string | Yes | — | Team Id |
user_id | integer | Yes | — | User Id |
permission | integer | No | — | The permission value |
grafana_organization_update_team_preferences
Update Team Preferences. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
team_id | string | Yes | — | Team Id |
homeDashboardId | integer | No | — | The numerical :id of a favorited dashboard |
homeDashboardUID | string | No | — | Home Dashboard UID |
language | string | No | — | The language value |
navbar | object | No | — | The navbar value |
queryHistory | object | No | — | Query History |
regionalFormat | string | No | — | Regional Format |
theme | string | No | — | The theme value |
timezone | string | No | — | Any IANA timezone string (e.g. America/New_York), ‘utc’, ‘browser’, or empty string |
weekStart | string | No | — | Week Start |
grafana_organization_update_user
Update user. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | integer | Yes | — | User Id |
email | string | No | — | The email value |
login | string | No | — | The login value |
name | string | No | — | The name value |
theme | string | No | — | The theme value |

