Release playwrighttesting microsoft.playwright testing.auth manager 2024 12 01

specification/playwrighttesting/PlaywrightTesting.AuthManager/examples/2024-12-01/AccessTokens_Create.json

@@ -0,0 +1,36 @@
+{
+  "title": "AccessTokens_Create",
+  "operationId": "AccessTokens_Create",
+  "parameters": {
+    "api-version": "2024-12-01",
+    "accountId": "sampleAccountId",
+    "accessTokenId": "00000000-0000-0000-0000-000000000000",
+    "resource": {
+      "id": "00000000-0000-0000-0000-000000000000",
+      "name": "sampleAccessToken",
+      "expiryAt": "2022-09-28T12:32:33Z"
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "00000000-0000-0000-0000-000000000000",
+        "name": "sampleAccessToken",
+        "jwtToken": "sampleJwtToken",
+        "createdAt": "2021-09-28T12:32:33Z",
+        "expiryAt": "2022-09-28T12:32:33Z",
+        "state": "Active"
+      }
+    },
+    "201": {
+      "body": {
+        "id": "00000000-0000-0000-0000-000000000000",
+        "name": "sampleAccessToken",
+        "jwtToken": "sampleJwtToken",
+        "createdAt": "2021-09-28T12:32:33Z",
+        "expiryAt": "2022-09-28T12:32:33Z",
+        "state": "Active"
+      }
+    }
+  }
+}

specification/playwrighttesting/PlaywrightTesting.AuthManager/examples/2024-12-01/AccessTokens_Delete.json

@@ -0,0 +1,12 @@
+{
+  "title": "AccessTokens_Delete",
+  "operationId": "AccessTokens_Delete",
+  "parameters": {
+    "api-version": "2024-12-01",
+    "accountId": "sampleAccountId",
+    "accessTokenId": "00000000-0000-0000-0000-000000000000"
+  },
+  "responses": {
+    "204": {}
+  }
+}

specification/playwrighttesting/PlaywrightTesting.AuthManager/examples/2024-12-01/AccessTokens_Get.json

@@ -0,0 +1,21 @@
+{
+  "title": "AccessTokens_Get",
+  "operationId": "AccessTokens_Get",
+  "parameters": {
+    "api-version": "2024-12-01",
+    "accountId": "sampleAccountId",
+    "accessTokenId": "00000000-0000-0000-0000-000000000000"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "00000000-0000-0000-0000-000000000000",
+        "name": "sampleAccessToken",
+        "jwtToken": "sampleJwtToken",
+        "createdAt": "2021-09-28T12:32:33Z",
+        "expiryAt": "2022-09-28T12:32:33Z",
+        "state": "Active"
+      }
+    }
+  }
+}

specification/playwrighttesting/PlaywrightTesting.AuthManager/examples/2024-12-01/AccessTokens_List.json

@@ -0,0 +1,25 @@
+{
+  "title": "AccessTokens_List",
+  "operationId": "AccessTokens_List",
+  "parameters": {
+    "api-version": "2024-12-01",
+    "accountId": "sampleAccountId"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "id": "00000000-0000-0000-0000-000000000000",
+            "name": "sampleAccessToken",
+            "jwtToken": "sampleJwtToken",
+            "createdAt": "2021-09-28T12:32:33Z",
+            "expiryAt": "2022-09-28T12:32:33Z",
+            "state": "Active"
+          }
+        ],
+        "nextLink": null
+      }
+    }
+  }
+}

specification/playwrighttesting/PlaywrightTesting.AuthManager/examples/2024-12-01/AccessTokens_Validate.json

@@ -0,0 +1,11 @@
+{
+  "title": "AccessTokens_Validate",
+  "operationId": "AccessTokens_Validate",
+  "parameters": {
+    "api-version": "2024-12-01",
+    "accountId": "sampleAccountId"
+  },
+  "responses": {
+    "200": {}
+  }
+}

specification/playwrighttesting/PlaywrightTesting.AuthManager/examples/2024-12-01/Accounts_Get.json

@@ -0,0 +1,26 @@
+{
+  "title": "Accounts_Get",
+  "operationId": "Accounts_Get",
+  "parameters": {
+    "api-version": "2024-12-01",
+    "accountId": "sampleAccountId"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "id": "sampleAccountId",
+        "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/dummyrg/providers/Microsoft.AzurePlaywrightService/accounts/myPlaywrightAccount",
+        "name": "myPlaywrightAccount",
+        "state": "Active",
+        "subscriptionId": "00000000-0000-0000-0000-000000000000",
+        "subscriptionState": "Registered",
+        "tenantId": "00000000-0000-0000-0000-000000000000",
+        "location": "westus",
+        "regionalAffinity": "Enabled",
+        "scalableExecution": "Enabled",
+        "reporting": "Disabled",
+        "localAuth": "Enabled"
+      }
+    }
+  }
+}

specification/playwrighttesting/PlaywrightTesting.AuthManager/examples/2024-12-01/Accounts_GetBrowsers.json

@@ -0,0 +1,16 @@
+{
+  "title": "Accounts_GetBrowsers",
+  "operationId": "Accounts_GetBrowsers",
+  "parameters": {
+    "api-version": "2024-12-01",
+    "accountId": "sampleAccountId",
+    "os": "linux"
+  },
+  "responses": {
+    "302": {
+      "headers": {
+        "location": "wss://{region}.api.playwright.microsoft.com/redirectURL?api-version=2024-12-01&os=linux"
+      }
+    }
+  }
+}

specification/playwrighttesting/PlaywrightTesting/main.tsp → specification/playwrighttesting/PlaywrightTesting.AuthManager/main.tsp

@@ -15,16 +15,23 @@ using Azure.Core.Traits;
 using Autorest;
 
 @server(
-  "https://api.playwright-int.io",
-  "Azure Playwright Service API Endpoint"
+  "{endpoint}",
+  "Microsoft Azure Playwright Service API Endpoint",
+  {
+    @doc("""
+Supported Azure Playwright Service API Endpoints (protocol and hostname, for example:
+  https://{region}.api.playwright.microsoft.com).
+""")
+    endpoint: string,
+  }
 )
 @useAuth(
   [
     OAuth2Auth<[
       {
         type: OAuth2FlowType.implicit,
         authorizationUrl: "https://login.microsoftonline.com/common/oauth2/authorize",
-        scopes: ["https://preview.playwright-int.io/.default"],
+        scopes: ["https://playwright.microsoft.com/.default"],
       }
     ]>
   ]
@@ -37,22 +44,22 @@ namespace Microsoft.PlaywrightTesting.AuthManager;
 
 @doc("The PlaywrightTesting Auth Manager service version.")
 enum Versions {
-  @doc("Version 2023-10-01-preview")
+  @doc("Version 2024-12-01")
   @useDependency(Azure.Core.Versions.v1_0_Preview_2)
-  `2023-10-01-preview`,
+  `2024-12-01`,
 }
 
 // Models ////////////////////
 
-@doc("An account is a parent resource for most of the other service resources. It's directly mapped to an ARM resource and helps to create a link between control-plane and data-plane resources.")
+@doc("An account is a parent resource for most of the other service resources. It's directly mapped to an Azure resource.")
 @resource("accounts")
 model Account {
   @key("accountId")
   @doc("The account id.")
   @visibility("read")
   id: string;
 
-  @doc("The ARM fully-qualified resource id for the account.")
+  @doc("The fully-qualified Azure resource id for the account.")
   @visibility("read")
   resourceId: string;
 
@@ -64,19 +71,19 @@ model Account {
   @visibility("read")
   state: AccountState;
 
-  @doc("The ARM-based subscription id for the account.")
+  @doc("The Azure subscription id for the account.")
   @visibility("read")
   subscriptionId: uuid;
 
-  @doc("The ARM-based subscription state - Registered | Unregistered | Warned | Suspended | Deleted")
+  @doc("The Azure subscription state - Registered | Unregistered | Warned | Suspended | Deleted")
   @visibility("read")
   subscriptionState: SubscriptionState;
 
   @doc("The Azure tenant id of the account.")
   @visibility("read")
   tenantId: uuid;
 
-  @doc("The account resource ARM location, for eg. eastus, southeastasia.")
+  @doc("The account resource location in Azure, for eg. eastus, southeastasia.")
   @visibility("read")
   location: string;
 
@@ -90,7 +97,11 @@ model Account {
 
   @doc("When enabled, this feature allows the workspace to upload and display test results, including artifacts like traces and screenshots, in the Playwright portal. This enables faster and more efficient troubleshooting.")
   @visibility("read")
-  reporting?: EnablementStatus = EnablementStatus.Disabled;
+  reporting?: EnablementStatus = EnablementStatus.Enabled;
+
+  @doc("When enabled, this feature allows the workspace to use local auth (through service access token) for executing operations.")
+  @visibility("read")
+  localAuth?: EnablementStatus = EnablementStatus.Disabled;
 }
 
 @doc("The account state.")
@@ -104,7 +115,7 @@ union AccountState {
   "Inactive",
 }
 
-@doc("The ARM-based subscription state.")
+@doc("The Azure subscription state.")
 union SubscriptionState {
   string,
 
@@ -146,26 +157,26 @@ model AccessToken {
 
   @doc("The access-token createdAt utcDateTime.")
   @visibility("read")
-  createdAt?: utcDateTime;
+  createdAt: utcDateTime;
 
   @doc("The access-token expiryAt utcDateTime.")
   @visibility("read", "create")
   expiryAt: utcDateTime;
 
   @doc("The access-token state - Active | Expired.")
   @visibility("read")
-  state?: AccessTokenState;
+  state: AccessTokenState;
 }
 
 @doc("The access-token state.")
 union AccessTokenState {
   string,
 
   @doc("The access-token is Active.")
-  "Active",
+  Active: "Active",
 
   @doc("The access-token is Expired.")
-  "Expired",
+  Expired: "Expired",
 }
 
 @doc("The enablement status of a feature.")
@@ -179,6 +190,17 @@ union EnablementStatus {
   Disabled: "Disabled",
 }
 
+@doc("The os to configure for remote test runs.")
+union OS {
+  string,
+
+  @doc("Linux OS.")
+  Linux: "linux",
+
+  @doc("Windows OS.")
+  Windows: "windows",
+}
+
 // Operations ////////////////////
 
 alias ServiceTraits = NoRepeatableRequests &
@@ -189,23 +211,66 @@ alias Operations = Azure.Core.ResourceOperations<ServiceTraits>;
 
 interface AccessTokens {
   // AccessToken Operations
+  // #suppress "@azure-tools/typespec-azure-core/use-standard-names" "Existing name"
+  @doc("Creates an access-token for the account with given access-token id. Authorization required is Bearer JWT Access token provided by EntraID.")
+  @Autorest.example("./AccessTokens_Create.json", "AccessTokens_Create")
+  create is Operations.ResourceCreateOrReplace<AccessToken>;
+
+  @doc("Gets an access-token for the account with given access-token id. Authorization required is Bearer JWT Access token provided by EntraID.")
+  @Autorest.example("./AccessTokens_Get.json", "AccessTokens_Get")
+  get is Operations.ResourceRead<AccessToken>;
+
+  @doc("Deletes an access-token for the account with given access-token id. Authorization required is Bearer JWT Access token provided by EntraID.")
+  @Autorest.example("./AccessTokens_Delete.json", "AccessTokens_Delete")
+  delete is Operations.ResourceDelete<AccessToken>;
+
+  @doc("Lists access-tokens for the given account id. Authorization required is Bearer JWT Access token provided by EntraID.")
+  @Autorest.example("./AccessTokens_List.json", "AccessTokens_List")
+  list is Operations.ResourceList<AccessToken>;
+
+  @doc("Validates access-token provided in authorization header for the given account id. Authorization required is Bearer JWT Access token provided by MPT service.")
+  @Autorest.example("./AccessTokens_Validate.json", "AccessTokens_Validate")
+  @actionSeparator("/")
+  validate is Operations.ResourceCollectionAction<AccessToken, {}, {}>;
+}
+
+alias GetBrowsersParams = {
+  @query
+  @doc("The run id provided by client for corresponding remote test run.")
+  runId?: string;
 
-  #suppress "@azure-tools/typespec-azure-core/use-standard-names" "Existing name"
-  @doc("Creates an access-token with given access-token id in guid format.")
-  createAccessToken is Operations.ResourceCreateOrReplace<AccessToken>;
+  @query
+  @doc("The os provided by client for remote test runs.")
+  os?: OS = OS.Linux;
 
-  @doc("Get an access-token for given access-token id in guid format.")
-  getAccessToken is Operations.ResourceRead<AccessToken>;
+  @path
+  @doc("The account id.")
+  accountId: string;
+};
 
-  @doc("Revoke an access-token with given access-token id in guid format.")
-  deleteAccessToken is Operations.ResourceDelete<AccessToken>;
+alias GetBrowsersResponse = {
+  @statusCode
+  _: 302;
 
-  @doc("List access-tokens for a given accountId.")
-  listAccessTokens is Operations.ResourceList<AccessToken>;
-}
+  @header
+  @doc("The redirect target URL to run test on remote browsers.")
+  location: url;
+};
 
 interface Accounts {
   // Accounts Operations
-  @doc("Get details of the ARM resource mapped to an account for the given accountId.")
-  getAccount is Operations.ResourceRead<Account>;
+
+  @doc("Get details of the Azure resource mapped to an account for the given accountId. Authorization required is Bearer JWT Access token provided by EntraID.")
+  @Autorest.example("./Accounts_Get.json", "Accounts_Get")
+  get is Operations.ResourceRead<Account>;
+
+  #suppress "@azure-tools/typespec-azure-core/no-rpc-path-params" "Operations defined using RpcOperation should not have path parameters. Consider using ResourceAction or ResourceCollectionAction instead."
+  @doc("Gets remote browsers corresponding to given accountId and redirects the client for running MPT tests. Authorization required is Bearer JWT Access token provided by EntraID or MPT Service.")
+  @Autorest.example("./Accounts_GetBrowsers.json", "Accounts_GetBrowsers")
+  @route("/accounts/{accountId}/browsers")
+  getBrowsers is RpcOperation<
+    GetBrowsersParams,
+    GetBrowsersResponse,
+    ServiceTraits
+  >;
 }