OpenapiIam
Records an access token — the credential an application or integration presents…
Records an access token — the credential an application or integration presents on a caller's behalf.
POST /v1/iam/tokens
| Address | https://api.hanzo.ai/v1/iam/tokens |
| Method | POST |
| Operation | addToken |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Records an access token — the credential an application or integration presents on a caller's behalf.
Request
30 fields, body application/json (required).
| Field | In | Type | Required | Description |
|---|---|---|---|---|
accessToken | body | string | — | |
accessTokenHash | body | string | — | |
application | body | string | — | |
code | body | string | — | |
codeChallenge | body | string | — | |
codeChallengeMethod | body | string | — | |
codeExpireIn | body | integer | — | |
codeIsUsed | body | boolean | — | |
createdAt | body | string (date-time) | — | |
createdTime | body | string | — | |
deleted | body | boolean | — | |
expiresIn | body | integer | — | |
id | body | string | — | |
name | body | string | — | |
nonce | body | string | — | Nonce is the OIDC authorize nonce, stored on the code and echoed into the id_token minted at the exchange (OIDC Core §3.1.3.6) so a relying party binds the… |
organization | body | string | — | |
owner | body | string | — | |
publicGrant | body | boolean | — | PublicGrant records that this grant was established WITHOUT client authentication — a PKCE code exchange from a client that presented no secret. |
redirectUri | body | string | — | RedirectUri binds the authorization code to the exact redirect URI of the authorize request (RFC 6749 §4.1.3): the token endpoint refuses a code redeemed with… |
refreshConsumed | body | boolean | — | |
refreshExpireIn | body | integer | — | |
refreshFamily | body | string | — | Refresh-token rotation state (v2). Each refresh belongs to a family (the grant); rotation mints a new row in the same family and marks the prior one consumed. |
refreshToken | body | string | — | |
refreshTokenHash | body | string | — | |
resource | body | string | — | RFC 8707 resource indicator |
scope | body | string | — | |
tokenType | body | string | — | |
updatedAt | body | string (date-time) | — | |
user | body | string | — | |
userCode | body | string | — |
Response
| Status | Body | Meaning |
|---|---|---|
200 | iam.tokenResult | ok |
200 body — 31 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
token | body | iam.Token | — | |
token.accessToken | body | string | — | |
token.accessTokenHash | body | string | — | |
token.application | body | string | — | |
token.code | body | string | — | |
token.codeChallenge | body | string | — | |
token.codeChallengeMethod | body | string | — | |
token.codeExpireIn | body | integer | — | |
token.codeIsUsed | body | boolean | — | |
token.createdAt | body | string (date-time) | — | |
token.createdTime | body | string | — | |
token.deleted | body | boolean | — | |
token.expiresIn | body | integer | — | |
token.id | body | string | — | |
token.name | body | string | — | |
token.nonce | body | string | — | Nonce is the OIDC authorize nonce, stored on the code and echoed into the id_token minted at the exchange (OIDC Core §3.1.3.6) so a relying party binds the… |
token.organization | body | string | — | |
token.owner | body | string | — | |
token.publicGrant | body | boolean | — | PublicGrant records that this grant was established WITHOUT client authentication — a PKCE code exchange from a client that presented no secret. |
token.redirectUri | body | string | — | RedirectUri binds the authorization code to the exact redirect URI of the authorize request (RFC 6749 §4.1.3): the token endpoint refuses a code redeemed with… |
token.refreshConsumed | body | boolean | — | |
token.refreshExpireIn | body | integer | — | |
token.refreshFamily | body | string | — | Refresh-token rotation state (v2). Each refresh belongs to a family (the grant); rotation mints a new row in the same family and marks the prior one consumed. |
token.refreshToken | body | string | — | |
token.refreshTokenHash | body | string | — | |
token.resource | body | string | — | RFC 8707 resource indicator |
token.scope | body | string | — | |
token.tokenType | body | string | — | |
token.updatedAt | body | string (date-time) | — | |
token.user | body | string | — | |
token.userCode | body | string | — |
Failure carries the platform error shape — see Errors.
Examples
hanzo iam tokens createimport { Configuration, IamApi } from 'hanzoai';
const api = new IamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.addToken({ accessToken: "<accessToken>", accessTokenHash: "<accessTokenHash>" });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).add_token(access_token="<accessToken>", access_token_hash="<accessTokenHash>")cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.IamAPI.AddToken(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::add_token(&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).addToken();curl -X POST https://api.hanzo.ai/v1/iam/tokens \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"accessToken": "<accessToken>",
"accessTokenHash": "<accessTokenHash>"
}'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"
}
}
}'How is this guide?