メインコンテンツへスキップ
GET
Get Virtual Key

承認

Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

パスパラメータ

workspace_id
string<uuid>
必須

Workspace identifier (UUID).

project_id
string<uuid>
必須

Project identifier (UUID).

virtual_key_id
string<uuid>
必須

Virtual key identifier (UUID).

レスポンス

OK

virtual_key_id
string<uuid>

Virtual key identifier.

last_four
string

The last four characters of the virtual key. Use it to identify a key. The full secret is never returned after creation.

name
string | null

Display name of the virtual key.

key_type
enum<string>

The type of identity the key is issued to.

利用可能なオプション:
user,
service_account
user_id
string<uuid> | null

The user the key is issued to. null when key_type is service_account.

service_account_id
string<uuid> | null

The service account the key is issued to. null when key_type is user.

workspace_id
string<uuid>

The workspace the key belongs to.

project_id
string<uuid>

The project the key is issued for.

status
enum<string>

Current state of the key. Revoked is permanent.

利用可能なオプション:
active,
disabled,
revoked
created_at
string<date-time>

ISO 8601 UTC.

created_by
string<uuid>

ID of the caller that created the key.

revoked_at
string<date-time> | null

ISO 8601 UTC. null unless the key is revoked.

revoked_by
string<uuid> | null

ID of the caller that revoked the key. null unless the key is revoked.

最終更新日 2026年11月6日