Microsoft.PlaywrightTesting.AuthManager (stable:2024-12-01)

2025/01/07 • 6 new methods

Accounts_Get (new)
Description :  Get details of the Azure resource mapped to an account for the given account id. Authorization required is Bearer JWT Access token provided by EntraID.
Reference :  Link ¶

⚼ Request

GET:  /accounts/{accountId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountId:
{
Description: The account id. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: An account is a parent resource for most of the other service resources. It's directly mapped to an Azure resource. ,
}
{
id:
{
Description: The account id. ,
Required: True ,
}
string ,
resourceId:
{
Description: The fully-qualified Azure resource id for the account. ,
Required: True ,
}
string ,
name:
{
Description: The account name. ,
Required: True ,
}
string ,
state:
{
Description: The state of account - Active | Inactive ,
Enum:
{
Active: The account is Active. ,
Inactive: The account is Inactive. ,
}
,
Required: True ,
}
enum ,
subscriptionId:
{
Description: The Azure subscription id for the account. ,
Format: uuid ,
Required: True ,
}
string ,
subscriptionState:
{
Description: The Azure subscription state - Registered | Unregistered | Warned | Suspended | Deleted ,
Enum:
{
Registered: The subscription state is Registered. ,
Warned: The subscription state is Warned. ,
Suspended: The subscription state is Suspended. ,
Deleted: The subscription state is Deleted. ,
Unregistered: The subscription state is Unregistered. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: The Azure tenant id of the account. ,
Format: uuid ,
Required: True ,
}
string ,
location:
{
Description: The account resource location in Azure, for eg. eastus, southeastasia. ,
Required: True ,
}
string ,
regionalAffinity:
{
Description: This property sets the connection region for Playwright client workers to cloud-hosted browsers. If enabled, workers connect to browsers in the closest Azure region, ensuring lower latency. If disabled, workers connect to browsers in the Azure region in which the workspace was initially created. ,
Enum:
{
Enabled: The feature is Enabled. ,
Disabled: The feature is Disabled. ,
}
,
Required: False ,
}
enum ,
scalableExecution:
{
Description: When enabled, Playwright client workers can connect to cloud-hosted browsers. This can increase the number of parallel workers for a test run, significantly minimizing test completion durations. ,
Enum:
{
Enabled: The feature is Enabled. ,
Disabled: The feature is Disabled. ,
}
,
Required: False ,
}
enum ,
reporting:
{
Description: 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. ,
Enum:
{
Enabled: The feature is Enabled. ,
Disabled: The feature is Disabled. ,
}
,
Required: False ,
}
enum ,
localAuth:
{
Description: When enabled, this feature allows the workspace to use local auth (through service access token) for executing operations. ,
Enum:
{
Enabled: The feature is Enabled. ,
Disabled: The feature is Disabled. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AccessTokens_List (new)
Description :  Lists access-tokens for the given account id. It can use OData query params like $select, $filter, $orderby, $top and $skip. The default page size is 10. Use nextLink in response to fetch more objects in the list. Authorization required is Bearer JWT Access token provided by EntraID.
Reference :  Link ¶

⚼ Request

GET:  /accounts/{accountId}/access-tokens
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountId:
{
Description: The account id. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of AccessToken items ,
}
{
value:
{
Description: The AccessToken items on this page ,
Required: True ,
}
[
{
id:
{
Description: The access-token id. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The access-token name. ,
Required: True ,
}
string ,
jwtToken:
{
Description: The access-token value in JWT format. ,
Required: False ,
}
string ,
createdAt:
{
Description: The access-token createdAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
expiryAt:
{
Description: The access-token expiryAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
state:
{
Description: The access-token state - Active | Expired. ,
Enum:
{
Active: The access-token is Active. ,
Expired: The access-token is Expired. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AccessTokens_Get (new)
Description :  Gets an access-token for the account with given access-token id. Authorization required is Bearer JWT Access token provided by EntraID.
Reference :  Link ¶

⚼ Request

GET:  /accounts/{accountId}/access-tokens/{accessTokenId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountId:
{
Description: The account id. ,
Required: True ,
}
string ,
accessTokenId:
{
Description: The access-token id. ,
Format: uuid ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Model of an access-token linked to an account. ,
}
{
id:
{
Description: The access-token id. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The access-token name. ,
Required: True ,
}
string ,
jwtToken:
{
Description: The access-token value in JWT format. ,
Required: False ,
}
string ,
createdAt:
{
Description: The access-token createdAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
expiryAt:
{
Description: The access-token expiryAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
state:
{
Description: The access-token state - Active | Expired. ,
Enum:
{
Active: The access-token is Active. ,
Expired: The access-token is Expired. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AccessTokens_CreateOrReplace (new)
Description :  Creates an access-token for the account with given access-token id. Authorization required is Bearer JWT Access token provided by EntraID.
Reference :  Link ¶

⚼ Request

PUT:  /accounts/{accountId}/access-tokens/{accessTokenId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountId:
{
Description: The account id. ,
Required: True ,
}
string ,
accessTokenId:
{
Description: The access-token id. ,
Format: uuid ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
id:
{
Description: The access-token id. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The access-token name. ,
Required: True ,
}
string ,
jwtToken:
{
Description: The access-token value in JWT format. ,
Required: False ,
}
string ,
createdAt:
{
Description: The access-token createdAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
expiryAt:
{
Description: The access-token expiryAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
state:
{
Description: The access-token state - Active | Expired. ,
Enum:
{
Active: The access-token is Active. ,
Expired: The access-token is Expired. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Model of an access-token linked to an account. ,
}
{
id:
{
Description: The access-token id. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The access-token name. ,
Required: True ,
}
string ,
jwtToken:
{
Description: The access-token value in JWT format. ,
Required: False ,
}
string ,
createdAt:
{
Description: The access-token createdAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
expiryAt:
{
Description: The access-token expiryAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
state:
{
Description: The access-token state - Active | Expired. ,
Enum:
{
Active: The access-token is Active. ,
Expired: The access-token is Expired. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Model of an access-token linked to an account. ,
}
{
id:
{
Description: The access-token id. ,
Format: uuid ,
Required: True ,
}
string ,
name:
{
Description: The access-token name. ,
Required: True ,
}
string ,
jwtToken:
{
Description: The access-token value in JWT format. ,
Required: False ,
}
string ,
createdAt:
{
Description: The access-token createdAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
expiryAt:
{
Description: The access-token expiryAt utcDateTime. ,
Format: date-time ,
Required: True ,
}
string ,
state:
{
Description: The access-token state - Active | Expired. ,
Enum:
{
Active: The access-token is Active. ,
Expired: The access-token is Expired. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
AccessTokens_Delete (new)
Description :  Deletes an access-token for the account with given access-token id. Authorization required is Bearer JWT Access token provided by EntraID.
Reference :  Link ¶

⚼ Request

DELETE:  /accounts/{accountId}/access-tokens/{accessTokenId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountId:
{
Description: The account id. ,
Required: True ,
}
string ,
accessTokenId:
{
Description: The access-token id. ,
Format: uuid ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (204)

{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Accounts_GetBrowsers (new)
Description :  Gets remote browsers corresponding to given account id and redirects the client for running Playwright tests. Authorization required is Bearer JWT Access token provided by EntraID or Microsoft Playwright Testing Service.
Reference :  Link ¶

⚼ Request

GET:  /accounts/{accountId}/browsers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
accountId:
{
Description: The account id. ,
Required: True ,
}
string ,
runId:
{
Description: The run id provided by client for corresponding remote test run. ,
Required: False ,
}
string ,
os:
{
Description: The os provided by client for remote test runs. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (302)

{
location:
{
Description: The redirect target URL to run test on remote browsers. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}