feat(iam): rework saml endpoints (#1196)

Author: scaleway-bot

scaleway-async/scaleway_async/iam/v1alpha1/__init__.py

@@ -18,6 +18,7 @@
 from .types import PermissionSetScopeType
 from .types import SamlCertificateOrigin
 from .types import SamlCertificateType
+from .types import SamlStatus
 from .types import UserStatus
 from .types import UserType
 from .types import ConnectionConnectedOrganization
@@ -39,6 +40,7 @@
 from .types import SSHKey
 from .types import SamlCertificate
 from .types import User
+from .types import SamlServiceProvider
 from .types import AddGroupMemberRequest
 from .types import AddGroupMembersRequest
 from .types import AddSamlCertificateRequest
@@ -47,7 +49,6 @@
 from .types import CreateApplicationRequest
 from .types import CreateGroupRequest
 from .types import CreateJWTRequest
-from .types import CreateOrganizationSamlRequest
 from .types import CreatePolicyRequest
 from .types import CreateSSHKeyRequest
 from .types import CreateUserMFAOTPRequest
@@ -56,12 +57,13 @@
 from .types import DeleteApplicationRequest
 from .types import DeleteGroupRequest
 from .types import DeleteJWTRequest
-from .types import DeleteOrganizationSamlRequest
 from .types import DeletePolicyRequest
 from .types import DeleteSSHKeyRequest
 from .types import DeleteSamlCertificateRequest
+from .types import DeleteSamlRequest
 from .types import DeleteUserMFAOTPRequest
 from .types import DeleteUserRequest
+from .types import EnableOrganizationSamlRequest
 from .types import EncodedJWT
 from .types import GetAPIKeyRequest
 from .types import GetApplicationRequest
@@ -74,7 +76,6 @@
 from .types import GetPolicyRequest
 from .types import GetQuotumRequest
 from .types import GetSSHKeyRequest
-from .types import GetSamlInformationRequest
 from .types import GetUserConnectionsRequest
 from .types import GetUserConnectionsResponse
 from .types import GetUserRequest
@@ -115,7 +116,6 @@
 from .types import RemoveGroupMemberRequest
 from .types import RemoveUserConnectionRequest
 from .types import Saml
-from .types import SamlInformation
 from .types import SetGroupMembersRequest
 from .types import SetOrganizationAliasRequest
 from .types import SetRulesRequest
@@ -124,10 +124,10 @@
 from .types import UpdateAPIKeyRequest
 from .types import UpdateApplicationRequest
 from .types import UpdateGroupRequest
-from .types import UpdateOrganizationSamlRequest
 from .types import UpdateOrganizationSecuritySettingsRequest
 from .types import UpdatePolicyRequest
 from .types import UpdateSSHKeyRequest
+from .types import UpdateSamlRequest
 from .types import UpdateUserPasswordRequest
 from .types import UpdateUserRequest
 from .types import UpdateUserUsernameRequest
@@ -154,6 +154,7 @@
     "PermissionSetScopeType",
     "SamlCertificateOrigin",
     "SamlCertificateType",
+    "SamlStatus",
     "UserStatus",
     "UserType",
     "ConnectionConnectedOrganization",
@@ -175,6 +176,7 @@
     "SSHKey",
     "SamlCertificate",
     "User",
+    "SamlServiceProvider",
     "AddGroupMemberRequest",
     "AddGroupMembersRequest",
     "AddSamlCertificateRequest",
@@ -183,7 +185,6 @@
     "CreateApplicationRequest",
     "CreateGroupRequest",
     "CreateJWTRequest",
-    "CreateOrganizationSamlRequest",
     "CreatePolicyRequest",
     "CreateSSHKeyRequest",
     "CreateUserMFAOTPRequest",
@@ -192,12 +193,13 @@
     "DeleteApplicationRequest",
     "DeleteGroupRequest",
     "DeleteJWTRequest",
-    "DeleteOrganizationSamlRequest",
     "DeletePolicyRequest",
     "DeleteSSHKeyRequest",
     "DeleteSamlCertificateRequest",
+    "DeleteSamlRequest",
     "DeleteUserMFAOTPRequest",
     "DeleteUserRequest",
+    "EnableOrganizationSamlRequest",
     "EncodedJWT",
     "GetAPIKeyRequest",
     "GetApplicationRequest",
@@ -210,7 +212,6 @@
     "GetPolicyRequest",
     "GetQuotumRequest",
     "GetSSHKeyRequest",
-    "GetSamlInformationRequest",
     "GetUserConnectionsRequest",
     "GetUserConnectionsResponse",
     "GetUserRequest",
@@ -251,7 +252,6 @@
     "RemoveGroupMemberRequest",
     "RemoveUserConnectionRequest",
     "Saml",
-    "SamlInformation",
     "SetGroupMembersRequest",
     "SetOrganizationAliasRequest",
     "SetRulesRequest",
@@ -260,10 +260,10 @@
     "UpdateAPIKeyRequest",
     "UpdateApplicationRequest",
     "UpdateGroupRequest",
-    "UpdateOrganizationSamlRequest",
     "UpdateOrganizationSecuritySettingsRequest",
     "UpdatePolicyRequest",
     "UpdateSSHKeyRequest",
+    "UpdateSamlRequest",
     "UpdateUserPasswordRequest",
     "UpdateUserRequest",
     "UpdateUserUsernameRequest",

scaleway-async/scaleway_async/iam/v1alpha1/api.py

@@ -37,7 +37,6 @@
     CreateApplicationRequest,
     CreateGroupRequest,
     CreateJWTRequest,
-    CreateOrganizationSamlRequest,
     CreatePolicyRequest,
     CreateSSHKeyRequest,
     CreateUserRequest,
@@ -75,18 +74,17 @@
     SSHKey,
     Saml,
     SamlCertificate,
-    SamlInformation,
     SetGroupMembersRequest,
     SetOrganizationAliasRequest,
     SetRulesRequest,
     SetRulesResponse,
     UpdateAPIKeyRequest,
     UpdateApplicationRequest,
     UpdateGroupRequest,
-    UpdateOrganizationSamlRequest,
     UpdateOrganizationSecuritySettingsRequest,
     UpdatePolicyRequest,
     UpdateSSHKeyRequest,
+    UpdateSamlRequest,
     UpdateUserPasswordRequest,
     UpdateUserRequest,
     UpdateUserUsernameRequest,
@@ -125,7 +123,6 @@
     unmarshal_Organization,
     unmarshal_OrganizationSecuritySettings,
     unmarshal_Saml,
-    unmarshal_SamlInformation,
     unmarshal_SetRulesResponse,
     unmarshal_ValidateUserMFAOTPResponse,
     marshal_AddGroupMemberRequest,
@@ -135,7 +132,6 @@
     marshal_CreateApplicationRequest,
     marshal_CreateGroupRequest,
     marshal_CreateJWTRequest,
-    marshal_CreateOrganizationSamlRequest,
     marshal_CreatePolicyRequest,
     marshal_CreateSSHKeyRequest,
     marshal_CreateUserRequest,
@@ -148,10 +144,10 @@
     marshal_UpdateAPIKeyRequest,
     marshal_UpdateApplicationRequest,
     marshal_UpdateGroupRequest,
-    marshal_UpdateOrganizationSamlRequest,
     marshal_UpdateOrganizationSecuritySettingsRequest,
     marshal_UpdatePolicyRequest,
     marshal_UpdateSSHKeyRequest,
+    marshal_UpdateSamlRequest,
     marshal_UpdateUserPasswordRequest,
     marshal_UpdateUserRequest,
     marshal_UpdateUserUsernameRequest,
@@ -3072,27 +3068,20 @@ async def get_organization_saml(
         self._throw_on_error(res)
         return unmarshal_Saml(res.json())
 
-    async def create_organization_saml(
+    async def enable_organization_saml(
         self,
         *,
-        entity_id: str,
-        single_sign_on_url: str,
         organization_id: Optional[str] = None,
     ) -> Saml:
         """
-        Create a SAML Identity Provider configuration for an Organization.
-        :param entity_id: Entity ID of the SAML Identity Provider.
-        :param single_sign_on_url: Single Sign-On URL of the SAML Identity Provider.
+        Enable SAML Identity Provider for an Organization.
         :param organization_id: ID of the Organization.
         :return: :class:`Saml <Saml>`
 
         Usage:
         ::
 
-            result = await api.create_organization_saml(
-                entity_id="example",
-                single_sign_on_url="example",
-            )
+            result = await api.enable_organization_saml()
         """
 
         param_organization_id = validate_path_param(
@@ -3102,49 +3091,42 @@ async def create_organization_saml(
         res = self._request(
             "POST",
             f"/iam/v1alpha1/organizations/{param_organization_id}/saml",
-            body=marshal_CreateOrganizationSamlRequest(
-                CreateOrganizationSamlRequest(
-                    entity_id=entity_id,
-                    single_sign_on_url=single_sign_on_url,
-                    organization_id=organization_id,
-                ),
-                self.client,
-            ),
+            body={},
         )
 
         self._throw_on_error(res)
         return unmarshal_Saml(res.json())
 
-    async def update_organization_saml(
+    async def update_saml(
         self,
         *,
-        organization_id: Optional[str] = None,
+        saml_id: str,
         entity_id: Optional[str] = None,
         single_sign_on_url: Optional[str] = None,
     ) -> Saml:
         """
-        Update a SAML Identity Provider configuration for an Organization.
-        :param organization_id: ID of the Organization.
+        Update SAML Identity Provider configuration.
+        :param saml_id: ID of the SAML configuration.
         :param entity_id: Entity ID of the SAML Identity Provider.
         :param single_sign_on_url: Single Sign-On URL of the SAML Identity Provider.
         :return: :class:`Saml <Saml>`
 
         Usage:
         ::
 
-            result = await api.update_organization_saml()
+            result = await api.update_saml(
+                saml_id="example",
+            )
         """
 
-        param_organization_id = validate_path_param(
-            "organization_id", organization_id or self.client.default_organization_id
-        )
+        param_saml_id = validate_path_param("saml_id", saml_id)
 
         res = self._request(
             "PATCH",
-            f"/iam/v1alpha1/organizations/{param_organization_id}/saml",
-            body=marshal_UpdateOrganizationSamlRequest(
-                UpdateOrganizationSamlRequest(
-                    organization_id=organization_id,
+            f"/iam/v1alpha1/saml/{param_saml_id}",
+            body=marshal_UpdateSamlRequest(
+                UpdateSamlRequest(
+                    saml_id=saml_id,
                     entity_id=entity_id,
                     single_sign_on_url=single_sign_on_url,
                 ),
@@ -3155,28 +3137,28 @@ async def update_organization_saml(
         self._throw_on_error(res)
         return unmarshal_Saml(res.json())
 
-    async def delete_organization_saml(
+    async def delete_saml(
         self,
         *,
-        organization_id: Optional[str] = None,
+        saml_id: str,
     ) -> None:
         """
-        Delete a SAML Identity Provider configuration for an Organization.
-        :param organization_id: ID of the Organization.
+        Disable SAML Identity Provider for an Organization.
+        :param saml_id: ID of the SAML configuration.
 
         Usage:
         ::
 
-            result = await api.delete_organization_saml()
+            result = await api.delete_saml(
+                saml_id="example",
+            )
         """
 
-        param_organization_id = validate_path_param(
-            "organization_id", organization_id or self.client.default_organization_id
-        )
+        param_saml_id = validate_path_param("saml_id", saml_id)
 
         res = self._request(
             "DELETE",
-            f"/iam/v1alpha1/organizations/{param_organization_id}/saml",
+            f"/iam/v1alpha1/saml/{param_saml_id}",
         )
 
         self._throw_on_error(res)
@@ -3276,25 +3258,3 @@ async def delete_saml_certificate(
         )
 
         self._throw_on_error(res)
-
-    async def get_saml_information(
-        self,
-    ) -> SamlInformation:
-        """
-        Get SAML information.
-
-        :return: :class:`SamlInformation <SamlInformation>`
-
-        Usage:
-        ::
-
-            result = await api.get_saml_information()
-        """
-
-        res = self._request(
-            "GET",
-            "/iam/v1alpha1/saml-information",
-        )
-
-        self._throw_on_error(res)
-        return unmarshal_SamlInformation(res.json())