gooddata-sdk 1.31.1.dev1__tar.gz → 1.31.1.dev2__tar.gz

{gooddata_sdk-1.31.1.dev1/gooddata_sdk.egg-info → gooddata_sdk-1.31.1.dev2}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: gooddata-sdk
-Version: 1.31.1.dev1
+Version: 1.31.1.dev2
 Summary: GoodData Cloud Python SDK
 Author: GoodData
 Author-email: support@gooddata.com
 License: MIT
-Project-URL: Documentation, https://www.gooddata.com/docs/python-sdk/1.31.1.dev1
+Project-URL: Documentation, https://www.gooddata.com/docs/python-sdk/1.31.1.dev2
 Project-URL: Source, https://github.com/gooddata/gooddata-python-sdk
 Keywords: gooddata,sdk,api,analytics,headless,business,intelligence,headless-bi,cloud,native,semantic,layer,sql,metrics
 Classifier: Development Status :: 5 - Production/Stable
@@ -22,7 +22,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.9.0
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: gooddata-api-client~=1.31.1.dev1
+Requires-Dist: gooddata-api-client~=1.31.1.dev2
 Requires-Dist: python-dateutil>=2.5.3
 Requires-Dist: pyyaml>=5.1
 Requires-Dist: attrs<=24.2.0,>=21.4.0
@@ -46,7 +46,7 @@ At the moment the SDK provides services to inspect and interact with the Semanti
 * Compute Service
 * Table Service
 
-See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.31.1.dev1) for more details.
+See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.31.1.dev2) for more details.
 
 ## Requirements
 

{gooddata_sdk-1.31.1.dev1 → gooddata_sdk-1.31.1.dev2}/README.md

@@ -13,7 +13,7 @@ At the moment the SDK provides services to inspect and interact with the Semanti
 * Compute Service
 * Table Service
 
-See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.31.1.dev1) for more details.
+See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.31.1.dev2) for more details.
 
 ## Requirements
 

{gooddata_sdk-1.31.1.dev1 → gooddata_sdk-1.31.1.dev2}/gooddata_sdk/__init__.py

@@ -55,6 +55,7 @@ from gooddata_sdk.catalog.depends_on import CatalogDependsOn, CatalogDependsOnDa
 from gooddata_sdk.catalog.entity import (
     AttrCatalogEntity,
     BasicCredentials,
+    ClientSecretCredentials,
     KeyPairCredentials,
     TokenCredentialsFromEnvVar,
     TokenCredentialsFromFile,

{gooddata_sdk-1.31.1.dev1 → gooddata_sdk-1.31.1.dev2}/gooddata_sdk/catalog/data_source/declarative_model/data_source.py

@@ -111,6 +111,8 @@ class CatalogDeclarativeDataSource(Base):
         token: Optional[str] = None,
         private_key: Optional[str] = None,
         private_key_passphrase: Optional[str] = None,
+        client_id: Optional[str] = None,
+        client_secret: Optional[str] = None,
     ) -> TestDefinitionRequest:
         kwargs: dict[str, Any] = {"schema": self.schema}
         if password is not None:
@@ -123,6 +125,10 @@ class CatalogDeclarativeDataSource(Base):
             kwargs["private_key"] = private_key
         if private_key_passphrase is not None:
             kwargs["private_key_passphrase"] = private_key
+        if client_id is not None:
+            kwargs["client_id"] = client_id
+        if client_secret is not None:
+            kwargs["client_secret"] = client_secret
         return TestDefinitionRequest(type=self.type, url=self.url, **kwargs)
 
     @staticmethod
@@ -141,6 +147,8 @@ class CatalogDeclarativeDataSource(Base):
         token: Optional[str] = None,
         private_key: Optional[str] = None,
         private_key_passphrase: Optional[str] = None,
+        client_id: Optional[str] = None,
+        client_secret: Optional[str] = None,
     ) -> DeclarativeDataSource:
         dictionary = self._get_snake_dict()
         if password is not None:
@@ -151,6 +159,10 @@ class CatalogDeclarativeDataSource(Base):
             dictionary["private_key"] = private_key
         if private_key_passphrase is not None:
             dictionary["private_key_passphrase"] = private_key_passphrase
+        if client_id is not None:
+            dictionary["client_id"] = client_id
+        if client_secret is not None:
+            dictionary["client_secret"] = client_secret
         return self.client_class().from_dict(dictionary)
 
     def store_to_disk(self, data_sources_folder: Path) -> None:

{gooddata_sdk-1.31.1.dev1 → gooddata_sdk-1.31.1.dev2}/gooddata_sdk/catalog/data_source/entity_model/data_source.py

@@ -16,6 +16,7 @@ from gooddata_api_client.model.json_api_data_source_patch_document import JsonAp
 from gooddata_sdk.catalog.base import Base, value_in_allowed
 from gooddata_sdk.catalog.entity import (
     BasicCredentials,
+    ClientSecretCredentials,
     Credentials,
     KeyPairCredentials,
     TokenCredentials,
@@ -34,6 +35,7 @@ def db_attrs_with_template(instance: CatalogDataSource, *args: Any) -> None:
 class CatalogDataSourceBase(Base):
     _SUPPORTED_CREDENTIALS: ClassVar[list[type[Credentials]]] = [
         BasicCredentials,
+        ClientSecretCredentials,
         TokenCredentials,
         TokenCredentialsFromFile,
         KeyPairCredentials,

{gooddata_sdk-1.31.1.dev1 → gooddata_sdk-1.31.1.dev2}/gooddata_sdk/catalog/entity.py

@@ -121,6 +121,8 @@ class Credentials(Base):
     PASSWORD_KEY: ClassVar[str] = "password"
     PRIVATE_KEY: ClassVar[str] = "private_key"
     PRIVATE_KEY_PASSPHRASE: ClassVar[str] = "private_key_passphrase"
+    CLIENT_ID: ClassVar[str] = "client_id"
+    CLIENT_SECRET: ClassVar[str] = "client_secret"
 
     def to_api_args(self) -> dict[str, Any]:
         return attr.asdict(self)
@@ -252,3 +254,23 @@ class KeyPairCredentials(Credentials):
             # You have to fill it to keep it or update it
             private_key="",
         )
+
+
+@attr.s(auto_attribs=True, kw_only=True)
+class ClientSecretCredentials(Credentials):
+    client_id: str
+    client_secret: str = attr.field(repr=lambda value: "***")
+
+    @classmethod
+    def is_part_of_api(cls, entity: dict[str, Any]) -> bool:
+        return cls.CLIENT_ID in entity and cls.CLIENT_SECRET in entity
+
+    @classmethod
+    def from_api(cls, attributes: dict[str, Any]) -> ClientSecretCredentials:
+        # Credentials are not returned for security reasons
+        return cls(
+            client_id=attributes[cls.CLIENT_ID],
+            # Client secret is not returned from API (security)
+            # You have to fill it to keep it or update it
+            client_secret="",
+        )

gooddata_sdk-1.31.1.dev2/gooddata_sdk/catalog/organization/entity_model/identity_provider.py

@@ -0,0 +1,88 @@
+# (C) 2024 GoodData Corporation
+from __future__ import annotations
+
+from typing import Any, Optional
+
+import attr
+from gooddata_api_client.model.json_api_identity_provider_in import JsonApiIdentityProviderIn
+from gooddata_api_client.model.json_api_identity_provider_in_attributes import JsonApiIdentityProviderInAttributes
+from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument
+
+from gooddata_sdk.catalog.base import Base
+from gooddata_sdk.utils import safeget
+
+
+@attr.s(auto_attribs=True, kw_only=True)
+class CatalogIdentityProviderDocument(Base):
+    data: CatalogIdentityProvider
+
+    @staticmethod
+    def client_class() -> type[JsonApiIdentityProviderInDocument]:
+        return JsonApiIdentityProviderInDocument
+
+
+@attr.s(auto_attribs=True, kw_only=True)
+class CatalogIdentityProvider(Base):
+    id: str
+    attributes: Optional[CatalogIdentityProviderAttributes] = None
+
+    @staticmethod
+    def client_class() -> type[JsonApiIdentityProviderIn]:
+        return JsonApiIdentityProviderIn
+
+    @classmethod
+    def init(
+        cls,
+        identity_provider_id: str,
+        custom_claim_mapping: Optional[dict[str, str]] = None,
+        identifiers: Optional[list[str]] = None,
+        oauth_client_id: Optional[str] = None,
+        oauth_client_secret: Optional[str] = None,
+        oauth_issuer_id: Optional[str] = None,
+        oauth_issuer_location: Optional[str] = None,
+        saml_metadata: Optional[str] = None,
+    ) -> CatalogIdentityProvider:
+        return cls(
+            id=identity_provider_id,
+            attributes=CatalogIdentityProviderAttributes(
+                custom_claim_mapping=custom_claim_mapping,
+                identifiers=identifiers,
+                oauth_client_id=oauth_client_id,
+                oauth_client_secret=oauth_client_secret,
+                oauth_issuer_id=oauth_issuer_id,
+                oauth_issuer_location=oauth_issuer_location,
+                saml_metadata=saml_metadata,
+            ),
+        )
+
+    @classmethod
+    def from_api(cls, entity: dict[str, Any]) -> CatalogIdentityProvider:
+        ea = entity["attributes"]
+        attr = CatalogIdentityProviderAttributes(
+            custom_claim_mapping=safeget(ea, ["custom_claim_mapping"]),
+            identifiers=safeget(ea, ["identifiers"]),
+            oauth_client_id=safeget(ea, ["oauth_client_id"]),
+            oauth_client_secret=safeget(ea, ["oauth_client_secret"]),
+            oauth_issuer_id=safeget(ea, ["oauth_issuer_id"]),
+            oauth_issuer_location=safeget(ea, ["oauth_issuer_location"]),
+            saml_metadata=safeget(ea, ["saml_metadata"]),
+        )
+        return cls(
+            id=entity["id"],
+            attributes=attr,
+        )
+
+
+@attr.s(auto_attribs=True, kw_only=True)
+class CatalogIdentityProviderAttributes(Base):
+    custom_claim_mapping: Optional[dict[str, str]] = None
+    identifiers: Optional[list[str]] = None
+    oauth_client_id: Optional[str] = None
+    oauth_client_secret: Optional[str] = None
+    oauth_issuer_id: Optional[str] = None
+    oauth_issuer_location: Optional[str] = None
+    saml_metadata: Optional[str] = None
+
+    @staticmethod
+    def client_class() -> type[JsonApiIdentityProviderInAttributes]:
+        return JsonApiIdentityProviderInAttributes

gooddata_sdk-1.31.1.dev2/gooddata_sdk/catalog/organization/layout/identity_provider.py

@@ -0,0 +1,24 @@
+# (C) 2024 GoodData Corporation
+import builtins
+from typing import Optional
+
+import attr
+from gooddata_api_client.model.declarative_identity_provider import DeclarativeIdentityProvider
+
+from gooddata_sdk.catalog.base import Base
+
+
+@attr.s(auto_attribs=True, kw_only=True)
+class CatalogDeclarativeIdentityProvider(Base):
+    id: str
+    custom_claim_mapping: Optional[dict[str, str]] = None
+    identifiers: Optional[list[str]] = None
+    oauth_client_id: Optional[str] = None
+    oauth_client_secret: Optional[str] = None
+    oauth_issuer_id: Optional[str] = None
+    oauth_issuer_location: Optional[str] = None
+    saml_metadata: Optional[str] = None
+
+    @staticmethod
+    def client_class() -> builtins.type[DeclarativeIdentityProvider]:
+        return DeclarativeIdentityProvider

{gooddata_sdk-1.31.1.dev1 → gooddata_sdk-1.31.1.dev2}/gooddata_sdk/catalog/organization/service.py

@@ -7,16 +7,19 @@ from typing import Optional
 from gooddata_api_client.exceptions import NotFoundException
 from gooddata_api_client.model.declarative_notification_channels import DeclarativeNotificationChannels
 from gooddata_api_client.model.json_api_csp_directive_in_document import JsonApiCspDirectiveInDocument
+from gooddata_api_client.model.json_api_identity_provider_in_document import JsonApiIdentityProviderInDocument
 from gooddata_api_client.model.json_api_organization_setting_in_document import JsonApiOrganizationSettingInDocument
 
 from gooddata_sdk.catalog.catalog_service_base import CatalogServiceBase
 from gooddata_sdk.catalog.organization.entity_model.directive import CatalogCspDirective
+from gooddata_sdk.catalog.organization.entity_model.identity_provider import CatalogIdentityProvider
 from gooddata_sdk.catalog.organization.entity_model.jwk import CatalogJwk, CatalogJwkDocument
 from gooddata_sdk.catalog.organization.entity_model.organization import CatalogOrganizationDocument
 from gooddata_sdk.catalog.organization.entity_model.setting import CatalogOrganizationSetting
+from gooddata_sdk.catalog.organization.layout.identity_provider import CatalogDeclarativeIdentityProvider
 from gooddata_sdk.catalog.organization.layout.notification_channel import CatalogDeclarativeNotificationChannel
 from gooddata_sdk.client import GoodDataApiClient
-from gooddata_sdk.utils import load_all_entities
+from gooddata_sdk.utils import load_all_entities, load_all_entities_dict
 
 
 class CatalogOrganizationService(CatalogServiceBase):
@@ -188,7 +191,7 @@ class CatalogOrganizationService(CatalogServiceBase):
 
         Args:
             organization_setting (CatalogOrganizationSettings):
-                A catalog organization setting an object to be created.
+                A catalog organization setting object to be created.
 
         Returns:
             None
@@ -225,7 +228,7 @@ class CatalogOrganizationService(CatalogServiceBase):
 
         Args:
             organization_setting (CatalogOrganizationSettings):
-                A catalog organization setting an object to be updated.
+                A catalog organization setting object to be updated.
 
         Returns:
             None
@@ -249,7 +252,7 @@ class CatalogOrganizationService(CatalogServiceBase):
         """Returns a list of all csp directives in the current organization.
 
         Returns:
-            list[CatalogOrganizationSettings]:
+            list[CatalogCspDirective]:
                 List of csp directives in the current organization.
         """
         get_csp_directives = functools.partial(
@@ -277,7 +280,7 @@ class CatalogOrganizationService(CatalogServiceBase):
 
         Args:
             csp_directive (CatalogCspDirective):
-                A catalog csp directive an object to be created.
+                A catalog csp directive object to be created.
 
         Returns:
             None
@@ -309,7 +312,7 @@ class CatalogOrganizationService(CatalogServiceBase):
 
         Args:
             csp_directive (CatalogCspDirective):
-                A catalog csp directive an object to be updated.
+                A catalog csp directive object to be updated.
 
         Returns:
             None
@@ -324,6 +327,86 @@ class CatalogOrganizationService(CatalogServiceBase):
         except NotFoundException:
             raise ValueError(f"Can not update {csp_directive.id} csp directive. This csp directive does not exist.")
 
+    def list_identity_providers(self) -> list[CatalogIdentityProvider]:
+        """Returns a list of all identity providers in the current organization.
+
+        Returns:
+            list[CatalogIdentityProvider]:
+                List of identity providers in the current organization.
+        """
+        get_identity_providers = functools.partial(
+            self._entities_api.get_all_entities_identity_providers,
+            _check_return_type=False,
+        )
+        identity_providers = load_all_entities_dict(get_identity_providers, camel_case=False)
+        return [
+            CatalogIdentityProvider.from_dict(identity_provider, camel_case=False)
+            for identity_provider in identity_providers["data"]
+        ]
+
+    def get_identity_provider(self, identity_provider_id: str) -> CatalogIdentityProvider:
+        """Get an individual identity provider.
+
+        Args:
+            identity_provider_id (str):
+                Identity provider identification string e.g. "demo"
+
+        Returns:
+            CatalogIdentityProvider:
+                Catalog identity provider object containing structure of the identity provider.
+        """
+        identity_provider_api = self._entities_api.get_entity_identity_providers(id=identity_provider_id).data
+        return CatalogIdentityProvider.from_api(identity_provider_api)
+
+    def create_identity_provider(self, identity_provider: CatalogIdentityProvider) -> None:
+        """Create a new identity provider.
+
+        Args:
+            identity_provider (CatalogIdentityProvider):
+                A catalog identity provider object to be created.
+
+        Returns:
+            None
+        """
+        identity_provider_document = JsonApiIdentityProviderInDocument(data=identity_provider.to_api())
+        self._entities_api.create_entity_identity_providers(
+            json_api_identity_provider_in_document=identity_provider_document
+        )
+
+    def delete_identity_provider(self, identity_provider_id: str) -> None:
+        """Delete an identity provider.
+
+        Args:
+            identity_provider_id (str):
+                Identity provider identification string e.g. "demo"
+
+        Returns:
+            None
+        """
+        self._entities_api.delete_entity_identity_providers(identity_provider_id)
+
+    def update_identity_provider(self, identity_provider: CatalogIdentityProvider) -> None:
+        """Update an identity provider.
+
+        Args:
+            identity_provider (CatalogIdentityProvider):
+                A catalog identity provider object to be updated.
+
+        Returns:
+            None
+
+        Raises:
+            ValueError:
+                Identity provider does not exist.
+        """
+        try:
+            identity_provider_document = JsonApiIdentityProviderInDocument(data=identity_provider.to_api())
+            self._entities_api.update_entity_identity_providers(identity_provider.id, identity_provider_document)
+        except NotFoundException:
+            raise ValueError(
+                f"Can not update {identity_provider.id} identity provider. " f"This identity provider does not exist."
+            )
+
     # Layout APIs
 
     def get_declarative_notification_channels(self) -> list[CatalogDeclarativeNotificationChannel]:
@@ -354,3 +437,29 @@ class CatalogOrganizationService(CatalogServiceBase):
         """
         api_ncs = [nc.to_api() for nc in notification_channels]
         self._layout_api.set_notification_channels(DeclarativeNotificationChannels(notification_channels=api_ncs))
+
+    def get_declarative_identity_providers(self) -> list[CatalogDeclarativeIdentityProvider]:
+        """
+        Get all declarative identity providers in the current organization.
+
+        Returns:
+            list[CatalogDeclarativeIdentityProvider]:
+                List of declarative identity providers.
+        """
+        return [
+            CatalogDeclarativeIdentityProvider.from_api(idp) for idp in self._layout_api.get_identity_providers_layout()
+        ]
+
+    def put_declarative_identity_providers(self, identity_providers: list[CatalogDeclarativeIdentityProvider]) -> None:
+        """
+        Put declarative identity providers in the current organization.
+
+        Args:
+            identity_providers (list[CatalogDeclarativeIdentityProvider]):
+                List of declarative identity providers.
+
+        Returns:
+            None
+        """
+        api_idps = [idp.to_api() for idp in identity_providers]
+        self._layout_api.set_identity_providers(declarative_identity_provider=api_idps)

{gooddata_sdk-1.31.1.dev1 → gooddata_sdk-1.31.1.dev2/gooddata_sdk.egg-info}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: gooddata-sdk
-Version: 1.31.1.dev1
+Version: 1.31.1.dev2
 Summary: GoodData Cloud Python SDK
 Author: GoodData
 Author-email: support@gooddata.com
 License: MIT
-Project-URL: Documentation, https://www.gooddata.com/docs/python-sdk/1.31.1.dev1
+Project-URL: Documentation, https://www.gooddata.com/docs/python-sdk/1.31.1.dev2
 Project-URL: Source, https://github.com/gooddata/gooddata-python-sdk
 Keywords: gooddata,sdk,api,analytics,headless,business,intelligence,headless-bi,cloud,native,semantic,layer,sql,metrics
 Classifier: Development Status :: 5 - Production/Stable
@@ -22,7 +22,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.9.0
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: gooddata-api-client~=1.31.1.dev1
+Requires-Dist: gooddata-api-client~=1.31.1.dev2
 Requires-Dist: python-dateutil>=2.5.3
 Requires-Dist: pyyaml>=5.1
 Requires-Dist: attrs<=24.2.0,>=21.4.0
@@ -46,7 +46,7 @@ At the moment the SDK provides services to inspect and interact with the Semanti
 * Compute Service
 * Table Service
 
-See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.31.1.dev1) for more details.
+See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.31.1.dev2) for more details.
 
 ## Requirements
 

{gooddata_sdk-1.31.1.dev1 → gooddata_sdk-1.31.1.dev2}/gooddata_sdk.egg-info/SOURCES.txt

@@ -59,10 +59,12 @@ gooddata_sdk/catalog/organization/__init__.py
 gooddata_sdk/catalog/organization/service.py
 gooddata_sdk/catalog/organization/entity_model/__init__.py
 gooddata_sdk/catalog/organization/entity_model/directive.py
+gooddata_sdk/catalog/organization/entity_model/identity_provider.py
 gooddata_sdk/catalog/organization/entity_model/jwk.py
 gooddata_sdk/catalog/organization/entity_model/organization.py
 gooddata_sdk/catalog/organization/entity_model/setting.py
 gooddata_sdk/catalog/organization/layout/__init__.py
+gooddata_sdk/catalog/organization/layout/identity_provider.py
 gooddata_sdk/catalog/organization/layout/notification_channel.py
 gooddata_sdk/catalog/permission/__init__.py
 gooddata_sdk/catalog/permission/service.py

{gooddata_sdk-1.31.1.dev1 → gooddata_sdk-1.31.1.dev2}/gooddata_sdk.egg-info/requires.txt

@@ -1,4 +1,4 @@
-gooddata-api-client~=1.31.1.dev1
+gooddata-api-client~=1.31.1.dev2
 python-dateutil>=2.5.3
 pyyaml>=5.1
 attrs<=24.2.0,>=21.4.0

{gooddata_sdk-1.31.1.dev1 → gooddata_sdk-1.31.1.dev2}/setup.py

@@ -7,7 +7,7 @@ this_directory = Path(__file__).parent
 long_description = (this_directory / "README.md").read_text(encoding="utf-8")
 
 REQUIRES = [
-    "gooddata-api-client~=1.31.1.dev1",
+    "gooddata-api-client~=1.31.1.dev2",
     "python-dateutil>=2.5.3",
     "pyyaml>=5.1",
     "attrs>=21.4.0,<=24.2.0",
@@ -22,7 +22,7 @@ setup(
     description="GoodData Cloud Python SDK",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    version="1.31.1.dev1",
+    version="1.31.1.dev2",
     author="GoodData",
     author_email="support@gooddata.com",
     license="MIT",
@@ -36,7 +36,7 @@ setup(
         "bin/gdc",
     ],
     project_urls={
-        "Documentation": "https://www.gooddata.com/docs/python-sdk/1.31.1.dev1",
+        "Documentation": "https://www.gooddata.com/docs/python-sdk/1.31.1.dev2",
         "Source": "https://github.com/gooddata/gooddata-python-sdk",
     },
     classifiers=[