Returns one person in your organization, addressed by their username or by…

Returns one person in your organization, addressed by their username or by their email address.

GET /v1/iam/users/get

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


Address	`https://api.hanzo.ai/v1/iam/users/get`
Method	`GET`
Operation	`get_iam_users_get`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Returns one person in your organization, addressed by their username or by their email address. Passwords, API secrets and MFA material are stripped from the response.

An address that names two accounts names none: the read refuses rather than picking one, and says so instead of reporting "no such user". Handing back an arbitrary one of two rows is how somebody gets added to a team under a colleague's identity.

Request

3 fields.

Field	In	Type	Required
`owner`	query	string	yes
`name`	query	string	—
`email`	query	string	—

Response

Status	Body	Meaning
`200`	iam.User	ok

200 body — 257 fields.

Field	In	Type	Always	Description
`accessKey`	body	string	—	API credentials. AccessSecret / AccessSecretHash / the OAuth tokens are bearer material.
`accessSecret`	body	string	—
`accessSecretHash`	body	string	—
`accessToken`	body	string	—
`address`	body	string[]	—
`addresses`	body	iam.Address[]	—
`addresses[].city`	body	string	—
`addresses[].line1`	body	string	—
`addresses[].line2`	body	string	—
`addresses[].region`	body	string	—
`addresses[].state`	body	string	—
`addresses[].tag`	body	string	—
`addresses[].zipCode`	body	string	—
`adfs`	body	string	—
`affiliation`	body	string	—
`alipay`	body	string	—
`amazon`	body	string	—
`apple`	body	string	—
`applicationScopes`	body	iam.ConsentRecord[]	—
`applicationScopes[].application`	body	string	—
`applicationScopes[].grantedScopes`	body	string[]	—
`auth0`	body	string	—
`avatar`	body	string	—
`avatarType`	body	string	—
`azuread`	body	string	—
`azureadb2c`	body	string	—
`baidu`	body	string	—
`balance`	body	number	—	Balance mirrors v1 for lossless migration but is authoritative in Commerce (billing.hanzo.ai), not here — do not write it from IAM.
`balanceCredit`	body	number	—
`balanceCurrency`	body	string	—
`battlenet`	body	string	—
`bilibili`	body	string	—
`bio`	body	string	—
`birthday`	body	string	—
`bitbucket`	body	string	—
`box`	body	string	—
`cart`	body	iam.CartItem[]	—
`cart[].displayName`	body	string	—
`cart[].name`	body	string	—
`cart[].owner`	body	string	—
`cart[].price`	body	number	—
`cart[].quantity`	body	integer	—
`cloudfoundry`	body	string	—
`countryCode`	body	string	—
`createdAt`	body	string (date-time)	—
`createdIp`	body	string	—	Sign-in provenance.
`createdTime`	body	string	—
`currency`	body	string	—
`custom`	body	string	—
`custom2`	body	string	—
`custom3`	body	string	—
`custom4`	body	string	—
`custom5`	body	string	—
`custom6`	body	string	—
`custom7`	body	string	—
`custom8`	body	string	—
`custom9`	body	string	—
`custom10`	body	string	—
`dailymotion`	body	string	—
`deezer`	body	string	—
`deleted`	body	boolean	—
`deletedTime`	body	string	—
`digitalocean`	body	string	—
`dingtalk`	body	string	—
`discord`	body	string	—
`displayName`	body	string	—	Profile.
`douyin`	body	string	—
`dropbox`	body	string	—
`education`	body	string	—
`email`	body	string	—
`emailVerified`	body	boolean	—
`eveonline`	body	string	—
`externalId`	body	string	—
`faceIds`	body	iam.FaceId[]	—
`faceIds[].faceIdData`	body	number[]	—
`faceIds[].imageUrl`	body	string	—
`faceIds[].name`	body	string	—
`facebook`	body	string	—
`firstName`	body	string	—
`fitbit`	body	string	—
`gender`	body	string	—
`gitea`	body	string	—
`gitee`	body	string	—
`github`	body	string	—	Linked federated-identity subjects, one column per connector (v1 parity).
`gitlab`	body	string	—
`google`	body	string	—
`groups`	body	string[]	—
`hash`	body	string	—
`heroku`	body	string	—
`homepage`	body	string	—
`iam`	body	string	—
`id`	body	string	—	Id is the user's STABLE OPAQUE identifier — the value the OIDC `sub` claim carries. It is the v1 the legacy surface per-row UUID (e.g.
`idCard`	body	string	—
`idCardType`	body	string	—
`influxcloud`	body	string	—
`infoflow`	body	string	—
`instagram`	body	string	—
`intercom`	body	string	—
`invitation`	body	string	—
`invitationCode`	body	string	—
`ipWhitelist`	body	string	—
`isAdmin`	body	boolean	—
`isDefaultAvatar`	body	boolean	—	State flags.
`isDeleted`	body	boolean	—
`isForbidden`	body	boolean	—
`isOnline`	body	boolean	—
`isVerified`	body	boolean	—
`kakao`	body	string	—
`karma`	body	integer	—
`kwai`	body	string	—
`language`	body	string	—
`lark`	body	string	—
`lastChangePasswordTime`	body	string	—
`lastName`	body	string	—
`lastSigninIp`	body	string	—
`lastSigninTime`	body	string	—
`lastSigninWrongTime`	body	string	—
`lastfm`	body	string	—
`ldap`	body	string	—
`line`	body	string	—
`linkedin`	body	string	—
`location`	body	string	—
`mailru`	body	string	—
`managedAccounts`	body	iam.ManagedAccount[]	—
`managedAccounts[].application`	body	string	—
`managedAccounts[].signinUrl`	body	string	—
`managedAccounts[].username`	body	string	—
`meetup`	body	string	—
`mfaAccounts`	body	iam.MfaAccount[]	—
`mfaAccounts[].accountName`	body	string	—
`mfaAccounts[].issuer`	body	string	—
`mfaAccounts[].origin`	body	string	—
`mfaEmailEnabled`	body	boolean	—
`mfaItems`	body	iam.MfaItem[]	—
`mfaItems[].name`	body	string	—
`mfaItems[].rule`	body	string	—
`mfaPhoneEnabled`	body	boolean	—
`mfaPushEnabled`	body	boolean	—
`mfaPushProvider`	body	string	—
`mfaPushReceiver`	body	string	—
`mfaRadiusEnabled`	body	boolean	—
`mfaRadiusProvider`	body	string	—
`mfaRadiusUsername`	body	string	—
`mfaRememberDeadline`	body	string	—
`mfaRememberDigest`	body	string	—	MfaRememberDigest is the digest of the token held by the ONE browser the deadline above applies to.
`microsoftonline`	body	string	—
`multiFactorAuths`	body	iam.MfaProps[]	—
`multiFactorAuths[].countryCode`	body	string	—
`multiFactorAuths[].enabled`	body	boolean	—
`multiFactorAuths[].isPreferred`	body	boolean	—
`multiFactorAuths[].mfaRememberInHours`	body	integer	—
`multiFactorAuths[].mfaType`	body	string	—
`multiFactorAuths[].url`	body	string	—
`name`	body	string	—
`naver`	body	string	—
`needUpdatePassword`	body	boolean	—
`nextcloud`	body	string	—
`okta`	body	string	—
`onedrive`	body	string	—
`originalRefreshToken`	body	string	—
`originalToken`	body	string	—
`oura`	body	string	—
`owner`	body	string	—	Identity / tenancy.
`passwordHash`	body	string	—	Credential material. PasswordHash is a one-way bcrypt digest and is verify-only.
`passwordSalt`	body	string	—
`passwordType`	body	string	—
`patreon`	body	string	—
`paypal`	body	string	—
`permanentAvatar`	body	string	—
`permissions`	body	iam.Permission[]	—
`permissions[].actions`	body	string[]	—
`permissions[].adapter`	body	string	—
`permissions[].approveTime`	body	string	—
`permissions[].approver`	body	string	—
`permissions[].createdAt`	body	string (date-time)	—
`permissions[].createdTime`	body	string	—	Descriptive metadata.
`permissions[].deleted`	body	boolean	—
`permissions[].description`	body	string	—
`permissions[].displayName`	body	string	—
`permissions[].domains`	body	string[]	—
`permissions[].effect`	body	string	—
`permissions[].groups`	body	string[]	—
`permissions[].id`	body	string	—
`permissions[].isEnabled`	body	boolean	—
`permissions[].model`	body	string	—	Authorization model, targets, and decision.
`permissions[].name`	body	string	—
`permissions[].owner`	body	string	—	Identity — the (owner, name) natural key.
`permissions[].resourceType`	body	string	—
`permissions[].resources`	body	string[]	—
`permissions[].roles`	body	string[]	—
`permissions[].state`	body	string	—
`permissions[].submitter`	body	string	—	Submission / approval workflow.
`permissions[].updatedAt`	body	string (date-time)	—
`permissions[].users`	body	string[]	—	Subjects the grant is evaluated for.
`phone`	body	string	—
`preHash`	body	string	—
`preferredMfaType`	body	string	—
`properties`	body	object	—
`properties.*`	body	string	—
`qq`	body	string	—
`ranking`	body	integer	—
`realName`	body	string	—
`recoveryCodes`	body	string[]	—
`region`	body	string	—
`registerSource`	body	string	—
`registerType`	body	string	—
`roles`	body	iam.Role[]	—	Authorization attachments.
`roles[].createdAt`	body	string (date-time)	—
`roles[].createdTime`	body	string	—
`roles[].deleted`	body	boolean	—
`roles[].description`	body	string	—
`roles[].displayName`	body	string	—
`roles[].domains`	body	string[]	—
`roles[].groups`	body	string[]	—
`roles[].id`	body	string	—
`roles[].isEnabled`	body	boolean	—
`roles[].name`	body	string	—
`roles[].owner`	body	string	—
`roles[].roles`	body	string[]	—
`roles[].updatedAt`	body	string (date-time)	—
`roles[].users`	body	string[]	—
`salesforce`	body	string	—
`score`	body	integer	—
`shopify`	body	string	—
`signinWrongTimes`	body	integer	—
`signupApplication`	body	string	—
`slack`	body	string	—
`soundcloud`	body	string	—
`spotify`	body	string	—
`steam`	body	string	—
`strava`	body	string	—
`stripe`	body	string	—
`tag`	body	string	—
`telegram`	body	string	—
`tiktok`	body	string	—
`title`	body	string	—
`totpSecret`	body	string	—
`tumblr`	body	string	—
`twitch`	body	string	—
`twitter`	body	string	—
`type`	body	string	—
`typetalk`	body	string	—
`uber`	body	string	—
`updatedAt`	body	string (date-time)	—
`updatedTime`	body	string	—
`verificationCode`	body	string	—
`vk`	body	string	—
`webauthnCredentials`	body	any[]	—	Multi-factor authentication. TotpSecret and RecoveryCodes are secret verify-only material — the handler strips them from every response.
`wechat`	body	string	—
`wecom`	body	string	—
`weibo`	body	string	—
`wepay`	body	string	—
`xero`	body	string	—
`yahoo`	body	string	—
`yammer`	body	string	—
`yandex`	body	string	—
`zoom`	body	string	—

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.

import { Configuration, IamApi } from 'hanzoai';

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

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_iam_users_get(owner='owner')

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

resp, _, err := client.IamAPI.GetIamUsersGet(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::get_iam_users_get(&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).getIamUsersGet();

curl https://api.hanzo.ai/v1/iam/users/get?owner=%3Cowner%3E \
  -H "Authorization: Bearer $HANZO_API_KEY"

The door reaches iam through the iam tool, which names its 75 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list__well_known_jwks"
         }
       }
     }'

IAM API · All Hanzo APIs · Interactive reference

Returns one person in your organization, addressed by their username or by…

Request

Response

Examples

On this page