Files
sdk/docs/PermissionsApi.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

10 KiB

PermissionsApi

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

Method HTTP request Description
chatGetPermissionsByresourcetypeByresourceid GET /v1/chat/permissions/{resourceType}/{resourceId} Get all permissions for a resource
chatGetPermissionsByresourcetypeByresourceidEffective GET /v1/chat/permissions/{resourceType}/{resourceId}/effective Get effective permissions for a specific resource
chatGetPermissionsByresourcetypeEffectiveAll GET /v1/chat/permissions/{resourceType}/effective/all Get effective permissions for all accessible resources
chatGetPermissionsByresourcetypeRoles GET /v1/chat/permissions/{resourceType}/roles Get available roles for a resource type
chatGetPermissionsSearchPrincipals GET /v1/chat/permissions/search-principals Search for users and groups to grant permissions
chatPutPermissionsByresourcetypeByresourceid PUT /v1/chat/permissions/{resourceType}/{resourceId} Bulk update permissions for a resource

chatGetPermissionsByresourcetypeByresourceid

kotlin.Any chatGetPermissionsByresourcetypeByresourceid(resourceType, resourceId)

Get all permissions for a resource

Example

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

val apiInstance = PermissionsApi()
val resourceType : kotlin.String = resourceType_example // kotlin.String | 
val resourceId : kotlin.String = resourceId_example // kotlin.String | 
try {
    val result : kotlin.Any = apiInstance.chatGetPermissionsByresourcetypeByresourceid(resourceType, resourceId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PermissionsApi#chatGetPermissionsByresourcetypeByresourceid")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PermissionsApi#chatGetPermissionsByresourcetypeByresourceid")
    e.printStackTrace()
}

Parameters

| resourceType | kotlin.String| | |

Name Type Description Notes
resourceId kotlin.String

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatGetPermissionsByresourcetypeByresourceidEffective

kotlin.Any chatGetPermissionsByresourcetypeByresourceidEffective(resourceType, resourceId)

Get effective permissions for a specific resource

Example

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

val apiInstance = PermissionsApi()
val resourceType : kotlin.String = resourceType_example // kotlin.String | 
val resourceId : kotlin.String = resourceId_example // kotlin.String | 
try {
    val result : kotlin.Any = apiInstance.chatGetPermissionsByresourcetypeByresourceidEffective(resourceType, resourceId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PermissionsApi#chatGetPermissionsByresourcetypeByresourceidEffective")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PermissionsApi#chatGetPermissionsByresourcetypeByresourceidEffective")
    e.printStackTrace()
}

Parameters

| resourceType | kotlin.String| | |

Name Type Description Notes
resourceId kotlin.String

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatGetPermissionsByresourcetypeEffectiveAll

kotlin.Any chatGetPermissionsByresourcetypeEffectiveAll(resourceType)

Get effective permissions for all accessible resources

Example

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

val apiInstance = PermissionsApi()
val resourceType : kotlin.String = resourceType_example // kotlin.String | 
try {
    val result : kotlin.Any = apiInstance.chatGetPermissionsByresourcetypeEffectiveAll(resourceType)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PermissionsApi#chatGetPermissionsByresourcetypeEffectiveAll")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PermissionsApi#chatGetPermissionsByresourcetypeEffectiveAll")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
resourceType kotlin.String

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatGetPermissionsByresourcetypeRoles

kotlin.Any chatGetPermissionsByresourcetypeRoles(resourceType)

Get available roles for a resource type

Example

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

val apiInstance = PermissionsApi()
val resourceType : kotlin.String = resourceType_example // kotlin.String | 
try {
    val result : kotlin.Any = apiInstance.chatGetPermissionsByresourcetypeRoles(resourceType)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PermissionsApi#chatGetPermissionsByresourcetypeRoles")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PermissionsApi#chatGetPermissionsByresourcetypeRoles")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
resourceType kotlin.String

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatGetPermissionsSearchPrincipals

kotlin.Any chatGetPermissionsSearchPrincipals(query)

Search for users and groups to grant permissions

Example

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

val apiInstance = PermissionsApi()
val query : kotlin.String = query_example // kotlin.String | 
try {
    val result : kotlin.Any = apiInstance.chatGetPermissionsSearchPrincipals(query)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PermissionsApi#chatGetPermissionsSearchPrincipals")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PermissionsApi#chatGetPermissionsSearchPrincipals")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
query kotlin.String [optional]

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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

chatPutPermissionsByresourcetypeByresourceid

kotlin.Any chatPutPermissionsByresourcetypeByresourceid(resourceType, resourceId, body)

Bulk update permissions for a resource

Example

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

val apiInstance = PermissionsApi()
val resourceType : kotlin.String = resourceType_example // kotlin.String | 
val resourceId : kotlin.String = resourceId_example // kotlin.String | 
val body : kotlin.Any = Object // kotlin.Any | 
try {
    val result : kotlin.Any = apiInstance.chatPutPermissionsByresourcetypeByresourceid(resourceType, resourceId, body)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling PermissionsApi#chatPutPermissionsByresourcetypeByresourceid")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling PermissionsApi#chatPutPermissionsByresourcetypeByresourceid")
    e.printStackTrace()
}

Parameters

| resourceType | kotlin.String| | | | resourceId | kotlin.String| | |

Name Type Description Notes
body kotlin.Any

Return type

kotlin.Any

Authorization

Configure bearerAuth statically:

ApiClient.accessToken = ""

Configure bearerAuth dynamically:

apiInstance.accessTokenProvider = { "" }

HTTP request headers

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