Hanzo
OpenapiIam

Returns one provider: what it connects to and how it is configured.

Returns one provider: what it connects to and how it is configured.

POST /v1/iam/providers/get

Addresshttps://api.hanzo.ai/v1/iam/providers/get
MethodPOST
OperationgetProvider
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one provider: what it connects to and how it is configured. Its credentials come back masked.

Request

2 fields, body application/json (required).

FieldInTypeRequiredDescription
namebodystringyes
ownerbodystringyes

Response

StatusBodyMeaning
200iam.providerResultok

200 body — 51 fields.

FieldInTypeAlwaysDescription
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 get \
  --name <name> \
  --owner <owner>

IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page