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]>
73 KiB
SystemApi
All URIs are relative to https://api.hanzo.ai
| Method | HTTP request | Description |
|---|---|---|
| iamApiControllerAddAdapter | POST /v1/iam/adapters | Api Controller Add Adapter |
| iamApiControllerAddCert | POST /v1/iam/certs | Api Controller Add Cert |
| iamApiControllerAddForm | POST /v1/iam/forms | Api Controller Add Form |
| iamApiControllerAddRecord | POST /v1/iam/records | Api Controller Add Record |
| iamApiControllerAddSyncer | POST /v1/iam/syncers | Api Controller Add Syncer |
| iamApiControllerAddTicket | POST /v1/iam/tickets | Api Controller Add Ticket |
| iamApiControllerAddTicketMessage | POST /v1/iam/ticket-messages | Api Controller Add Ticket Message |
| iamApiControllerDeleteAdapter | DELETE /v1/iam/adapters/{id} | Api Controller Delete Adapter |
| iamApiControllerDeleteCert | DELETE /v1/iam/certs/{id} | Api Controller Delete Cert |
| iamApiControllerDeleteForm | DELETE /v1/iam/forms/{id} | Api Controller Delete Form |
| iamApiControllerDeleteSyncer | DELETE /v1/iam/syncers/{id} | Api Controller Delete Syncer |
| iamApiControllerDeleteTicket | DELETE /v1/iam/tickets/{id} | Api Controller Delete Ticket |
| iamApiControllerGetAdapter | GET /v1/iam/adapters/{id} | Api Controller Get Adapter |
| iamApiControllerGetAdapters | GET /v1/iam/adapters | Api Controller Get Adapters |
| iamApiControllerGetCert | GET /v1/iam/certs/{id} | Api Controller Get Cert |
| iamApiControllerGetCerts | GET /v1/iam/certs | Api Controller Get Certs |
| iamApiControllerGetDashboard | GET /v1/iam/dashboard | Api Controller Get Dashboard |
| iamApiControllerGetForm | GET /v1/iam/forms/{id} | Api Controller Get Form |
| iamApiControllerGetForms | GET /v1/iam/forms | Api Controller Get Forms |
| iamApiControllerGetGlobalCerts | GET /v1/iam/global-certs | Api Controller Get Global Certs |
| iamApiControllerGetGlobalForms | GET /v1/iam/global-forms | Api Controller Get Global Forms |
| iamApiControllerGetMetrics | GET /v1/iam/metrics | Api Controller Get Metrics |
| iamApiControllerGetPrometheusInfo | GET /v1/iam/metrics/prometheus | Api Controller Get Prometheus Info |
| iamApiControllerGetRecords | GET /v1/iam/records | Api Controller Get Records |
| iamApiControllerGetRecordsByFilter | GET /v1/iam/records-filters/{id} | Api Controller Get Records By Filter |
| iamApiControllerGetSyncer | GET /v1/iam/syncers/{id} | Api Controller Get Syncer |
| iamApiControllerGetSyncers | GET /v1/iam/syncers | Api Controller Get Syncers |
| iamApiControllerGetSystemInfo | GET /v1/iam/system | Api Controller Get System Info |
| iamApiControllerGetTicket | GET /v1/iam/tickets/{id} | Api Controller Get Ticket |
| iamApiControllerGetTickets | GET /v1/iam/tickets | Api Controller Get Tickets |
| iamApiControllerGetVersionInfo | GET /v1/iam/version-infos/{id} | Api Controller Get Version Info |
| iamApiControllerGetWebhookEventType | GET /v1/iam/webhook-events/{id} | Api Controller Get Webhook Event Type |
| iamApiControllerGetWechatQRCode | GET /v1/iam/qrcodes/{id} | Api Controller Get Wechat QR Code |
| iamApiControllerHandleOfficialAccountEvent | POST /v1/iam/webhook | Api Controller Handle Official Account Event |
| iamApiControllerHealth | GET /v1/iam/health | Api Controller Health |
| iamApiControllerRefreshEngines | POST /v1/iam/refresh-engines | Api Controller Refresh Engines |
| iamApiControllerRunSyncer | GET /v1/iam/syncers/run | Api Controller Run Syncer |
| iamApiControllerSendEmail | POST /v1/iam/messaging/email | Api Controller Send Email |
| iamApiControllerSendNotification | POST /v1/iam/messaging/notification | Api Controller Send Notification |
| iamApiControllerSendSms | POST /v1/iam/messaging/sms | Api Controller Send Sms |
| iamApiControllerUpdateAdapter | PUT /v1/iam/adapters/{id} | Api Controller Update Adapter |
| iamApiControllerUpdateCert | PUT /v1/iam/certs/{id} | Api Controller Update Cert |
| iamApiControllerUpdateForm | PUT /v1/iam/forms/{id} | Api Controller Update Form |
| iamApiControllerUpdateSyncer | PUT /v1/iam/syncers/{id} | Api Controller Update Syncer |
| iamApiControllerUpdateTicket | PUT /v1/iam/tickets/{id} | Api Controller Update Ticket |
| paasListTemplates | GET /v1/paas/system/templates | List available templates |
| tasksTasksCluster | GET /v1/tasks/cluster | Cluster status (open probe) |
| tasksTasksClusterHealth | GET /v1/tasks/cluster/health | Cluster health (open probe) |
| tasksTasksHealth | GET /v1/tasks/health | Liveness probe |
| tasksTasksSettings | GET /v1/tasks/settings | Capability flags (open bootstrap) |
iamApiControllerAddAdapter
IamControllersResponse iamApiControllerAddAdapter(iamObjectAdapter)
Api Controller Add Adapter
add adapter
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val iamObjectAdapter : IamObjectAdapter = // IamObjectAdapter | The details of the adapter
try {
val result : IamControllersResponse = apiInstance.iamApiControllerAddAdapter(iamObjectAdapter)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerAddAdapter")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerAddAdapter")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectAdapter | IamObjectAdapter | The details of the adapter |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerAddCert
IamControllersResponse iamApiControllerAddCert(iamObjectCert)
Api Controller Add Cert
add cert
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val iamObjectCert : IamObjectCert = // IamObjectCert | The details of the cert
try {
val result : IamControllersResponse = apiInstance.iamApiControllerAddCert(iamObjectCert)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerAddCert")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerAddCert")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectCert | IamObjectCert | The details of the cert |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerAddForm
IamControllersResponse iamApiControllerAddForm(iamObjectForm)
Api Controller Add Form
add form
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val iamObjectForm : IamObjectForm = // IamObjectForm | The details of the form
try {
val result : IamControllersResponse = apiInstance.iamApiControllerAddForm(iamObjectForm)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerAddForm")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerAddForm")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectForm | IamObjectForm | The details of the form |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerAddRecord
IamControllersResponse iamApiControllerAddRecord(body)
Api Controller Add Record
add a record
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val body : kotlin.Any = Object // kotlin.Any | The details of the record
try {
val result : IamControllersResponse = apiInstance.iamApiControllerAddRecord(body)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerAddRecord")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerAddRecord")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | kotlin.Any | The details of the record |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerAddSyncer
IamControllersResponse iamApiControllerAddSyncer(iamObjectSyncer)
Api Controller Add Syncer
add syncer
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val iamObjectSyncer : IamObjectSyncer = // IamObjectSyncer | The details of the syncer
try {
val result : IamControllersResponse = apiInstance.iamApiControllerAddSyncer(iamObjectSyncer)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerAddSyncer")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerAddSyncer")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectSyncer | IamObjectSyncer | The details of the syncer |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerAddTicket
IamControllersResponse iamApiControllerAddTicket(iamObjectTicket)
Api Controller Add Ticket
add ticket
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val iamObjectTicket : IamObjectTicket = // IamObjectTicket | The details of the ticket
try {
val result : IamControllersResponse = apiInstance.iamApiControllerAddTicket(iamObjectTicket)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerAddTicket")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerAddTicket")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectTicket | IamObjectTicket | The details of the ticket |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerAddTicketMessage
IamControllersResponse iamApiControllerAddTicketMessage(id, iamObjectTicketMessage)
Api Controller Add Ticket Message
add a message to a ticket
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | The id ( owner/name ) of the ticket
val iamObjectTicketMessage : IamObjectTicketMessage = // IamObjectTicketMessage | The message to add
try {
val result : IamControllersResponse = apiInstance.iamApiControllerAddTicketMessage(id, iamObjectTicketMessage)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerAddTicketMessage")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerAddTicketMessage")
e.printStackTrace()
}
Parameters
| id | kotlin.String| The id ( owner/name ) of the ticket | |
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectTicketMessage | IamObjectTicketMessage | The message to add |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerDeleteAdapter
IamControllersResponse iamApiControllerDeleteAdapter(id, iamObjectAdapter)
Api Controller Delete Adapter
delete adapter
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | Resource identifier (owner/name)
val iamObjectAdapter : IamObjectAdapter = // IamObjectAdapter | The details of the adapter
try {
val result : IamControllersResponse = apiInstance.iamApiControllerDeleteAdapter(id, iamObjectAdapter)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerDeleteAdapter")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerDeleteAdapter")
e.printStackTrace()
}
Parameters
| id | kotlin.String| Resource identifier (owner/name) | |
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectAdapter | IamObjectAdapter | The details of the adapter |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerDeleteCert
IamControllersResponse iamApiControllerDeleteCert(id, iamObjectCert)
Api Controller Delete Cert
delete cert
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | Resource identifier (owner/name)
val iamObjectCert : IamObjectCert = // IamObjectCert | The details of the cert
try {
val result : IamControllersResponse = apiInstance.iamApiControllerDeleteCert(id, iamObjectCert)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerDeleteCert")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerDeleteCert")
e.printStackTrace()
}
Parameters
| id | kotlin.String| Resource identifier (owner/name) | |
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectCert | IamObjectCert | The details of the cert |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerDeleteForm
IamControllersResponse iamApiControllerDeleteForm(id, iamObjectForm)
Api Controller Delete Form
delete form
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | Resource identifier (owner/name)
val iamObjectForm : IamObjectForm = // IamObjectForm | The details of the form
try {
val result : IamControllersResponse = apiInstance.iamApiControllerDeleteForm(id, iamObjectForm)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerDeleteForm")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerDeleteForm")
e.printStackTrace()
}
Parameters
| id | kotlin.String| Resource identifier (owner/name) | |
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectForm | IamObjectForm | The details of the form |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerDeleteSyncer
IamControllersResponse iamApiControllerDeleteSyncer(id, iamObjectSyncer)
Api Controller Delete Syncer
delete syncer
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | Resource identifier (owner/name)
val iamObjectSyncer : IamObjectSyncer = // IamObjectSyncer | The details of the syncer
try {
val result : IamControllersResponse = apiInstance.iamApiControllerDeleteSyncer(id, iamObjectSyncer)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerDeleteSyncer")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerDeleteSyncer")
e.printStackTrace()
}
Parameters
| id | kotlin.String| Resource identifier (owner/name) | |
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectSyncer | IamObjectSyncer | The details of the syncer |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerDeleteTicket
IamControllersResponse iamApiControllerDeleteTicket(id, iamObjectTicket)
Api Controller Delete Ticket
delete ticket
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | Resource identifier (owner/name)
val iamObjectTicket : IamObjectTicket = // IamObjectTicket | The details of the ticket
try {
val result : IamControllersResponse = apiInstance.iamApiControllerDeleteTicket(id, iamObjectTicket)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerDeleteTicket")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerDeleteTicket")
e.printStackTrace()
}
Parameters
| id | kotlin.String| Resource identifier (owner/name) | |
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectTicket | IamObjectTicket | The details of the ticket |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerGetAdapter
IamObjectAdapter iamApiControllerGetAdapter(id)
Api Controller Get Adapter
get adapter
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | The id ( owner/name ) of the adapter
try {
val result : IamObjectAdapter = apiInstance.iamApiControllerGetAdapter(id)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetAdapter")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetAdapter")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | kotlin.String | The id ( owner/name ) of the adapter |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetAdapters
kotlin.collections.List<IamObjectAdapter> iamApiControllerGetAdapters(owner)
Api Controller Get Adapters
get adapters
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val owner : kotlin.String = owner_example // kotlin.String | The owner of adapters
try {
val result : kotlin.collections.List<IamObjectAdapter> = apiInstance.iamApiControllerGetAdapters(owner)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetAdapters")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetAdapters")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| owner | kotlin.String | The owner of adapters |
Return type
kotlin.collections.List<IamObjectAdapter>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetCert
IamObjectCert iamApiControllerGetCert(id)
Api Controller Get Cert
get cert
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | The id ( owner/name ) of the cert
try {
val result : IamObjectCert = apiInstance.iamApiControllerGetCert(id)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetCert")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetCert")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | kotlin.String | The id ( owner/name ) of the cert |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetCerts
kotlin.collections.List<IamObjectCert> iamApiControllerGetCerts(owner)
Api Controller Get Certs
get certs
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val owner : kotlin.String = owner_example // kotlin.String | The owner of certs
try {
val result : kotlin.collections.List<IamObjectCert> = apiInstance.iamApiControllerGetCerts(owner)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetCerts")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetCerts")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| owner | kotlin.String | The owner of certs |
Return type
kotlin.collections.List<IamObjectCert>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetDashboard
IamControllersResponse iamApiControllerGetDashboard()
Api Controller Get Dashboard
get information of dashboard
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
try {
val result : IamControllersResponse = apiInstance.iamApiControllerGetDashboard()
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetDashboard")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetDashboard")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetForm
IamObjectForm iamApiControllerGetForm(id)
Api Controller Get Form
get form
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of form
try {
val result : IamObjectForm = apiInstance.iamApiControllerGetForm(id)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetForm")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetForm")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | kotlin.String | The id (owner/name) of form |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetForms
kotlin.collections.List<IamObjectForm> iamApiControllerGetForms(owner)
Api Controller Get Forms
get forms
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val owner : kotlin.String = owner_example // kotlin.String | The owner of form
try {
val result : kotlin.collections.List<IamObjectForm> = apiInstance.iamApiControllerGetForms(owner)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetForms")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetForms")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| owner | kotlin.String | The owner of form |
Return type
kotlin.collections.List<IamObjectForm>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetGlobalCerts
kotlin.collections.List<IamObjectCert> iamApiControllerGetGlobalCerts()
Api Controller Get Global Certs
get global certs
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
try {
val result : kotlin.collections.List<IamObjectCert> = apiInstance.iamApiControllerGetGlobalCerts()
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetGlobalCerts")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetGlobalCerts")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
kotlin.collections.List<IamObjectCert>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetGlobalForms
kotlin.collections.List<IamObjectForm> iamApiControllerGetGlobalForms()
Api Controller Get Global Forms
get global forms
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
try {
val result : kotlin.collections.List<IamObjectForm> = apiInstance.iamApiControllerGetGlobalForms()
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetGlobalForms")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetGlobalForms")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
kotlin.collections.List<IamObjectForm>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetMetrics
kotlin.Any iamApiControllerGetMetrics()
Api Controller Get Metrics
get Prometheus metrics
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
try {
val result : kotlin.Any = apiInstance.iamApiControllerGetMetrics()
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetMetrics")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetMetrics")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetPrometheusInfo
IamObjectPrometheusInfo iamApiControllerGetPrometheusInfo()
Api Controller Get Prometheus Info
get Prometheus Info
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
try {
val result : IamObjectPrometheusInfo = apiInstance.iamApiControllerGetPrometheusInfo()
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetPrometheusInfo")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetPrometheusInfo")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetRecords
kotlin.Any iamApiControllerGetRecords(pageSize, p)
Api Controller Get Records
get all records
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val pageSize : kotlin.String = pageSize_example // kotlin.String | The size of each page
val p : kotlin.String = p_example // kotlin.String | The number of the page
try {
val result : kotlin.Any = apiInstance.iamApiControllerGetRecords(pageSize, p)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetRecords")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetRecords")
e.printStackTrace()
}
Parameters
| pageSize | kotlin.String| The size of each page | |
| Name | Type | Description | Notes |
|---|---|---|---|
| p | kotlin.String | The number of the page |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetRecordsByFilter
kotlin.Any iamApiControllerGetRecordsByFilter(id, body)
Api Controller Get Records By Filter
get records by filter
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | Resource identifier (owner/name)
val body : kotlin.String = body_example // kotlin.String | filter Record message
try {
val result : kotlin.Any = apiInstance.iamApiControllerGetRecordsByFilter(id, body)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetRecordsByFilter")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetRecordsByFilter")
e.printStackTrace()
}
Parameters
| id | kotlin.String| Resource identifier (owner/name) | |
| Name | Type | Description | Notes |
|---|---|---|---|
| body | kotlin.String | filter Record message |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerGetSyncer
IamObjectSyncer iamApiControllerGetSyncer(id)
Api Controller Get Syncer
get syncer
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | The id ( owner/name ) of the syncer
try {
val result : IamObjectSyncer = apiInstance.iamApiControllerGetSyncer(id)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetSyncer")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetSyncer")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | kotlin.String | The id ( owner/name ) of the syncer |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetSyncers
kotlin.collections.List<IamObjectSyncer> iamApiControllerGetSyncers(owner)
Api Controller Get Syncers
get syncers
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val owner : kotlin.String = owner_example // kotlin.String | The owner of syncers
try {
val result : kotlin.collections.List<IamObjectSyncer> = apiInstance.iamApiControllerGetSyncers(owner)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetSyncers")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetSyncers")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| owner | kotlin.String | The owner of syncers |
Return type
kotlin.collections.List<IamObjectSyncer>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetSystemInfo
CloudUtilSystemInfo iamApiControllerGetSystemInfo()
Api Controller Get System Info
get system info like CPU and memory usage
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
try {
val result : CloudUtilSystemInfo = apiInstance.iamApiControllerGetSystemInfo()
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetSystemInfo")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetSystemInfo")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetTicket
IamObjectTicket iamApiControllerGetTicket(id)
Api Controller Get Ticket
get ticket
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | The id ( owner/name ) of the ticket
try {
val result : IamObjectTicket = apiInstance.iamApiControllerGetTicket(id)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetTicket")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetTicket")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | kotlin.String | The id ( owner/name ) of the ticket |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetTickets
kotlin.collections.List<IamObjectTicket> iamApiControllerGetTickets(owner)
Api Controller Get Tickets
get tickets
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val owner : kotlin.String = owner_example // kotlin.String | The owner of tickets
try {
val result : kotlin.collections.List<IamObjectTicket> = apiInstance.iamApiControllerGetTickets(owner)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetTickets")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetTickets")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| owner | kotlin.String | The owner of tickets |
Return type
kotlin.collections.List<IamObjectTicket>
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetVersionInfo
CloudUtilVersionInfo iamApiControllerGetVersionInfo(id)
Api Controller Get Version Info
get version info like Hanzo IAM release version and commit ID
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | Resource identifier (owner/name)
try {
val result : CloudUtilVersionInfo = apiInstance.iamApiControllerGetVersionInfo(id)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetVersionInfo")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetVersionInfo")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | kotlin.String | Resource identifier (owner/name) |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetWebhookEventType
IamControllersResponse iamApiControllerGetWebhookEventType(id, ticket)
Api Controller Get Webhook Event Type
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | Resource identifier (owner/name)
val ticket : kotlin.String = ticket_example // kotlin.String | The eventId of QRCode
try {
val result : IamControllersResponse = apiInstance.iamApiControllerGetWebhookEventType(id, ticket)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetWebhookEventType")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetWebhookEventType")
e.printStackTrace()
}
Parameters
| id | kotlin.String| Resource identifier (owner/name) | |
| Name | Type | Description | Notes |
|---|---|---|---|
| ticket | kotlin.String | The eventId of QRCode |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerGetWechatQRCode
IamControllersResponse iamApiControllerGetWechatQRCode(id)
Api Controller Get Wechat QR Code
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | The id ( owner/name ) of provider
try {
val result : IamControllersResponse = apiInstance.iamApiControllerGetWechatQRCode(id)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerGetWechatQRCode")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerGetWechatQRCode")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | kotlin.String | The id ( owner/name ) of provider |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerHandleOfficialAccountEvent
IamControllersResponse iamApiControllerHandleOfficialAccountEvent()
Api Controller Handle Official Account Event
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
try {
val result : IamControllersResponse = apiInstance.iamApiControllerHandleOfficialAccountEvent()
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerHandleOfficialAccountEvent")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerHandleOfficialAccountEvent")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerHealth
IamControllersResponse iamApiControllerHealth()
Api Controller Health
check if the system is live
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
try {
val result : IamControllersResponse = apiInstance.iamApiControllerHealth()
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerHealth")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerHealth")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerRefreshEngines
IamControllersResponse iamApiControllerRefreshEngines(m, t)
Api Controller Refresh Engines
Refresh all CLI engines
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val m : kotlin.String = m_example // kotlin.String | Hash for request validation
val t : kotlin.String = t_example // kotlin.String | Timestamp for request validation
try {
val result : IamControllersResponse = apiInstance.iamApiControllerRefreshEngines(m, t)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerRefreshEngines")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerRefreshEngines")
e.printStackTrace()
}
Parameters
| m | kotlin.String| Hash for request validation | |
| Name | Type | Description | Notes |
|---|---|---|---|
| t | kotlin.String | Timestamp for request validation |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
iamApiControllerRunSyncer
IamControllersResponse iamApiControllerRunSyncer(iamObjectSyncer)
Api Controller Run Syncer
run syncer
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val iamObjectSyncer : IamObjectSyncer = // IamObjectSyncer | The details of the syncer
try {
val result : IamControllersResponse = apiInstance.iamApiControllerRunSyncer(iamObjectSyncer)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerRunSyncer")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerRunSyncer")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectSyncer | IamObjectSyncer | The details of the syncer |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerSendEmail
IamControllersResponse iamApiControllerSendEmail(clientId, clientSecret, iamControllersEmailForm)
Api Controller Send Email
This API is not for Hanzo IAM frontend to call, it is for Hanzo IAM SDKs.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val clientId : kotlin.String = clientId_example // kotlin.String | The clientId of the application
val clientSecret : kotlin.String = clientSecret_example // kotlin.String | The clientSecret of the application
val iamControllersEmailForm : IamControllersEmailForm = // IamControllersEmailForm | Details of the email request
try {
val result : IamControllersResponse = apiInstance.iamApiControllerSendEmail(clientId, clientSecret, iamControllersEmailForm)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerSendEmail")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerSendEmail")
e.printStackTrace()
}
Parameters
| clientId | kotlin.String| The clientId of the application | | | clientSecret | kotlin.String| The clientSecret of the application | |
| Name | Type | Description | Notes |
|---|---|---|---|
| iamControllersEmailForm | IamControllersEmailForm | Details of the email request |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerSendNotification
IamControllersResponse iamApiControllerSendNotification(iamControllersNotificationForm)
Api Controller Send Notification
This API is not for Hanzo IAM frontend to call, it is for Hanzo IAM SDKs.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val iamControllersNotificationForm : IamControllersNotificationForm = // IamControllersNotificationForm | Details of the notification request
try {
val result : IamControllersResponse = apiInstance.iamApiControllerSendNotification(iamControllersNotificationForm)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerSendNotification")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerSendNotification")
e.printStackTrace()
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| iamControllersNotificationForm | IamControllersNotificationForm | Details of the notification request |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerSendSms
IamControllersResponse iamApiControllerSendSms(clientId, clientSecret, iamControllersSmsForm)
Api Controller Send Sms
This API is not for Hanzo IAM frontend to call, it is for Hanzo IAM SDKs.
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val clientId : kotlin.String = clientId_example // kotlin.String | The clientId of the application
val clientSecret : kotlin.String = clientSecret_example // kotlin.String | The clientSecret of the application
val iamControllersSmsForm : IamControllersSmsForm = // IamControllersSmsForm | Details of the sms request
try {
val result : IamControllersResponse = apiInstance.iamApiControllerSendSms(clientId, clientSecret, iamControllersSmsForm)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerSendSms")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerSendSms")
e.printStackTrace()
}
Parameters
| clientId | kotlin.String| The clientId of the application | | | clientSecret | kotlin.String| The clientSecret of the application | |
| Name | Type | Description | Notes |
|---|---|---|---|
| iamControllersSmsForm | IamControllersSmsForm | Details of the sms request |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerUpdateAdapter
IamControllersResponse iamApiControllerUpdateAdapter(id, iamObjectAdapter)
Api Controller Update Adapter
update adapter
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | The id ( owner/name ) of the adapter
val iamObjectAdapter : IamObjectAdapter = // IamObjectAdapter | The details of the adapter
try {
val result : IamControllersResponse = apiInstance.iamApiControllerUpdateAdapter(id, iamObjectAdapter)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerUpdateAdapter")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerUpdateAdapter")
e.printStackTrace()
}
Parameters
| id | kotlin.String| The id ( owner/name ) of the adapter | |
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectAdapter | IamObjectAdapter | The details of the adapter |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerUpdateCert
IamControllersResponse iamApiControllerUpdateCert(id, iamObjectCert)
Api Controller Update Cert
update cert
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | The id ( owner/name ) of the cert
val iamObjectCert : IamObjectCert = // IamObjectCert | The details of the cert
try {
val result : IamControllersResponse = apiInstance.iamApiControllerUpdateCert(id, iamObjectCert)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerUpdateCert")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerUpdateCert")
e.printStackTrace()
}
Parameters
| id | kotlin.String| The id ( owner/name ) of the cert | |
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectCert | IamObjectCert | The details of the cert |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerUpdateForm
IamControllersResponse iamApiControllerUpdateForm(id, iamObjectForm)
Api Controller Update Form
update form
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | The id (owner/name) of the form
val iamObjectForm : IamObjectForm = // IamObjectForm | The details of the form
try {
val result : IamControllersResponse = apiInstance.iamApiControllerUpdateForm(id, iamObjectForm)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerUpdateForm")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerUpdateForm")
e.printStackTrace()
}
Parameters
| id | kotlin.String| The id (owner/name) of the form | |
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectForm | IamObjectForm | The details of the form |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerUpdateSyncer
IamControllersResponse iamApiControllerUpdateSyncer(id, iamObjectSyncer)
Api Controller Update Syncer
update syncer
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | The id ( owner/name ) of the syncer
val iamObjectSyncer : IamObjectSyncer = // IamObjectSyncer | The details of the syncer
try {
val result : IamControllersResponse = apiInstance.iamApiControllerUpdateSyncer(id, iamObjectSyncer)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerUpdateSyncer")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerUpdateSyncer")
e.printStackTrace()
}
Parameters
| id | kotlin.String| The id ( owner/name ) of the syncer | |
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectSyncer | IamObjectSyncer | The details of the syncer |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
iamApiControllerUpdateTicket
IamControllersResponse iamApiControllerUpdateTicket(id, iamObjectTicket)
Api Controller Update Ticket
update ticket
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
val id : kotlin.String = id_example // kotlin.String | The id ( owner/name ) of the ticket
val iamObjectTicket : IamObjectTicket = // IamObjectTicket | The details of the ticket
try {
val result : IamControllersResponse = apiInstance.iamApiControllerUpdateTicket(id, iamObjectTicket)
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#iamApiControllerUpdateTicket")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#iamApiControllerUpdateTicket")
e.printStackTrace()
}
Parameters
| id | kotlin.String| The id ( owner/name ) of the ticket | |
| Name | Type | Description | Notes |
|---|---|---|---|
| iamObjectTicket | IamObjectTicket | The details of the ticket |
Return type
Authorization
Configure bearerAuth statically:
ApiClient.accessToken = ""
Configure bearerAuth dynamically:
apiInstance.accessTokenProvider = { "" }
HTTP request headers
- Content-Type: application/json
- Accept: application/json
paasListTemplates
kotlin.collections.List<PaasListTemplates200ResponseInner> paasListTemplates()
List available templates
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
try {
val result : kotlin.collections.List<PaasListTemplates200ResponseInner> = apiInstance.paasListTemplates()
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#paasListTemplates")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#paasListTemplates")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
kotlin.collections.List<PaasListTemplates200ResponseInner>
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
tasksTasksCluster
kotlin.collections.Map<kotlin.String, kotlin.Any> tasksTasksCluster()
Cluster status (open probe)
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
try {
val result : kotlin.collections.Map<kotlin.String, kotlin.Any> = apiInstance.tasksTasksCluster()
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#tasksTasksCluster")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#tasksTasksCluster")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
kotlin.collections.Map<kotlin.String, kotlin.Any>
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
tasksTasksClusterHealth
kotlin.collections.Map<kotlin.String, kotlin.Any> tasksTasksClusterHealth()
Cluster health (open probe)
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
try {
val result : kotlin.collections.Map<kotlin.String, kotlin.Any> = apiInstance.tasksTasksClusterHealth()
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#tasksTasksClusterHealth")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#tasksTasksClusterHealth")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
kotlin.collections.Map<kotlin.String, kotlin.Any>
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
tasksTasksHealth
EvalsGetV1EvalsHealth200Response tasksTasksHealth()
Liveness probe
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
try {
val result : EvalsGetV1EvalsHealth200Response = apiInstance.tasksTasksHealth()
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#tasksTasksHealth")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#tasksTasksHealth")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
EvalsGetV1EvalsHealth200Response
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
tasksTasksSettings
kotlin.collections.Map<kotlin.String, kotlin.Any> tasksTasksSettings()
Capability flags (open bootstrap)
Example
// Import classes:
//import ai.hanzo.sdk.infrastructure.*
//import ai.hanzo.sdk.models.*
val apiInstance = SystemApi()
try {
val result : kotlin.collections.Map<kotlin.String, kotlin.Any> = apiInstance.tasksTasksSettings()
println(result)
} catch (e: ClientException) {
println("4xx response calling SystemApi#tasksTasksSettings")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling SystemApi#tasksTasksSettings")
e.printStackTrace()
}
Parameters
This endpoint does not need any parameter.
Return type
kotlin.collections.Map<kotlin.String, kotlin.Any>
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/json