Files
sdk/docs/PoliciesApi.md
zeekayandHanzo Dev b55332704a feat: Hanzo Cloud SDK for Kotlin (generated from OpenAPI v8.0.0)
Coroutine-native client covering the full Hanzo /v1 cloud surface, for JVM and
Android. Generated with openapi-generator kotlin (library=jvm-okhttp4,
useCoroutines=true). Coordinate: ai.hanzo:sdk. Base URL: https://api.hanzo.ai.

Co-authored-by: Hanzo Dev <[email protected]>
2026-07-25 07:10:32 -07:00

7.2 KiB

PoliciesApi

All URIs are relative to https://api.hanzo.ai

Method HTTP request Description
authzAuthzAddPolicy POST /v1/authz/policies Add a policy
authzAuthzListPolicies GET /v1/authz/policies List policies
authzAuthzRemovePolicy DELETE /v1/authz/policies Remove a policy
s3GetBucketPolicy GET /v1/s3/{bucket}?policy Get bucket policy
s3PutBucketPolicy PUT /v1/s3/{bucket}?policy Set bucket policy

authzAuthzAddPolicy

AuthzAddPolicyResponse authzAuthzAddPolicy(authzEnforceRequest)

Add a policy

Adds a `[sub, obj, act]` rule to the calling org's policy set. Requires an admin role on the request JWT. Returns `201` when the rule was newly added and `200` when it already existed.

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = PoliciesApi()
val authzEnforceRequest : AuthzEnforceRequest =  // AuthzEnforceRequest | 
try {
    val result : AuthzAddPolicyResponse = apiInstance.authzAuthzAddPolicy(authzEnforceRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PoliciesApi#authzAuthzAddPolicy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PoliciesApi#authzAuthzAddPolicy")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
authzEnforceRequest AuthzEnforceRequest

Return type

AuthzAddPolicyResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

authzAuthzListPolicies

AuthzPolicyListResponse authzAuthzListPolicies()

List policies

Returns every policy rule for the calling org as an array of `[sub, obj, act]` tuples. Scoped by the gateway-minted `X-Org-Id` header.

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = PoliciesApi()
try {
    val result : AuthzPolicyListResponse = apiInstance.authzAuthzListPolicies()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PoliciesApi#authzAuthzListPolicies")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PoliciesApi#authzAuthzListPolicies")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

AuthzPolicyListResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

authzAuthzRemovePolicy

AuthzRemovePolicyResponse authzAuthzRemovePolicy(authzEnforceRequest)

Remove a policy

Removes a `[sub, obj, act]` rule from the calling org's policy set. Requires an admin role on the request JWT.

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = PoliciesApi()
val authzEnforceRequest : AuthzEnforceRequest =  // AuthzEnforceRequest | 
try {
    val result : AuthzRemovePolicyResponse = apiInstance.authzAuthzRemovePolicy(authzEnforceRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PoliciesApi#authzAuthzRemovePolicy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PoliciesApi#authzAuthzRemovePolicy")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
authzEnforceRequest AuthzEnforceRequest

Return type

AuthzRemovePolicyResponse

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

s3GetBucketPolicy

S3BucketPolicy s3GetBucketPolicy(bucket)

Get bucket policy

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = PoliciesApi()
val bucket : kotlin.String = bucket_example // kotlin.String | 
try {
    val result : S3BucketPolicy = apiInstance.s3GetBucketPolicy(bucket)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PoliciesApi#s3GetBucketPolicy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PoliciesApi#s3GetBucketPolicy")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
bucket kotlin.String

Return type

S3BucketPolicy

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

s3PutBucketPolicy

s3PutBucketPolicy(bucket, s3BucketPolicy)

Set bucket policy

Example

// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*

val apiInstance = PoliciesApi()
val bucket : kotlin.String = bucket_example // kotlin.String | 
val s3BucketPolicy : S3BucketPolicy =  // S3BucketPolicy | 
try {
    apiInstance.s3PutBucketPolicy(bucket, s3BucketPolicy)
} catch (e: ClientException) {
    println("4xx response calling PoliciesApi#s3PutBucketPolicy")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PoliciesApi#s3PutBucketPolicy")
    e.printStackTrace()
}

Parameters

| bucket | kotlin.String| | |

Name Type Description Notes
s3BucketPolicy S3BucketPolicy

Return type

null (empty response body)

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined