feat: Add pilot auth

Author: Robin-Van-de-Merghel

diracx-client/src/diracx/client/_generated/aio/operations/_operations.py

@@ -16,6 +16,9 @@
     BodyAuthGetOidcTokenGrantType,
     BodyPilotsAddPilotStamps,
     BodyPilotsAssociatePilotWithJobs,
+    BodyPilotsCreatePilotSecrets,
+    BodyPilotsPilotLogin,
+    BodyPilotsRefreshPilotTokens,
     BodyPilotsUpdatePilotFields,
     GroupInfo,
     HTTPValidationError,
@@ -28,7 +31,11 @@
     JobSummaryParamsSearchItem,
     Metadata,
     OpenIDConfiguration,
+    PilotCredentialsInfo,
     PilotFieldsMapping,
+    PilotInfo,
+    PilotSecretConstraints,
+    PilotSecretsInfo,
     SandboxDownloadResponse,
     SandboxInfo,
     SandboxUploadResponse,
@@ -67,6 +74,9 @@
     "BodyAuthGetOidcTokenGrantType",
     "BodyPilotsAddPilotStamps",
     "BodyPilotsAssociatePilotWithJobs",
+    "BodyPilotsCreatePilotSecrets",
+    "BodyPilotsPilotLogin",
+    "BodyPilotsRefreshPilotTokens",
     "BodyPilotsUpdatePilotFields",
     "GroupInfo",
     "HTTPValidationError",
@@ -79,7 +89,11 @@
     "JobSummaryParamsSearchItem",
     "Metadata",
     "OpenIDConfiguration",
+    "PilotCredentialsInfo",
     "PilotFieldsMapping",
+    "PilotInfo",
+    "PilotSecretConstraints",
+    "PilotSecretsInfo",
     "SandboxDownloadResponse",
     "SandboxInfo",
     "SandboxUploadResponse",

diracx-client/src/diracx/client/_generated/models/__init__.py

@@ -107,6 +107,10 @@ class BodyPilotsAddPilotStamps(_serialization.Model):
     :vartype grid_type: str
     :ivar pilot_references: Association of a pilot reference with a pilot stamp.
     :vartype pilot_references: dict[str, str]
+    :ivar generate_secrets: If we want to create secrets with the pilots.
+    :vartype generate_secrets: bool
+    :ivar pilot_secret_use_count_max: How much time can a secret be used.
+    :vartype pilot_secret_use_count_max: int
     """
 
     _validation = {
@@ -119,6 +123,8 @@ class BodyPilotsAddPilotStamps(_serialization.Model):
         "vo": {"key": "vo", "type": "str"},
         "grid_type": {"key": "grid_type", "type": "str"},
         "pilot_references": {"key": "pilot_references", "type": "{str}"},
+        "generate_secrets": {"key": "generate_secrets", "type": "bool"},
+        "pilot_secret_use_count_max": {"key": "pilot_secret_use_count_max", "type": "int"},
     }
 
     def __init__(
@@ -128,6 +134,8 @@ def __init__(
         vo: str,
         grid_type: str = "Dirac",
         pilot_references: Optional[Dict[str, str]] = None,
+        generate_secrets: bool = True,
+        pilot_secret_use_count_max: int = 1,
         **kwargs: Any
     ) -> None:
         """
@@ -139,12 +147,18 @@ def __init__(
         :paramtype grid_type: str
         :keyword pilot_references: Association of a pilot reference with a pilot stamp.
         :paramtype pilot_references: dict[str, str]
+        :keyword generate_secrets: If we want to create secrets with the pilots.
+        :paramtype generate_secrets: bool
+        :keyword pilot_secret_use_count_max: How much time can a secret be used.
+        :paramtype pilot_secret_use_count_max: int
         """
         super().__init__(**kwargs)
         self.pilot_stamps = pilot_stamps
         self.vo = vo
         self.grid_type = grid_type
         self.pilot_references = pilot_references
+        self.generate_secrets = generate_secrets
+        self.pilot_secret_use_count_max = pilot_secret_use_count_max
 
 
 class BodyPilotsAssociatePilotWithJobs(_serialization.Model):
@@ -180,6 +194,112 @@ def __init__(self, *, pilot_stamp: str, pilot_jobs_ids: List[int], **kwargs: Any
         self.pilot_jobs_ids = pilot_jobs_ids
 
 
+class BodyPilotsCreatePilotSecrets(_serialization.Model):
+    """Body_pilots_create_pilot_secrets.
+
+    All required parameters must be populated in order to send to server.
+
+    :ivar n: Number of secrets to create. Required.
+    :vartype n: int
+    :ivar expiration_minutes: Time in minutes before expiring. Required.
+    :vartype expiration_minutes: int
+    :ivar pilot_secret_use_count_max: Number of times that we can use a secret. Required.
+    :vartype pilot_secret_use_count_max: int
+    """
+
+    _validation = {
+        "n": {"required": True},
+        "expiration_minutes": {"required": True},
+        "pilot_secret_use_count_max": {"required": True},
+    }
+
+    _attribute_map = {
+        "n": {"key": "n", "type": "int"},
+        "expiration_minutes": {"key": "expiration_minutes", "type": "int"},
+        "pilot_secret_use_count_max": {"key": "pilot_secret_use_count_max", "type": "int"},
+    }
+
+    def __init__(self, *, n: int, expiration_minutes: int, pilot_secret_use_count_max: int, **kwargs: Any) -> None:
+        """
+        :keyword n: Number of secrets to create. Required.
+        :paramtype n: int
+        :keyword expiration_minutes: Time in minutes before expiring. Required.
+        :paramtype expiration_minutes: int
+        :keyword pilot_secret_use_count_max: Number of times that we can use a secret. Required.
+        :paramtype pilot_secret_use_count_max: int
+        """
+        super().__init__(**kwargs)
+        self.n = n
+        self.expiration_minutes = expiration_minutes
+        self.pilot_secret_use_count_max = pilot_secret_use_count_max
+
+
+class BodyPilotsPilotLogin(_serialization.Model):
+    """Body_pilots_pilot_login.
+
+    All required parameters must be populated in order to send to server.
+
+    :ivar pilot_stamp: Stamp used by a pilot to login. Required.
+    :vartype pilot_stamp: str
+    :ivar pilot_secret: Pilot secret given by Dirac/DiracX. Required.
+    :vartype pilot_secret: str
+    """
+
+    _validation = {
+        "pilot_stamp": {"required": True},
+        "pilot_secret": {"required": True},
+    }
+
+    _attribute_map = {
+        "pilot_stamp": {"key": "pilot_stamp", "type": "str"},
+        "pilot_secret": {"key": "pilot_secret", "type": "str"},
+    }
+
+    def __init__(self, *, pilot_stamp: str, pilot_secret: str, **kwargs: Any) -> None:
+        """
+        :keyword pilot_stamp: Stamp used by a pilot to login. Required.
+        :paramtype pilot_stamp: str
+        :keyword pilot_secret: Pilot secret given by Dirac/DiracX. Required.
+        :paramtype pilot_secret: str
+        """
+        super().__init__(**kwargs)
+        self.pilot_stamp = pilot_stamp
+        self.pilot_secret = pilot_secret
+
+
+class BodyPilotsRefreshPilotTokens(_serialization.Model):
+    """Body_pilots_refresh_pilot_tokens.
+
+    All required parameters must be populated in order to send to server.
+
+    :ivar refresh_token: Refresh Token given at login by DiracX. Required.
+    :vartype refresh_token: str
+    :ivar pilot_stamp: Pilot stamp. Required.
+    :vartype pilot_stamp: str
+    """
+
+    _validation = {
+        "refresh_token": {"required": True},
+        "pilot_stamp": {"required": True},
+    }
+
+    _attribute_map = {
+        "refresh_token": {"key": "refresh_token", "type": "str"},
+        "pilot_stamp": {"key": "pilot_stamp", "type": "str"},
+    }
+
+    def __init__(self, *, refresh_token: str, pilot_stamp: str, **kwargs: Any) -> None:
+        """
+        :keyword refresh_token: Refresh Token given at login by DiracX. Required.
+        :paramtype refresh_token: str
+        :keyword pilot_stamp: Pilot stamp. Required.
+        :paramtype pilot_stamp: str
+        """
+        super().__init__(**kwargs)
+        self.refresh_token = refresh_token
+        self.pilot_stamp = pilot_stamp
+
+
 class BodyPilotsUpdatePilotFields(_serialization.Model):
     """Body_pilots_update_pilot_fields.
 
@@ -718,6 +838,46 @@ def __init__(
         self.code_challenge_methods_supported = code_challenge_methods_supported
 
 
+class PilotCredentialsInfo(_serialization.Model):
+    """PilotCredentialsInfo.
+
+    All required parameters must be populated in order to send to server.
+
+    :ivar pilot_secret: Pilot Secret. Required.
+    :vartype pilot_secret: str
+    :ivar pilot_secret_expires_in: Pilot Secret Expires In. Required.
+    :vartype pilot_secret_expires_in: int
+    :ivar pilot_stamp: Pilot Stamp. Required.
+    :vartype pilot_stamp: str
+    """
+
+    _validation = {
+        "pilot_secret": {"required": True},
+        "pilot_secret_expires_in": {"required": True},
+        "pilot_stamp": {"required": True},
+    }
+
+    _attribute_map = {
+        "pilot_secret": {"key": "pilot_secret", "type": "str"},
+        "pilot_secret_expires_in": {"key": "pilot_secret_expires_in", "type": "int"},
+        "pilot_stamp": {"key": "pilot_stamp", "type": "str"},
+    }
+
+    def __init__(self, *, pilot_secret: str, pilot_secret_expires_in: int, pilot_stamp: str, **kwargs: Any) -> None:
+        """
+        :keyword pilot_secret: Pilot Secret. Required.
+        :paramtype pilot_secret: str
+        :keyword pilot_secret_expires_in: Pilot Secret Expires In. Required.
+        :paramtype pilot_secret_expires_in: int
+        :keyword pilot_stamp: Pilot Stamp. Required.
+        :paramtype pilot_stamp: str
+        """
+        super().__init__(**kwargs)
+        self.pilot_secret = pilot_secret
+        self.pilot_secret_expires_in = pilot_secret_expires_in
+        self.pilot_stamp = pilot_stamp
+
+
 class PilotFieldsMapping(_serialization.Model):
     """All the fields that a user can modify on a Pilot (except PilotStamp).
 
@@ -812,6 +972,118 @@ def __init__(
         self.current_job_id = current_job_id
 
 
+class PilotInfo(_serialization.Model):
+    """PilotInfo.
+
+    All required parameters must be populated in order to send to server.
+
+    :ivar pilot_stamp: Pilot Stamp. Required.
+    :vartype pilot_stamp: str
+    :ivar vo: Vo. Required.
+    :vartype vo: str
+    :ivar sub: Sub. Required.
+    :vartype sub: str
+    """
+
+    _validation = {
+        "pilot_stamp": {"required": True},
+        "vo": {"required": True},
+        "sub": {"required": True},
+    }
+
+    _attribute_map = {
+        "pilot_stamp": {"key": "pilot_stamp", "type": "str"},
+        "vo": {"key": "vo", "type": "str"},
+        "sub": {"key": "sub", "type": "str"},
+    }
+
+    def __init__(self, *, pilot_stamp: str, vo: str, sub: str, **kwargs: Any) -> None:
+        """
+        :keyword pilot_stamp: Pilot Stamp. Required.
+        :paramtype pilot_stamp: str
+        :keyword vo: Vo. Required.
+        :paramtype vo: str
+        :keyword sub: Sub. Required.
+        :paramtype sub: str
+        """
+        super().__init__(**kwargs)
+        self.pilot_stamp = pilot_stamp
+        self.vo = vo
+        self.sub = sub
+
+
+class PilotSecretConstraints(_serialization.Model):
+    """PilotSecretConstraints.
+
+    :ivar v_os: Vos.
+    :vartype v_os: list[str]
+    :ivar pilot_stamps: Pilotstamps.
+    :vartype pilot_stamps: list[str]
+    :ivar sites: Sites.
+    :vartype sites: list[str]
+    """
+
+    _attribute_map = {
+        "v_os": {"key": "VOs", "type": "[str]"},
+        "pilot_stamps": {"key": "PilotStamps", "type": "[str]"},
+        "sites": {"key": "Sites", "type": "[str]"},
+    }
+
+    def __init__(
+        self,
+        *,
+        v_os: Optional[List[str]] = None,
+        pilot_stamps: Optional[List[str]] = None,
+        sites: Optional[List[str]] = None,
+        **kwargs: Any
+    ) -> None:
+        """
+        :keyword v_os: Vos.
+        :paramtype v_os: list[str]
+        :keyword pilot_stamps: Pilotstamps.
+        :paramtype pilot_stamps: list[str]
+        :keyword sites: Sites.
+        :paramtype sites: list[str]
+        """
+        super().__init__(**kwargs)
+        self.v_os = v_os
+        self.pilot_stamps = pilot_stamps
+        self.sites = sites
+
+
+class PilotSecretsInfo(_serialization.Model):
+    """PilotSecretsInfo.
+
+    All required parameters must be populated in order to send to server.
+
+    :ivar pilot_secret: Pilot Secret. Required.
+    :vartype pilot_secret: str
+    :ivar pilot_secret_expires_in: Pilot Secret Expires In. Required.
+    :vartype pilot_secret_expires_in: int
+    """
+
+    _validation = {
+        "pilot_secret": {"required": True},
+        "pilot_secret_expires_in": {"required": True},
+    }
+
+    _attribute_map = {
+        "pilot_secret": {"key": "pilot_secret", "type": "str"},
+        "pilot_secret_expires_in": {"key": "pilot_secret_expires_in", "type": "int"},
+    }
+
+    def __init__(self, *, pilot_secret: str, pilot_secret_expires_in: int, **kwargs: Any) -> None:
+        """
+        :keyword pilot_secret: Pilot Secret. Required.
+        :paramtype pilot_secret: str
+        :keyword pilot_secret_expires_in: Pilot Secret Expires In. Required.
+        :paramtype pilot_secret_expires_in: int
+        """
+        super().__init__(**kwargs)
+        self.pilot_secret = pilot_secret
+        self.pilot_secret_expires_in = pilot_secret_expires_in
+
+
 class SandboxDownloadResponse(_serialization.Model):
     """SandboxDownloadResponse.