Access Tokens - Get

サービス:

Playwright Testing Service

API バージョン:

2024-12-01

指定されたアクセス トークン ID を持つアカウントのアクセス トークンを取得します。認証が必要なのは、EntraID によって提供される Bearer JWT アクセス トークンです。

GET {endpoint}/accounts/{accountId}/access-tokens/{accessTokenId}?api-version=2024-12-01

URI パラメーター

名前	/	必須	型	説明
accessTokenId	path	True	string (uuid) maxLength: 64 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	アクセス トークン ID。
accountId	path	True	string maxLength: 64 pattern: [A-Za-z0-9]+(_[A-Za-z0-9]+)*(-[A-Za-z0-9]+)+	アカウント ID。
endpoint	path	True	string	サポートされている Azure Playwright Service API エンドポイント (プロトコルとホスト名。例: https://{region}.api.playwright.microsoft.com)。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string (uuid)	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

応答

名前	型	説明
200 OK	AccessToken	要求は成功しました。 ヘッダー x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	予期しないエラー応答。 ヘッダー x-ms-error-code: string

セキュリティ

OAuth2Auth

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize
Token URL (トークン URL): https://login.microsoftonline.com/common/v2.0/oauth2/token

スコープ

名前	説明
https://playwright.microsoft.com/.default

例

AccessTokens_Get

要求のサンプル

HTTP

GET {endpoint}/accounts/sampleAccountId_00000000-0000-0000-0000-000000000000/access-tokens/00000000-0000-0000-0000-000000000000?api-version=2024-12-01

応答のサンプル

状態コード:

200

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "sampleAccessToken",
  "jwtToken": "sampleJwtToken",
  "createdAt": "2021-09-28T12:32:33Z",
  "expiryAt": "2022-09-28T12:32:33Z",
  "state": "Active"
}

定義

名前	説明
AccessToken	アカウントにリンクされたアクセス トークンのモデル。
AccessTokenState	アクセス トークンの状態。
Azure.Core.Foundations.Error	エラー オブジェクト。
Azure.Core.Foundations.ErrorResponse	エラーの詳細を含む応答。
Azure.Core.Foundations.InnerError	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

AccessToken

Object

アカウントにリンクされたアクセス トークンのモデル。

名前	型	説明
createdAt	string (date-time)	access-token createdAt utcDateTime。
expiryAt	string (date-time)	access-token expiryAt utcDateTime。
id	string (uuid) maxLength: 64 pattern: [A-Za-z0-9]+(-[A-Za-z0-9]+)+	アクセス トークン ID。
jwtToken	string	JWT 形式のアクセス トークン値。
name	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z]{1}[a-zA-Z0-9]{2,63}$	アクセス トークン名。
state	AccessTokenState	アクセス トークンの状態 - アクティブ |期限 切れ。

AccessTokenState

列挙

アクセス トークンの状態。

値	説明
Active	アクセス トークンはアクティブです。
Expired	アクセス トークンの有効期限が切れています。

Azure.Core.Foundations.Error

Object

エラー オブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラー コードの 1 つ。
details	Azure.Core.Foundations.Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	Azure.Core.Foundations.InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

Object

エラーの詳細を含む応答。

名前	型	説明
error	Azure.Core.Foundations.Error	エラー オブジェクト。

Azure.Core.Foundations.InnerError

Object

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

名前	型	説明
code	string	サーバー定義の一連のエラー コードの 1 つ。
innererror	Azure.Core.Foundations.InnerError	内部エラー。