Removes a provider.

Removes a provider. Sign-in through it stops for every application that used it, so give those applications another method first.

POST /v1/iam/providers/delete

IAM → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/iam/providers/delete`
Method	`POST`
Operation	`deleteProvider`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Removes a provider. Sign-in through it stops for every application that used it, so give those applications another method first.

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

Request

2 fields, body application/json (required).

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

Response

Status	Body	Meaning
`200`	iam.mutationResult	ok

200 body — 52 fields.

Field	In	Type	Always
`affected`	body	boolean	—
`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	—
`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

hanzo iam providers delete \
  --name <name> \
  --owner <owner>

import { Configuration, IamApi } from 'hanzoai';

const api = new IamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.deleteProvider({ 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).delete_provider(owner="<owner>", name="<name>")

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

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

use hanzo_cloud::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::delete_provider(&cfg, Default::default()).await?;

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

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

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

curl -X POST https://api.hanzo.ai/v1/iam/providers/delete \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "owner": "<owner>",
       "name": "<name>"
     }'

Tool iam, op deleteProvider — 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": "deleteProvider",
           "input": {
             "owner": "<owner>",
             "name": "<name>"
           }
         }
       }
     }'

IAM API · All Hanzo APIs · Interactive reference

Request

Response

Examples

On this page