Tenants

Rotate tenant OAuth client secret

Rotate a tenant OAuth client secret and return the new credentials.

post/v2/{tenant_slug}/tenants/rotate-auth-secret

Request

Base URL
https://api.demo-retail.urbanfox.io
Auth
OAuth 2
Client credentials
Token URLhttps://api.demo-retail.urbanfox.io/v2/oauth/token
Scopesupdate:tenant_auth_secret
TypeScript
https://skmtc.dev/urbanfox/apis/urbanfox-customer-api/docs/v2/:tenant_slug/tenants/rotate-auth-secret/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

tenant_slugstring required

Tenant DNS slug (lowercase letters, digits, and hyphens; 3-100 characters).

Example:demo-retail

Response

Successful Response

Example response

{
  "data": {
    "client_id": "A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6",
    "client_secret": "csec_example_9v1t0r8p6m4k2xq7y5w3"
  }
}

Changes

No recorded changes to this operation across all 8 revisions of this API.