POST `/admin/tenants/{tenant_id}/api-keys`

Create an API Key for a tenant, returning the full key (shown only once). For external system integration. Reference: NIST SP 800-53 AC-2 (Account Management).

Tenant Service `bearerAuth` application/json

Request Parameters

Name	In	Type	Required	Default	Example	Constraints	Description
`id`	`path`	`string`	Yes				Tenant ID

Request Body

Schema: dto.CreateApiKeyRequest

Field	Type	Required	Example	Constraints	Description
`name`	`string`	Yes	`HR system sync`
`scope`	`string`	No	`admin`

Responses

Status	Description	Schema
201	API Key created successfully	`dto.DataResponse-dto_CreateApiKeyResponse`
400	Invalid request parameters	`gitee_com_linmes_authms_base_dto.SimpleResponse`
401	Unauthenticated	`gitee_com_linmes_authms_base_dto.SimpleResponse`
403	Insufficient permissions	`gitee_com_linmes_authms_base_dto.SimpleResponse`
409	API Key name conflict	`gitee_com_linmes_authms_base_dto.SimpleResponse`
500	Internal server error	`gitee_com_linmes_authms_base_dto.SimpleResponse`

Referenced Schemas

dto.CreateApiKeyResponse

Field	Type	Required	Example
`api_key`	`string`	No	`tk_a1b2c3d4e5f6...`
`created_at`	`string`	No	`2026-05-12T10:00:00Z`
`id`	`string`	No	`tak_001`
`key_prefix`	`string`	No	`tk_a1b2c3d4`
`message`	`string`	No	`Please save the API Key immediately; it cannot be viewed again after closing`
`name`	`string`	No	`HR system sync`
`scope`	`string`	No	`admin`

dto.DataResponse-dto_CreateApiKeyResponse

Field	Type	Required
`code`	`integer`	No
`data`	`dto.CreateApiKeyResponse`	No
`message`	`string`	No
`timestamp`	`string`	No

gitee_com_linmes_authms_base_dto.SimpleResponse

Field	Type	Required
`code`	`integer`	No
`message`	`string`	No
`timestamp`	`string`	No

Try this API in Scalar → Download OpenAPI spec (JSON) ↓

POST /admin/tenants/{tenant_id}/api-keys