Skip to content

Table of Contents

sso_settings

SSOSettings Objects

class SSOSettings()

The class includes all necessary methods to access the Grafana sso settings API endpoints

Arguments:

  • grafana_api_model APIModel - Inject a Grafana API model object that includes all necessary values and information

Attributes:

  • grafana_api_model APIModel - This is where we store the grafana_api_model

get_sso_settings

def get_sso_settings() -> list

The method includes a functionality to get the SSO settings for all providers

Required Permissions: Action: settings:read Scope: settings:auth.{provider}:*

Raises:

  • Exception - Unspecified error by executing the API call

Returns:

  • api_call list - Returns the all SSO settings

get_sso_settings_by_provider

def get_sso_settings_by_provider(provider: str) -> dict

The method includes a functionality to get the SSO settings for the specified provider

Arguments:

  • provider str - Specify the provider

Required Permissions: - Action - settings:read - Scope - settings:auth.{provider}:*

Raises:

  • ValueError - Missed specifying a necessary value
  • Exception - Unspecified error by executing the API call

Returns:

  • api_call dict - Returns the corresponding provider SSO settings

update_sso_settings

def update_sso_settings(provider: str, sso_setting: SSOSetting)

The method includes a functionality to update the SSO settings specified by the provider

Arguments:

  • provider str - Specify the provider
  • sso_setting SSOSetting - Specify the SSO setting

Required Permissions: - Action - settings:write - Scope - settings:auth.{provider}:*

Raises:

  • ValueError - Missed specifying a necessary value
  • Exception - Unspecified error by executing the API call

Returns:

None

delete_sso_settings

def delete_sso_settings(provider: str)

The method includes a functionality to delete the SSO settings specified by the provider

Arguments:

  • provider str - Specify the provider

Required Permissions: - Action - settings:write - Scope - settings:auth.{provider}:*

Raises:

  • ValueError - Missed specifying a necessary value
  • Exception - Unspecified error by executing the API call

Returns:

None