added more parameters for outbound apps

gaokevin1 · gaokevin1 · commit b6a2e217be5d · 2025-07-29T09:04:16.000-07:00
diff --git a/README.md b/README.md
@@ -1307,7 +1307,7 @@ apps = apps_resp["apps"]
 You can create, update, delete, load outbound applications and fetch tokens for them:
 
 ```python
-# Create an outbound application
+# Create a basic outbound application
 response = descope_client.mgmt.outbound_application.create_application(
     name="my new app",
     description="my desc",
@@ -1316,14 +1316,67 @@ response = descope_client.mgmt.outbound_application.create_application(
 )
 app_id = response["app"]["id"]
 
-# Update an outbound application
+# Create a full OAuth outbound application with all parameters
+from descope.management.common import URLParam, AccessType, PromptType
+
+# Create URL parameters for authorization
+auth_params = [
+    URLParam("response_type", "code"),
+    URLParam("client_id", "my-client-id"),
+    URLParam("redirect_uri", "https://myapp.com/callback")
+]
+
+# Create URL parameters for token endpoint
+token_params = [
+    URLParam("grant_type", "authorization_code"),
+    URLParam("client_id", "my-client-id")
+]
+
+# Create prompt types
+prompts = [PromptType.LOGIN, PromptType.CONSENT]
+
+full_app = descope_client.mgmt.outbound_application.create_application(
+    name="My OAuth App",
+    description="A full OAuth outbound application",
+    logo="https://example.com/logo.png",
+    id="my-custom-id",  # Optional custom ID
+    client_secret="my-secret-key",
+    client_id="my-client-id",
+    discovery_url="https://accounts.google.com/.well-known/openid_configuration",
+    authorization_url="https://accounts.google.com/o/oauth2/v2/auth",
+    authorization_url_params=auth_params,
+    token_url="https://oauth2.googleapis.com/token",
+    token_url_params=token_params,
+    revocation_url="https://oauth2.googleapis.com/revoke",
+    default_scopes=["https://www.googleapis.com/auth/userinfo.profile"],
+    default_redirect_url="https://myapp.com/callback",
+    callback_domain="myapp.com",
+    pkce=True,  # Enable PKCE
+    access_type=AccessType.OFFLINE,  # Request refresh tokens
+    prompt=prompts
+)
+
+# Update an outbound application with all parameters
 # Update will override all fields as is. Use carefully.
 descope_client.mgmt.outbound_application.update_application(
     id="my-app-id",
     name="my updated app",
     description="updated description",
     logo="https://example.com/logo.png",
     client_secret="new-secret",  # Optional
+    client_id="new-client-id",
+    discovery_url="https://accounts.google.com/.well-known/openid_configuration",
+    authorization_url="https://accounts.google.com/o/oauth2/v2/auth",
+    authorization_url_params=auth_params,
+    token_url="https://oauth2.googleapis.com/token",
+    token_url_params=token_params,
+    revocation_url="https://oauth2.googleapis.com/revoke",
+    default_scopes=["https://www.googleapis.com/auth/userinfo.profile", "https://www.googleapis.com/auth/userinfo.email"],
+    default_redirect_url="https://myapp.com/updated-callback",
+    callback_domain="myapp.com",
+    pkce=True,
+    access_type=AccessType.OFFLINE,
+    prompt=[PromptType.LOGIN, PromptType.CONSENT, PromptType.SELECT_ACCOUNT]
 )
 
 # Delete an outbound application by id
diff --git a/descope/management/common.py b/descope/management/common.py
@@ -1,4 +1,32 @@
-from typing import List, Optional
+from typing import List, Optional, Dict, Any
+from enum import Enum
+
+
+class AccessType(Enum):
+    OFFLINE = "offline"
+    ONLINE = "online"
+
+
+class PromptType(Enum):
+    NONE = "none"
+    LOGIN = "login"
+    CONSENT = "consent"
+    SELECT_ACCOUNT = "select_account"
+
+
+class URLParam:
+    def __init__(self, name: str, value: str):
+        self.name = name
+        self.value = value
+
+    def to_dict(self) -> dict:
+        return {"name": self.name, "value": self.value}
+
+
+def url_params_to_dict(url_params: Optional[List[URLParam]] = None) -> list:
+    if url_params is None:
+        return []
+    return [param.to_dict() for param in url_params]
 
 
 class MgmtV1:
@@ -27,8 +55,12 @@ class MgmtV1:
     outbound_application_load_all_path = "/v1/mgmt/outbound/apps"
     outbound_application_fetch_token_by_scopes_path = "/v1/mgmt/outbound/app/user/token"
     outbound_application_fetch_token_path = "/v1/mgmt/outbound/app/user/token/latest"
-    outbound_application_fetch_tenant_token_by_scopes_path = "/v1/mgmt/outbound/app/tenant/token"
-    outbound_application_fetch_tenant_token_path = "/v1/mgmt/outbound/app/tenant/token/latest"
+    outbound_application_fetch_tenant_token_by_scopes_path = (
+        "/v1/mgmt/outbound/app/tenant/token"
+    )
+    outbound_application_fetch_tenant_token_path = (
+        "/v1/mgmt/outbound/app/tenant/token/latest"
+    )
 
     # user
     user_create_path = "/v1/mgmt/user/create"
@@ -376,7 +408,8 @@ def sort_to_dict(sort: List[Sort]) -> list:
             )
     return sort_list
 
+
 def map_to_values_object(input_map: dict):
     if not input_map:
         return {}
-    return {k: {"values": v} for k, v in input_map.items()}
+    return {k: {"values": v} for k, v in input_map.items()}
diff --git a/descope/management/outbound_application.py b/descope/management/outbound_application.py
@@ -1,7 +1,13 @@
 from typing import Any, List, Optional
 
 from descope._auth_base import AuthBase
-from descope.management.common import MgmtV1
+from descope.management.common import (
+    MgmtV1,
+    URLParam,
+    AccessType,
+    PromptType,
+    url_params_to_dict,
+)
 
 
 class OutboundApplication(AuthBase):
@@ -12,6 +18,19 @@ def create_application(
         logo: Optional[str] = None,
         id: Optional[str] = None,
         client_secret: Optional[str] = None,
+        client_id: Optional[str] = None,
+        discovery_url: Optional[str] = None,
+        authorization_url: Optional[str] = None,
+        authorization_url_params: Optional[List[URLParam]] = None,
+        token_url: Optional[str] = None,
+        token_url_params: Optional[List[URLParam]] = None,
+        revocation_url: Optional[str] = None,
+        default_scopes: Optional[List[str]] = None,
+        default_redirect_url: Optional[str] = None,
+        callback_domain: Optional[str] = None,
+        pkce: Optional[bool] = None,
+        access_type: Optional[AccessType] = None,
+        prompt: Optional[List[PromptType]] = None,
     ) -> dict:
         """
         Create a new outbound application with the given name. Outbound application IDs are provisioned automatically, but can be provided
@@ -23,6 +42,19 @@ def create_application(
         logo (str): Optional outbound application logo.
         id (str): Optional outbound application ID.
         client_secret (str): Optional client secret for the application.
+        client_id (str): Optional client ID for the application.
+        discovery_url (str): Optional OAuth discovery URL.
+        authorization_url (str): Optional OAuth authorization URL.
+        authorization_url_params (List[URLParam]): Optional authorization URL parameters.
+        token_url (str): Optional OAuth token URL.
+        token_url_params (List[URLParam]): Optional token URL parameters.
+        revocation_url (str): Optional OAuth token revocation URL.
+        default_scopes (List[str]): Optional default OAuth scopes.
+        default_redirect_url (str): Optional default redirect URL.
+        callback_domain (str): Optional callback domain.
+        pkce (bool): Optional PKCE (Proof Key for Code Exchange) support.
+        access_type (AccessType): Optional OAuth access type.
+        prompt (List[PromptType]): Optional OAuth prompt parameters.
 
         Return value (dict):
         Return dict in the format
@@ -35,7 +67,24 @@ def create_application(
         response = self._auth.do_post(
             uri,
             OutboundApplication._compose_create_update_body(
-                name, description, logo, id, client_secret
+                name,
+                description,
+                logo,
+                id,
+                client_secret,
+                client_id,
+                discovery_url,
+                authorization_url,
+                authorization_url_params,
+                token_url,
+                token_url_params,
+                revocation_url,
+                default_scopes,
+                default_redirect_url,
+                callback_domain,
+                pkce,
+                access_type,
+                prompt,
             ),
             pswd=self._auth.management_key,
         )
@@ -48,6 +97,19 @@ def update_application(
         description: Optional[str] = None,
         logo: Optional[str] = None,
         client_secret: Optional[str] = None,
+        client_id: Optional[str] = None,
+        discovery_url: Optional[str] = None,
+        authorization_url: Optional[str] = None,
+        authorization_url_params: Optional[List[URLParam]] = None,
+        token_url: Optional[str] = None,
+        token_url_params: Optional[List[URLParam]] = None,
+        revocation_url: Optional[str] = None,
+        default_scopes: Optional[List[str]] = None,
+        default_redirect_url: Optional[str] = None,
+        callback_domain: Optional[str] = None,
+        pkce: Optional[bool] = None,
+        access_type: Optional[AccessType] = None,
+        prompt: Optional[List[PromptType]] = None,
     ) -> dict:
         """
         Update an existing outbound application with the given parameters. IMPORTANT: All parameters are used as overrides
@@ -59,6 +121,19 @@ def update_application(
         description (str): Optional outbound application description.
         logo (str): Optional outbound application logo.
         client_secret (str): Optional client secret for the application.
+        client_id (str): Optional client ID for the application.
+        discovery_url (str): Optional OAuth discovery URL.
+        authorization_url (str): Optional OAuth authorization URL.
+        authorization_url_params (List[URLParam]): Optional authorization URL parameters.
+        token_url (str): Optional OAuth token URL.
+        token_url_params (List[URLParam]): Optional token URL parameters.
+        revocation_url (str): Optional OAuth token revocation URL.
+        default_scopes (List[str]): Optional default OAuth scopes.
+        default_redirect_url (str): Optional default redirect URL.
+        callback_domain (str): Optional callback domain.
+        pkce (bool): Optional PKCE (Proof Key for Code Exchange) support.
+        access_type (AccessType): Optional OAuth access type.
+        prompt (List[PromptType]): Optional OAuth prompt parameters.
 
         Return value (dict):
         Return dict in the format
@@ -72,7 +147,24 @@ def update_application(
             uri,
             {
                 "app": OutboundApplication._compose_create_update_body(
-                    name, description, logo, id, client_secret
+                    name,
+                    description,
+                    logo,
+                    id,
+                    client_secret,
+                    client_id,
+                    discovery_url,
+                    authorization_url,
+                    authorization_url_params,
+                    token_url,
+                    token_url_params,
+                    revocation_url,
+                    default_scopes,
+                    default_redirect_url,
+                    callback_domain,
+                    pkce,
+                    access_type,
+                    prompt,
                 )
             },
             pswd=self._auth.management_key,
@@ -290,6 +382,19 @@ def _compose_create_update_body(
         logo: Optional[str] = None,
         id: Optional[str] = None,
         client_secret: Optional[str] = None,
+        client_id: Optional[str] = None,
+        discovery_url: Optional[str] = None,
+        authorization_url: Optional[str] = None,
+        authorization_url_params: Optional[List[URLParam]] = None,
+        token_url: Optional[str] = None,
+        token_url_params: Optional[List[URLParam]] = None,
+        revocation_url: Optional[str] = None,
+        default_scopes: Optional[List[str]] = None,
+        default_redirect_url: Optional[str] = None,
+        callback_domain: Optional[str] = None,
+        pkce: Optional[bool] = None,
+        access_type: Optional[AccessType] = None,
+        prompt: Optional[List[PromptType]] = None,
     ) -> dict:
         body: dict[str, Any] = {
             "name": name,
@@ -299,4 +404,32 @@ def _compose_create_update_body(
         }
         if client_secret:
             body["clientSecret"] = client_secret
+        if client_id:
+            body["clientId"] = client_id
+        if discovery_url:
+            body["discoveryUrl"] = discovery_url
+        if authorization_url:
+            body["authorizationUrl"] = authorization_url
+        if authorization_url_params:
+            body["authorizationUrlParams"] = url_params_to_dict(
+                authorization_url_params
+            )
+        if token_url:
+            body["tokenUrl"] = token_url
+        if token_url_params:
+            body["tokenUrlParams"] = url_params_to_dict(token_url_params)
+        if revocation_url:
+            body["revocationUrl"] = revocation_url
+        if default_scopes:
+            body["defaultScopes"] = default_scopes
+        if default_redirect_url:
+            body["defaultRedirectUrl"] = default_redirect_url
+        if callback_domain:
+            body["callbackDomain"] = callback_domain
+        if pkce is not None:
+            body["pkce"] = pkce
+        if access_type:
+            body["accessType"] = access_type.value
+        if prompt:
+            body["prompt"] = [p.value for p in prompt]
         return body
