# Get users — GET /v1/iam/users/{owner}/{name}

URL: https://docs.hanzo.ai/docs/openapi/iam/get-iam-users-by-owner-by-name

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

`GET /v1/iam/users/{owner}/{name}`

> [IAM →](https://docs.hanzo.ai/docs/openapi/iam) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                    |
| ------------- | -------------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/iam/users/{owner}/{name}` |
| **Method**    | `GET`                                              |
| **Operation** | `get_iam_users_by_owner_by_name`                   |
| **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 | Description |
| ------- | ----- | ------ | -------- | ----------- |
| `owner` | path  | string | yes      |             |
| `name`  | path  | string | yes      |             |
| `email` | query | string | —        |             |

## Response

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

`200` body — 217 fields.

| Field                                   | In   | Type                  | Always | Description                                                                                                                                                                                                             |
| --------------------------------------- | ---- | --------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `accessKey`                             | body | string                | —      | API credentials.                                                                                                                                                                                                        |
| `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 (double)       | —      | 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 (double)       | —      |                                                                                                                                                                                                                         |
| `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 (double)       | —      |                                                                                                                                                                                                                         |
| `cart[].quantity`                       | body | integer (int64)       | —      |                                                                                                                                                                                                                         |
| `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 (double)\[]    | —      |                                                                                                                                                                                                                         |
| `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                | —      |                                                                                                                                                                                                                         |
| `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.                                                                                                                                     |
| `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 (int64)       | —      |                                                                                                                                                                                                                         |
| `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 (int64)       | —      |                                                                                                                                                                                                                         |
| `multiFactorAuths[].mfaType`            | body | string                | —      |                                                                                                                                                                                                                         |
| `multiFactorAuths[].url`                | body | string                | —      |                                                                                                                                                                                                                         |
| `name`                                  | body | string                | —      |                                                                                                                                                                                                                         |
| `nameKey`                               | body | string                | —      | NameKey is Fold(Name), derived on every save (BeforeCreate, BeforeUpdate) and on every open for a row saved without it (store.Prepare): the indexed key a case-insensitive username lookup reads (store.GetUserByName). |
| `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.                                                                                                                                                                                                    |
| `passwordSalt`                          | body | string                | —      |                                                                                                                                                                                                                         |
| `passwordType`                          | body | string                | —      |                                                                                                                                                                                                                         |
| `patreon`                               | body | string                | —      |                                                                                                                                                                                                                         |
| `paypal`                                | body | string                | —      |                                                                                                                                                                                                                         |
| `permanentAvatar`                       | body | string                | —      |                                                                                                                                                                                                                         |
| `phone`                                 | body | string                | —      |                                                                                                                                                                                                                         |
| `preHash`                               | body | string                | —      |                                                                                                                                                                                                                         |
| `preferredMfaType`                      | body | string                | —      |                                                                                                                                                                                                                         |
| `properties`                            | body | object                | —      |                                                                                                                                                                                                                         |
| `properties.*`                          | body | string                | —      |                                                                                                                                                                                                                         |
| `qq`                                    | body | string                | —      |                                                                                                                                                                                                                         |
| `ranking`                               | body | integer (int64)       | —      |                                                                                                                                                                                                                         |
| `realName`                              | body | string                | —      |                                                                                                                                                                                                                         |
| `recoveryCodes`                         | body | string\[]             | —      |                                                                                                                                                                                                                         |
| `region`                                | body | string                | —      |                                                                                                                                                                                                                         |
| `registerSource`                        | body | string                | —      |                                                                                                                                                                                                                         |
| `registerType`                          | body | string                | —      |                                                                                                                                                                                                                         |
| `salesforce`                            | body | string                | —      |                                                                                                                                                                                                                         |
| `score`                                 | body | integer (int64)       | —      |                                                                                                                                                                                                                         |
| `shopify`                               | body | string                | —      |                                                                                                                                                                                                                         |
| `signinWrongTimes`                      | body | integer (int64)       | —      |                                                                                                                                                                                                                         |
| `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.                                                                                                                                                                                            |
| `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](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo iam users owner get <owner> <name>
```

**SDK**

**.ts**

```ts
import { Configuration, IamApi } from 'hanzoai';

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

**.py**

```python
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_by_owner_by_name(owner='owner', name='name')
```

**.go**

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

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

**.rs**

```rust
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_iam_users_by_owner_by_name(&cfg, Default::default()).await?;
```

**.java**

```java
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).getIamUsersByOwnerByName();
```

**HTTP**

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

**MCP**

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

```bash
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_iam_applications"
         }
       }
     }'
```

---

[IAM API](https://docs.hanzo.ai/docs/openapi/iam) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
