Skip to content

Replaces the subscription's auth credential, returning the old hint (the new cleartext is never returned — it is supplied by the caller).

POST
/v1/m/eventing/subscriptions/{id}/rotate-auth
curl --request POST \
--url https://example.com/v1/m/eventing/subscriptions/example/rotate-auth \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "auth_value": "example" }'

Replaces the subscription’s auth credential, returning the old hint (the new cleartext is never returned — it is supplied by the caller).

id
required
string

Path parameter id.

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Media type application/json
object
auth_value
required
string
>= 1 characters <= 2048 characters
Example generated
{
"auth_value": "example"
}

OK

Media type application/json
object
Example generated
{}

Bad request

Media type application/json
object
Example generated
{}

Unauthenticated

Media type application/json
object
Example generated
{}

Forbidden

Media type application/json
object
Example generated
{}

Not found

Media type application/json
object
Example generated
{}

Conflict / setup required

Media type application/json
object
Example generated
{}

Rate limited

Media type application/json
object
Example generated
{}