コンテンツにスキップ

取得¶

GET /api/v1/workspace/accesskey/{ak_uuid}/get

概要¶

キーを取得します。

ルートパラメータ¶

パラメータ名	型	必須	説明
ak_uuid	string	Y	ak の UUID

パラメータ補足説明¶

作成APIは、新しいAPI Keyの平文 ak/sk を返します。本APIのOpenAPI API Keyがownerロールを持つ場合、読み取りAPIはワークスペースのAPI Keyの平文 ak/sk を返します。ownerロール以外で呼び出した場合、現在の呼び出し資格情報に対応するワークスペースのAPI Keyレコードのみ平文 ak/sk を返し、その他のレコードは後ろ4桁のみを残してマスクされた ak/sk を返します。このルールは個人用API Keyには適用されません。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/workspace/accesskey/wsak_xxxxx/get' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "createAt": 1677808718,
        "creator": "acnt_xxxx32",
        "creatorInfo": {
            "email": "xxx@guance.com",
            "iconUrl": "",
            "name": "88Test",
            "username": "Test"
        },
        "deleteAt": -1,
        "id": 4,
        "name": "test",
        "sk": "xxxx",
        "status": 0,
        "updateAt": 1677808718,
        "updator": "acnt_xxxx32",
        "uuid": "wsak_xxxxx",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-652BF56F-67F6-4A08-AF35-2BDFDCF12D89"
}