コンテンツにスキップ

作成¶

POST /api/v1/workspace/accesskey/add

概要¶

Key を作成します。

Body リクエストパラメータ¶

パラメータ名	型	必須	説明
name	string	Y	AK の名称例: xxx 空文字を許可: False
remark	string		API Key の備考例: テスト環境のデータクエリに使用空文字を許可: False 最大長: 512
roleUUIDs	array		API Key に割り当てるロールのリスト（owner は含まない）空文字を許可: False

パラメータ補足説明¶

*1. リクエストパラメータの説明

パラメータ名	type	必須	説明
name	string	必須	API Key 名
remark	string		API Key の備考
roleUUIDs	array		API Key に割り当てるロールの UUID（owner は含まない。デフォルトは ['wsAdmin']）。2025-03-12 のイテレーションで追加

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/workspace/accesskey/add' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  --data-raw '{"name": "88"}' \
  --compressed \
  --insecure

レスポンス¶

{
    "code": 200,
    "content": {
        "createAt": 1678024319,
        "creator": "xxxx",
        "deleteAt": -1,
        "id": null,
        "name": "88",
        "sk": "xxx",
        "status": 0,
        "updateAt": 1678024319,
        "updator": "xxx",
        "uuid": "xxx",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-A294E29E-33DE-48A5-A379-0BAA1519D256"
}