Hanzo
OpenapiIam

Changes a provider's settings or rotates the credentials it holds.

Changes a provider's settings or rotates the credentials it holds.

POST /v1/iam/providers/update

Addresshttps://api.hanzo.ai/v1/iam/providers/update
MethodPOST
OperationupdateProvider
AuthAuthorization: Bearer $HANZO_API_KEY

Changes a provider's settings or rotates the credentials it holds. The change takes effect on the next sign-in through it — sessions already issued are unaffected.

A provider that is not there answers "nothing changed" rather than an error, so the call is safe to repeat.

Request

50 fields, body application/json (required).

FieldInTypeRequiredDescription
appIdbodystring
bucketbodystring
categorybodystring
certbodystring
clientIdbodystring
clientId2bodystring
clientSecretbodystring
clientSecret2bodystring
contentbodystring
createdAtbodystring (date-time)
createdTimebodystring
customAuthUrlbodystring
customLogobodystring
customTokenUrlbodystring
customUserInfoUrlbodystring
deletedbodyboolean
disableSslbodyboolean
displayNamebodystring
domainbodystring
emailRegexbodystring
enablePkcebodyboolean
enableProxybodyboolean
enableSignAuthnRequestbodyboolean
endpointbodystring
hostbodystring
httpHeadersbodyobject
httpHeaders.*bodystring
idbodystring
idPbodystring
intranetEndpointbodystring
issuerUrlbodystring
metadatabodystring
methodbodystring
namebodystring
ownerbodystring
pathPrefixbodystring
portbodyinteger
providerUrlbodystring
receiverbodystring
regionIdbodystring
scopesbodystring
signNamebodystring
sslModebodystring
subTypebodystring
templateCodebodystring
titlebodystring
typebodystring
updatedAtbodystring (date-time)
userMappingbodyobject
userMapping.*bodystring

Response

StatusBodyMeaning
200iam.mutationResultok

200 body — 52 fields.

FieldInTypeAlwaysDescription
affectedbodyboolean
providerbodyiam.Provider
provider.appIdbodystring
provider.bucketbodystring
provider.categorybodystring
provider.certbodystring
provider.clientIdbodystring
provider.clientId2bodystring
provider.clientSecretbodystring
provider.clientSecret2bodystring
provider.contentbodystring
provider.createdAtbodystring (date-time)
provider.createdTimebodystring
provider.customAuthUrlbodystring
provider.customLogobodystring
provider.customTokenUrlbodystring
provider.customUserInfoUrlbodystring
provider.deletedbodyboolean
provider.disableSslbodyboolean
provider.displayNamebodystring
provider.domainbodystring
provider.emailRegexbodystring
provider.enablePkcebodyboolean
provider.enableProxybodyboolean
provider.enableSignAuthnRequestbodyboolean
provider.endpointbodystring
provider.hostbodystring
provider.httpHeadersbodyobject
provider.httpHeaders.*bodystring
provider.idbodystring
provider.idPbodystring
provider.intranetEndpointbodystring
provider.issuerUrlbodystring
provider.metadatabodystring
provider.methodbodystring
provider.namebodystring
provider.ownerbodystring
provider.pathPrefixbodystring
provider.portbodyinteger
provider.providerUrlbodystring
provider.receiverbodystring
provider.regionIdbodystring
provider.scopesbodystring
provider.signNamebodystring
provider.sslModebodystring
provider.subTypebodystring
provider.templateCodebodystring
provider.titlebodystring
provider.typebodystring
provider.updatedAtbodystring (date-time)
provider.userMappingbodyobject
provider.userMapping.*bodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo iam providers update

IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page