Skip to content

Token manager

TokenManager

Bases: BaseModel

create_service_account 

create_service_account()

Create a new service account.

:param name: Desired name for the service account :param role: Role for the service account ('Viewer', 'Editor', or 'Admin') :return: Dictionary containing service account details or None if creation failed

Source code in src/zenbt/grafana/token_manager.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
def create_service_account(self):
    """
    Create a new service account.

    :param name: Desired name for the service account
    :param role: Role for the service account ('Viewer', 'Editor', or 'Admin')
    :return: Dictionary containing service account details or None if creation failed
    """
    payload = {"name": self.service_account_name, "role": "Admin"}
    response = requests.post(
        f"{self.grafana_url}/api/serviceaccounts",
        headers=self.headers,
        auth=self.auth,
        data=json.dumps(payload),
    )
    if response.status_code == 201:
        return response.json()
    else:
        print(
            f"Failed to create service account. Status code: {response.status_code}, Response: {response.text}"
        )
        return None

delete_service_account 

delete_service_account(service_account_id)

Delete an existing service account by its ID.

:param service_account_id: ID of the service account to be deleted :return: True if deletion was successful, False otherwise

Source code in src/zenbt/grafana/token_manager.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
def delete_service_account(self, service_account_id):
    """
    Delete an existing service account by its ID.

    :param service_account_id: ID of the service account to be deleted
    :return: True if deletion was successful, False otherwise
    """
    response = requests.delete(
        f"{self.grafana_url}/api/serviceaccounts/{service_account_id}",
        headers=self.headers,
        auth=self.auth,
    )
    if response.status_code == 200:
        print(f"Service Account with ID {service_account_id} deleted successfully.")
        return True
    else:
        print(
            f"Failed to delete service account. Status code: {response.status_code}, Response: {response.text}"
        )
        return False

delete_service_account_by_name 

delete_service_account_by_name()

Delete a service account by its name.

:param name: Name of the service account to be deleted :return: True if deletion was successful, False otherwise

Source code in src/zenbt/grafana/token_manager.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
def delete_service_account_by_name(self):
    """
    Delete a service account by its name.

    :param name: Name of the service account to be deleted
    :return: True if deletion was successful, False otherwise
    """
    service_account_id = self.get_service_account_id_by_name()
    if service_account_id is None:
        return False

    response = requests.delete(
        f"{self.grafana_url}/api/serviceaccounts/{service_account_id}",
        headers=self.headers,
        auth=self.auth,
    )
    if response.status_code == 200:
        print(
            f"Service account '{self.service_account_name}' deleted successfully."
        )
        return True
    else:
        print(
            f"Failed to delete service account '{self.service_account_name}'. Status code: {response.status_code}, Response: {response.text}"
        )
        return False

generate_service_account_token 

generate_service_account_token(
    service_account_id, token_name
)

Generate a token for an existing service account.

:param service_account_id: ID of the service account :param token_name: Desired name for the token :return: Dictionary containing token details or None if generation failed

Source code in src/zenbt/grafana/token_manager.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
def generate_service_account_token(self, service_account_id, token_name):
    """
    Generate a token for an existing service account.

    :param service_account_id: ID of the service account
    :param token_name: Desired name for the token
    :return: Dictionary containing token details or None if generation failed
    """
    payload = {"name": token_name}
    response = requests.post(
        f"{self.grafana_url}/api/serviceaccounts/{service_account_id}/tokens",
        headers=self.headers,
        auth=self.auth,
        data=json.dumps(payload),
    )
    if response.status_code == 200:
        return response.json()
    else:
        print(
            f"Failed to create service account token. Status code: {response.status_code}, Response: {response.text}"
        )
        return None

get_service_account_id_by_name 

get_service_account_id_by_name()

Retrieve the ID of a service account by its name.

:param name: Name of the service account :return: Service account ID if found, None otherwise

Source code in src/zenbt/grafana/token_manager.py 
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def get_service_account_id_by_name(self):
    """
    Retrieve the ID of a service account by its name.

    :param name: Name of the service account
    :return: Service account ID if found, None otherwise
    """
    response = requests.get(
        f"{self.grafana_url}/api/serviceaccounts/search",
        headers=self.headers,
        auth=self.auth,
        params={"query": self.service_account_name},
    )
    if response.status_code == 200:
        accounts = response.json().get("serviceAccounts", [])
        for account in accounts:
            if account["name"] == self.service_account_name:
                return account["id"]
        print(f"Service account with name '{self.service_account_name}' not found.")
        return None
    else:
        print(
            f"Failed to retrieve service accounts. Status code: {response.status_code}, Response: {response.text}"
        )
        return None