Add OAuth support for Synthetics tests (#1247)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-11-22 09:27:34.695235",
-            "spec_repo_commit": "b67ecba8"
+            "regenerated": "2022-11-22 13:48:52.624197",
+            "spec_repo_commit": "dad9f2c8"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-11-22 09:27:34.706182",
-            "spec_repo_commit": "b67ecba8"
+            "regenerated": "2022-11-22 13:48:52.635220",
+            "spec_repo_commit": "dad9f2c8"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -11523,6 +11523,8 @@ components:
       - $ref: '#/components/schemas/SyntheticsBasicAuthSigv4'
       - $ref: '#/components/schemas/SyntheticsBasicAuthNTLM'
       - $ref: '#/components/schemas/SyntheticsBasicAuthDigest'
+      - $ref: '#/components/schemas/SyntheticsBasicAuthOauthClient'
+      - $ref: '#/components/schemas/SyntheticsBasicAuthOauthROP'
       type: object
     SyntheticsBasicAuthDigest:
       description: Object to handle digest authentication when performing the test.
@@ -11586,6 +11588,115 @@ components:
       type: string
       x-enum-varnames:
       - NTLM
+    SyntheticsBasicAuthOauthClient:
+      description: Object to handle `oauth client` authentication when performing
+        the test.
+      properties:
+        accessTokenUrl:
+          description: Access token URL to use when performing the authentication.
+          example: https://example.com
+          type: string
+        audience:
+          description: Audience to use when performing the authentication.
+          example: audience
+          type: string
+        clientId:
+          description: Client ID to use when performing the authentication.
+          example: oauth-username
+          type: string
+        clientSecret:
+          description: Client secret to use when performing the authentication.
+          example: oauth-password
+          type: string
+        resource:
+          description: Resource to use when performing the authentication.
+          example: resource
+          type: string
+        scope:
+          description: Scope to use when performing the authentication.
+          example: scope
+          type: string
+        tokenApiAuthentication:
+          $ref: '#/components/schemas/SyntheticsBasicAuthOauthTokenApiAuthentication'
+        type:
+          $ref: '#/components/schemas/SyntheticsBasicAuthOauthClientType'
+      required:
+      - accessTokenUrl
+      - tokenApiAuthentication
+      - clientId
+      - clientSecret
+      type: object
+    SyntheticsBasicAuthOauthClientType:
+      default: oauth-client
+      description: The type of basic authentication to use when performing the test.
+      enum:
+      - oauth-client
+      example: oauth-client
+      type: string
+      x-enum-varnames:
+      - OAUTH_CLIENT
+    SyntheticsBasicAuthOauthROP:
+      description: Object to handle `oauth rop` authentication when performing the
+        test.
+      properties:
+        accessTokenUrl:
+          description: Access token URL to use when performing the authentication.
+          example: https://example.com
+          type: string
+        audience:
+          description: Audience to use when performing the authentication.
+          example: audience
+          type: string
+        clientId:
+          description: Client ID to use when performing the authentication.
+          example: client-id
+          type: string
+        clientSecret:
+          description: Client secret to use when performing the authentication.
+          example: client-secret
+          type: string
+        password:
+          description: Password to use when performing the authentication.
+          example: password
+          type: string
+        resource:
+          description: Resource to use when performing the authentication.
+          example: resource
+          type: string
+        scope:
+          description: Scope to use when performing the authentication.
+          example: scope
+          type: string
+        type:
+          $ref: '#/components/schemas/SyntheticsBasicAuthOauthROPType'
+        username:
+          description: Username to use when performing the authentication.
+          example: username
+          type: string
+      required:
+      - accessTokenUrl
+      - password
+      - username
+      type: object
+    SyntheticsBasicAuthOauthROPType:
+      default: oauth-rop
+      description: The type of basic authentication to use when performing the test.
+      enum:
+      - oauth-rop
+      example: oauth-rop
+      type: string
+      x-enum-varnames:
+      - OAUTH_ROP
+    SyntheticsBasicAuthOauthTokenApiAuthentication:
+      description: Type of token to use when performing the authentication.
+      enum:
+      - header
+      - body
+      example: header
+      type: string
+      x-enum-varnames:
+      - HEADER
+      - BODY
     SyntheticsBasicAuthSigv4:
       description: Object to handle `SIGV4` authentication when performing the test.
       properties:

docs/datadog_api_client.v1.model.rst

@@ -3431,6 +3431,41 @@ synthetics\_basic\_auth\_ntlm\_type
    :members:
    :show-inheritance:
 
+synthetics\_basic\_auth\_oauth\_client
+--------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_basic_auth_oauth_client
+   :members:
+   :show-inheritance:
+
+synthetics\_basic\_auth\_oauth\_client\_type
+--------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_basic_auth_oauth_client_type
+   :members:
+   :show-inheritance:
+
+synthetics\_basic\_auth\_oauth\_rop
+-----------------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_basic_auth_oauth_rop
+   :members:
+   :show-inheritance:
+
+synthetics\_basic\_auth\_oauth\_rop\_type
+-----------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_basic_auth_oauth_rop_type
+   :members:
+   :show-inheritance:
+
+synthetics\_basic\_auth\_oauth\_token\_api\_authentication
+----------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_basic_auth_oauth_token_api_authentication
+   :members:
+   :show-inheritance:
+
 synthetics\_basic\_auth\_sigv4
 ------------------------------
 

examples/v1/synthetics/CreateSyntheticsAPITest_1487281163.py

@@ -19,6 +19,11 @@
 from datadog_api_client.v1.model.synthetics_assertion_x_path_operator import SyntheticsAssertionXPathOperator
 from datadog_api_client.v1.model.synthetics_assertion_x_path_target import SyntheticsAssertionXPathTarget
 from datadog_api_client.v1.model.synthetics_assertion_x_path_target_target import SyntheticsAssertionXPathTargetTarget
+from datadog_api_client.v1.model.synthetics_basic_auth_oauth_client import SyntheticsBasicAuthOauthClient
+from datadog_api_client.v1.model.synthetics_basic_auth_oauth_client_type import SyntheticsBasicAuthOauthClientType
+from datadog_api_client.v1.model.synthetics_basic_auth_oauth_token_api_authentication import (
+    SyntheticsBasicAuthOauthTokenApiAuthentication,
+)
 from datadog_api_client.v1.model.synthetics_config_variable import SyntheticsConfigVariable
 from datadog_api_client.v1.model.synthetics_config_variable_type import SyntheticsConfigVariableType
 from datadog_api_client.v1.model.synthetics_test_details_sub_type import SyntheticsTestDetailsSubType
@@ -94,6 +99,16 @@
                 url="https://datadoghq.com",
                 headers=SyntheticsTestHeaders(),
             ),
+            basic_auth=SyntheticsBasicAuthOauthClient(
+                access_token_url="https://datadog-token.com",
+                audience="audience",
+                client_id="client-id",
+                client_secret="client-secret",
+                resource="resource",
+                scope="yoyo",
+                token_api_authentication=SyntheticsBasicAuthOauthTokenApiAuthentication.HEADER,
+                type=SyntheticsBasicAuthOauthClientType.OAUTH_CLIENT,
+            ),
         ),
     ),
     locations=[

src/datadog_api_client/v1/model/synthetics_basic_auth.py

@@ -44,6 +44,27 @@ def __init__(self, **kwargs):
 
         :param workstation: Workstation for the authentication to use when performing the test.
         :type workstation: str, optional
+
+        :param access_token_url: Access token URL to use when performing the authentication.
+        :type access_token_url: str
+
+        :param audience: Audience to use when performing the authentication.
+        :type audience: str, optional
+
+        :param client_id: Client ID to use when performing the authentication.
+        :type client_id: str
+
+        :param client_secret: Client secret to use when performing the authentication.
+        :type client_secret: str
+
+        :param resource: Resource to use when performing the authentication.
+        :type resource: str, optional
+
+        :param scope: Scope to use when performing the authentication.
+        :type scope: str, optional
+
+        :param token_api_authentication: Type of token to use when performing the authentication.
+        :type token_api_authentication: SyntheticsBasicAuthOauthTokenApiAuthentication
         """
         super().__init__(kwargs)
 
@@ -60,12 +81,16 @@ def _composed_schemas(_):
         from datadog_api_client.v1.model.synthetics_basic_auth_sigv4 import SyntheticsBasicAuthSigv4
         from datadog_api_client.v1.model.synthetics_basic_auth_ntlm import SyntheticsBasicAuthNTLM
         from datadog_api_client.v1.model.synthetics_basic_auth_digest import SyntheticsBasicAuthDigest
+        from datadog_api_client.v1.model.synthetics_basic_auth_oauth_client import SyntheticsBasicAuthOauthClient
+        from datadog_api_client.v1.model.synthetics_basic_auth_oauth_rop import SyntheticsBasicAuthOauthROP
 
         return {
             "oneOf": [
                 SyntheticsBasicAuthWeb,
                 SyntheticsBasicAuthSigv4,
                 SyntheticsBasicAuthNTLM,
                 SyntheticsBasicAuthDigest,
+                SyntheticsBasicAuthOauthClient,
+                SyntheticsBasicAuthOauthROP,
             ],
         }

src/datadog_api_client/v1/model/synthetics_basic_auth_oauth_client.py

@@ -0,0 +1,107 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Union
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v1.model.synthetics_basic_auth_oauth_token_api_authentication import (
+        SyntheticsBasicAuthOauthTokenApiAuthentication,
+    )
+    from datadog_api_client.v1.model.synthetics_basic_auth_oauth_client_type import SyntheticsBasicAuthOauthClientType
+
+
+class SyntheticsBasicAuthOauthClient(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v1.model.synthetics_basic_auth_oauth_token_api_authentication import (
+            SyntheticsBasicAuthOauthTokenApiAuthentication,
+        )
+        from datadog_api_client.v1.model.synthetics_basic_auth_oauth_client_type import (
+            SyntheticsBasicAuthOauthClientType,
+        )
+
+        return {
+            "access_token_url": (str,),
+            "audience": (str,),
+            "client_id": (str,),
+            "client_secret": (str,),
+            "resource": (str,),
+            "scope": (str,),
+            "token_api_authentication": (SyntheticsBasicAuthOauthTokenApiAuthentication,),
+            "type": (SyntheticsBasicAuthOauthClientType,),
+        }
+
+    attribute_map = {
+        "access_token_url": "accessTokenUrl",
+        "audience": "audience",
+        "client_id": "clientId",
+        "client_secret": "clientSecret",
+        "resource": "resource",
+        "scope": "scope",
+        "token_api_authentication": "tokenApiAuthentication",
+        "type": "type",
+    }
+
+    def __init__(
+        self_,
+        access_token_url: str,
+        client_id: str,
+        client_secret: str,
+        token_api_authentication: SyntheticsBasicAuthOauthTokenApiAuthentication,
+        audience: Union[str, UnsetType] = unset,
+        resource: Union[str, UnsetType] = unset,
+        scope: Union[str, UnsetType] = unset,
+        type: Union[SyntheticsBasicAuthOauthClientType, UnsetType] = unset,
+        **kwargs,
+    ):
+        """
+        Object to handle ``oauth client`` authentication when performing the test.
+
+        :param access_token_url: Access token URL to use when performing the authentication.
+        :type access_token_url: str
+
+        :param audience: Audience to use when performing the authentication.
+        :type audience: str, optional
+
+        :param client_id: Client ID to use when performing the authentication.
+        :type client_id: str
+
+        :param client_secret: Client secret to use when performing the authentication.
+        :type client_secret: str
+
+        :param resource: Resource to use when performing the authentication.
+        :type resource: str, optional
+
+        :param scope: Scope to use when performing the authentication.
+        :type scope: str, optional
+
+        :param token_api_authentication: Type of token to use when performing the authentication.
+        :type token_api_authentication: SyntheticsBasicAuthOauthTokenApiAuthentication
+
+        :param type: The type of basic authentication to use when performing the test.
+        :type type: SyntheticsBasicAuthOauthClientType, optional
+        """
+        if audience is not unset:
+            kwargs["audience"] = audience
+        if resource is not unset:
+            kwargs["resource"] = resource
+        if scope is not unset:
+            kwargs["scope"] = scope
+        if type is not unset:
+            kwargs["type"] = type
+        super().__init__(kwargs)
+
+        self_.access_token_url = access_token_url
+        self_.client_id = client_id
+        self_.client_secret = client_secret
+        self_.token_api_authentication = token_api_authentication