Skip to content

Rotate a connection's client secret

POST
/api/v1/tenants/{tenantId}/identity/providers/{providerId}/client-secret
curl --request POST \
--url https://app.avera.io/api/v1/tenants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/identity/providers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/client-secret \
--header 'Content-Type: application/json' \
--data '{ "clientSecret": "example" }'

Replaces the secret in place, keeping the connection’s id and its routing.

tenantId
required
string format: uuid
providerId
required
string format: uuid
Media typeapplication/json
object
clientSecret
required
string

Example generated

{
"clientSecret": "example"
}

OK

Media type*/*
object
id
required
string format: uuid
tenantId
required
string format: uuid
connectionId
required
string
connectionType
required
string
displayName
required
string
allowedDomains
required
Array<string>
status
required
string
createdAt
required
string format: date-time
lastSyncAt
string | null format: date-time
lastTestedAt
string | null format: date-time
issuer
required
string
clientId
required
string
hasClientSecret
required
boolean
scopes
required
Array<string>
extraAuthorizationParams
required
object
key
additional properties
string
requiredClaims
required
object
key
additional properties
string