Regenerate Client Secret

Regenerate the client secret of the OpenAPI configuration.

Note: To change client secret, perform the following operations:
  1. Call this interface to generate a new client secret.

    The new secret is returned in plaintext only once and is temporarily stored.

  2. Call the Update API Setting interface before the temporary storage period expires to save the new secret.

Request URL

POST {base_url}/uc-user/api/v1/system/api-config/secret/regenerate

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.

x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.

result Object<Secret_Info> The client secret information.
Secret_Info
Parameter Type Description
clientId String The client ID.
clientSecret String The newly generated client secret in plaintext.
pendingSecretExpireAt Integer The expiration time of the temporarily stored secret, in Unix timestamp format (milliseconds).

Example

Request example

POST /uc-user/api/v1/system/api-config/secret/regenerate HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIxMDAwQGNvbG9ydGVzdDIiLCJncmFudF90eXBlIjoicGFzc3dvcmQiLCJ1c2VyX25hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJzY29wZSI6WyJyZWFkIiwid3JpdGUiXSwiY2xpZW50X2V4dCI6eyJkZXNjcmlwdGlvbiI6IueuoeeQhuWQjuWPsFdlYuW6lOeUqCIsInBsYXRmb3JtIjoid2ViIn0sImV4cCI6MTc5MzYyNzk4MSwiaWF0IjoxNzkzNjA2MzgxLCJqdGkiOiIyNDZmMmI1ZC01NWJiLTRiYjktOGVkNS0wY2JjNzcyZDgzZjciLCJjbGllbnRfaWQiOiJub3ZvLWFkbWluLXdlYiIsInNpZCI6ImZiOWIxMTMxLWRjMDEtNGEwOS05MzczLTgyYWRkOTQwY2RkZSIsInVzZXJfZXh0Ijp7InJvbGVJZHMiOlsxMDJdLCJwdWlkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJ0ZW5hbnRJZCI6MjA3OTUwNDIwNTMwOTE5NDI0MSwicGFyZW50VWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5NiwidGVuYW50Q29kZSI6ImNvbG9ydGVzdDIiLCJ0eXBlIjoiVF9VU0VSIiwidXNlcklkIjoyMDc5NzQ2OTE1Mzg4MDc2MDMzLCJlbWFpbCI6Imxlb0BzYW1wbGUuY29tIiwidXNlcm5hbWUiOiIxMDAwQGNvbG9ydGVzdDIiLCJ1Y0lkIjozMDc2OTEzNjQ0ODkwODMyODk2fX0.RGyn2te1jfOoFX6QcDflVGktFOo07aqDlDmW2pGQVVUeX-D1B1ZbAvJi66RPE74KqT1IiQWT1ghIsaYXA3TwJFBvU8g77iOGPkFeglRjP3dst8fBbzOXf_oiF7URHKKRi92lFFsvRGVnO-FJJgnVatI3vbpkhyIjBHTxa7MNFLX4Kucn79DmCUAeoFMlA22FkavqAOhteg3H3kMy0r0ndP9qX0x2SMQKj1mwoCyrdDnlW-7zJGZV6iNX-qrhOEE43NQhb46UIZSYk6bsyOyttxv2RVj6B2uysTr43b2WAwKwp_-ItnoxMuNHeVmiHFcG7nblVQOI3a-yEWIP6DdrzA
Content-Type: application/json

Response example

HTTP/1.1 200 OK
{
    "result": {
        "clientId": "abcdTIgufBywvB6atUDfT6ix2oRXToL3",
        "clientSecret": "Qo12atdEi5FdQxsnqRQNYPr26DzyBVO6R",
        "pendingSecretExpireAt": 1793619433614
    },
    "requestId": "7cadba3cccee630427161c95a58294e9",
    "code": "200",
    "message": "SUCCESS"
}