Get providers

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

GET /v1/iam/providers/{owner}/{name}

IAM → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/iam/providers/{owner}/{name}`
Method	`GET`
Operation	`getProvider`
Auth	`Authorization: Bearer $HANZO_API_KEY`

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

Request

2 fields.

Field	In	Type	Required	Description
`owner`	path	string	yes
`name`	path	string	yes

Response

Status	Body	Meaning
`200`	iam.providerResult	ok
`202`	Approval	held for approval
`default`	problem-details	refused

200 body — 51 fields.

Field	In	Type	Always
`provider`	body	iam.Provider	—
`provider.appId`	body	string	—
`provider.bucket`	body	string	—
`provider.category`	body	string	—
`provider.cert`	body	string	—
`provider.clientId`	body	string	—
`provider.clientId2`	body	string	—
`provider.clientSecret`	body	string	—
`provider.clientSecret2`	body	string	—
`provider.content`	body	string	—
`provider.createdAt`	body	string (date-time)	—
`provider.createdTime`	body	string	—
`provider.customAuthUrl`	body	string	—
`provider.customLogo`	body	string	—
`provider.customTokenUrl`	body	string	—
`provider.customUserInfoUrl`	body	string	—
`provider.deleted`	body	boolean	—
`provider.disableSsl`	body	boolean	—
`provider.displayName`	body	string	—
`provider.domain`	body	string	—
`provider.emailRegex`	body	string	—
`provider.enablePkce`	body	boolean	—
`provider.enableProxy`	body	boolean	—
`provider.enableSignAuthnRequest`	body	boolean	—
`provider.endpoint`	body	string	—
`provider.host`	body	string	—
`provider.httpHeaders`	body	object	—
`provider.httpHeaders.*`	body	string	—
`provider.id`	body	string	—
`provider.idP`	body	string	—
`provider.intranetEndpoint`	body	string	—
`provider.issuerUrl`	body	string	—
`provider.metadata`	body	string	—
`provider.method`	body	string	—
`provider.name`	body	string	—
`provider.owner`	body	string	—
`provider.pathPrefix`	body	string	—
`provider.port`	body	integer (int64)	—
`provider.providerUrl`	body	string	—
`provider.receiver`	body	string	—
`provider.regionId`	body	string	—
`provider.scopes`	body	string	—
`provider.signName`	body	string	—
`provider.sslMode`	body	string	—
`provider.subType`	body	string	—
`provider.templateCode`	body	string	—
`provider.title`	body	string	—
`provider.type`	body	string	—
`provider.updatedAt`	body	string (date-time)	—
`provider.userMapping`	body	object	—
`provider.userMapping.*`	body	string	—

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo iam providers owner get <owner> <name>

.ts

.py

.go

.rs

.java

import { Configuration, IamApi } from 'hanzoai';

const api = new IamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getProvider({ owner: 'owner', name: 'name' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import IamApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = IamApi(client).get_provider(owner='owner', name='name')

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.IamAPI.GetProvider(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, iam_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = iam_api::get_provider(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.IamApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new IamApi(client).getProvider();

curl https://api.hanzo.ai/v1/iam/providers/<owner>/<name> \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool iam, op getProvider — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "iam",
         "arguments": {
           "op": "getProvider",
           "input": {
             "owner": "<owner>",
             "name": "<name>"
           }
         }
       }
     }'

IAM API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousGet tombstones NextGet sessions