mirror of
https://github.com/thousandeyes/thousandeyes-sdk-python.git
synced 2025-12-06 06:26:51 +00:00
95 lines
3.7 KiB
Python
95 lines
3.7 KiB
Python
# coding: utf-8
|
|
|
|
"""
|
|
Administrative API
|
|
|
|
## Overview Manage users, accounts, and account groups in the ThousandEyes platform using the Administrative API. This API provides the following endpoints that define the operations to manage your organization: * `/account-groups`: Account groups are used to divide an organization into different sections. These endpoints can be used to create, retrieve, update and delete account groups. * `/users`: Create, retrieve, update and delete users within an organization. * `/roles`: Create, retrieve and update roles for the current user. * `/permissions`: Retrieve all assignable permissions. Used in the context of modifying roles. * `/audit-user-events`: Retrieve all activity log events.
|
|
|
|
The version of the OpenAPI document: 7.0.0
|
|
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
|
|
Do not edit the class manually.
|
|
""" # noqa: E501
|
|
|
|
|
|
from __future__ import annotations
|
|
import pprint
|
|
import re # noqa: F401
|
|
import json
|
|
|
|
|
|
from typing import Any, ClassVar, Dict, List, Optional
|
|
from pydantic import BaseModel, StrictBool, StrictStr
|
|
from pydantic import Field
|
|
try:
|
|
from typing import Self
|
|
except ImportError:
|
|
from typing_extensions import Self
|
|
|
|
class Role(BaseModel):
|
|
"""
|
|
Role
|
|
""" # noqa: E501
|
|
name: Optional[StrictStr] = Field(default=None, description="Name of the role.")
|
|
role_id: Optional[StrictStr] = Field(default=None, description="Unique ID representing the role.", alias="roleId")
|
|
is_builtin: Optional[StrictBool] = Field(default=None, description="Flag indicating if the role is built-in (Account Admin, Organization Admin, Regular User).", alias="isBuiltin")
|
|
has_management_permissions: Optional[StrictBool] = Field(default=None, description="Flag indicating whether the user has management permissions.", alias="hasManagementPermissions")
|
|
__properties: ClassVar[List[str]] = ["name", "roleId", "isBuiltin", "hasManagementPermissions"]
|
|
|
|
model_config = {
|
|
"populate_by_name": True,
|
|
"validate_assignment": True
|
|
}
|
|
|
|
|
|
def to_str(self) -> str:
|
|
"""Returns the string representation of the model using alias"""
|
|
return pprint.pformat(self.model_dump(by_alias=True))
|
|
|
|
def to_json(self) -> str:
|
|
"""Returns the JSON representation of the model using alias"""
|
|
# TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
|
|
return json.dumps(self.to_dict())
|
|
|
|
@classmethod
|
|
def from_json(cls, json_str: str) -> Self:
|
|
"""Create an instance of Role from a JSON string"""
|
|
return cls.from_dict(json.loads(json_str))
|
|
|
|
def to_dict(self) -> Dict[str, Any]:
|
|
"""Return the dictionary representation of the model using alias.
|
|
|
|
This has the following differences from calling pydantic's
|
|
`self.model_dump(by_alias=True)`:
|
|
|
|
* `None` is only added to the output dict for nullable fields that
|
|
were set at model initialization. Other fields with value `None`
|
|
are ignored.
|
|
"""
|
|
_dict = self.model_dump(
|
|
by_alias=True,
|
|
exclude={
|
|
},
|
|
exclude_none=True,
|
|
)
|
|
return _dict
|
|
|
|
@classmethod
|
|
def from_dict(cls, obj: Dict) -> Self:
|
|
"""Create an instance of Role from a dict"""
|
|
if obj is None:
|
|
return None
|
|
|
|
if not isinstance(obj, dict):
|
|
return cls.model_validate(obj)
|
|
|
|
_obj = cls.model_validate({
|
|
"name": obj.get("name"),
|
|
"roleId": obj.get("roleId"),
|
|
"isBuiltin": obj.get("isBuiltin"),
|
|
"hasManagementPermissions": obj.get("hasManagementPermissions")
|
|
})
|
|
return _obj
|
|
|
|
|