Skip to content

Latest commit

 

History

History
475 lines (345 loc) · 14 KB

ObjectApikeyApi.md

File metadata and controls

475 lines (345 loc) · 14 KB
Raw

ObjectApikeyApi

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
apikeyCreateObjectV2 POST /2/object/apikey Create a new Apikey
apikeyEditObjectV1 PUT /1/object/apikey/{pkiApikeyID} Edit an existing Apikey
apikeyEditPermissionsV1 PUT /1/object/apikey/{pkiApikeyID}/editPermissions Edit multiple Permissions
apikeyGetCorsV1 GET /1/object/apikey/{pkiApikeyID}/getCors Retrieve an existing Apikey's cors
apikeyGetListV1 GET /1/object/apikey/getList Retrieve Apikey list
apikeyGetObjectV2 GET /2/object/apikey/{pkiApikeyID} Retrieve an existing Apikey
apikeyGetPermissionsV1 GET /1/object/apikey/{pkiApikeyID}/getPermissions Retrieve an existing Apikey's Permissions
apikeyGetSubnetsV1 GET /1/object/apikey/{pkiApikeyID}/getSubnets Retrieve an existing Apikey's subnets
apikeyRegenerateV1 POST /1/object/apikey/{pkiApikeyID}/regenerate Regenerate the Apikey

apikeyCreateObjectV2

ApikeyCreateObjectV2Response apikeyCreateObjectV2(apikeyCreateObjectV2Request)

Create a new Apikey

The endpoint allows to create one or many elements at once.

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectApikeyApi()
val apikeyCreateObjectV2Request : ApikeyCreateObjectV2Request =  // ApikeyCreateObjectV2Request | 
try {
    val result : ApikeyCreateObjectV2Response = apiInstance.apikeyCreateObjectV2(apikeyCreateObjectV2Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectApikeyApi#apikeyCreateObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectApikeyApi#apikeyCreateObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
apikeyCreateObjectV2Request ApikeyCreateObjectV2Request

Return type

ApikeyCreateObjectV2Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

apikeyEditObjectV1

ApikeyEditObjectV1Response apikeyEditObjectV1(pkiApikeyID, apikeyEditObjectV1Request)

Edit an existing Apikey

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectApikeyApi()
val pkiApikeyID : kotlin.Int = 56 // kotlin.Int | The unique ID of the Apikey
val apikeyEditObjectV1Request : ApikeyEditObjectV1Request =  // ApikeyEditObjectV1Request | 
try {
    val result : ApikeyEditObjectV1Response = apiInstance.apikeyEditObjectV1(pkiApikeyID, apikeyEditObjectV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectApikeyApi#apikeyEditObjectV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectApikeyApi#apikeyEditObjectV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiApikeyID kotlin.Int The unique ID of the Apikey
apikeyEditObjectV1Request ApikeyEditObjectV1Request

Return type

ApikeyEditObjectV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

apikeyEditPermissionsV1

ApikeyEditPermissionsV1Response apikeyEditPermissionsV1(pkiApikeyID, apikeyEditPermissionsV1Request)

Edit multiple Permissions

Using this endpoint, you can edit multiple Permissions at the same time.

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectApikeyApi()
val pkiApikeyID : kotlin.Int = 56 // kotlin.Int | 
val apikeyEditPermissionsV1Request : ApikeyEditPermissionsV1Request =  // ApikeyEditPermissionsV1Request | 
try {
    val result : ApikeyEditPermissionsV1Response = apiInstance.apikeyEditPermissionsV1(pkiApikeyID, apikeyEditPermissionsV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectApikeyApi#apikeyEditPermissionsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectApikeyApi#apikeyEditPermissionsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiApikeyID kotlin.Int
apikeyEditPermissionsV1Request ApikeyEditPermissionsV1Request

Return type

ApikeyEditPermissionsV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

apikeyGetCorsV1

ApikeyGetCorsV1Response apikeyGetCorsV1(pkiApikeyID)

Retrieve an existing Apikey's cors

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectApikeyApi()
val pkiApikeyID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : ApikeyGetCorsV1Response = apiInstance.apikeyGetCorsV1(pkiApikeyID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectApikeyApi#apikeyGetCorsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectApikeyApi#apikeyGetCorsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiApikeyID kotlin.Int

Return type

ApikeyGetCorsV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

apikeyGetListV1

ApikeyGetListV1Response apikeyGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)

Retrieve Apikey list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---|

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectApikeyApi()
val eOrderBy : kotlin.String = eOrderBy_example // kotlin.String | Specify how you want the results to be sorted
val iRowMax : kotlin.Int = 56 // kotlin.Int | 
val iRowOffset : kotlin.Int = 56 // kotlin.Int | 
val acceptLanguage : HeaderAcceptLanguage =  // HeaderAcceptLanguage | 
val sFilter : kotlin.String = sFilter_example // kotlin.String | 
try {
    val result : ApikeyGetListV1Response = apiInstance.apikeyGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectApikeyApi#apikeyGetListV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectApikeyApi#apikeyGetListV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
eOrderBy kotlin.String Specify how you want the results to be sorted [optional] [enum: pkiApikeyID_ASC, pkiApikeyID_DESC, sApikeyDescriptionX_ASC, sApikeyDescriptionX_DESC, bApikeyIssigned_ASC, bApikeyIssigned_DESC, bApikeyIsactive_ASC, bApikeyIsactive_DESC, sUserFirstname_ASC, sUserFirstname_DESC, sUserLastname_ASC, sUserLastname_DESC]
iRowMax kotlin.Int [optional]
iRowOffset kotlin.Int [optional] [default to 0]
acceptLanguage HeaderAcceptLanguage [optional] [enum: *, en, fr]
sFilter kotlin.String [optional]

Return type

ApikeyGetListV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

apikeyGetObjectV2

ApikeyGetObjectV2Response apikeyGetObjectV2(pkiApikeyID)

Retrieve an existing Apikey

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectApikeyApi()
val pkiApikeyID : kotlin.Int = 56 // kotlin.Int | The unique ID of the Apikey
try {
    val result : ApikeyGetObjectV2Response = apiInstance.apikeyGetObjectV2(pkiApikeyID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectApikeyApi#apikeyGetObjectV2")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectApikeyApi#apikeyGetObjectV2")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiApikeyID kotlin.Int The unique ID of the Apikey

Return type

ApikeyGetObjectV2Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

apikeyGetPermissionsV1

ApikeyGetPermissionsV1Response apikeyGetPermissionsV1(pkiApikeyID)

Retrieve an existing Apikey's Permissions

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectApikeyApi()
val pkiApikeyID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : ApikeyGetPermissionsV1Response = apiInstance.apikeyGetPermissionsV1(pkiApikeyID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectApikeyApi#apikeyGetPermissionsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectApikeyApi#apikeyGetPermissionsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiApikeyID kotlin.Int

Return type

ApikeyGetPermissionsV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

apikeyGetSubnetsV1

ApikeyGetSubnetsV1Response apikeyGetSubnetsV1(pkiApikeyID)

Retrieve an existing Apikey's subnets

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectApikeyApi()
val pkiApikeyID : kotlin.Int = 56 // kotlin.Int | 
try {
    val result : ApikeyGetSubnetsV1Response = apiInstance.apikeyGetSubnetsV1(pkiApikeyID)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectApikeyApi#apikeyGetSubnetsV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectApikeyApi#apikeyGetSubnetsV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiApikeyID kotlin.Int

Return type

ApikeyGetSubnetsV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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

apikeyRegenerateV1

ApikeyRegenerateV1Response apikeyRegenerateV1(pkiApikeyID, apikeyRegenerateV1Request)

Regenerate the Apikey

Example

// Import classes:
//import eZmaxApi.infrastructure.*
//import eZmaxApi.models.*

val apiInstance = ObjectApikeyApi()
val pkiApikeyID : kotlin.Int = 56 // kotlin.Int | 
val apikeyRegenerateV1Request : ApikeyRegenerateV1Request =  // ApikeyRegenerateV1Request | 
try {
    val result : ApikeyRegenerateV1Response = apiInstance.apikeyRegenerateV1(pkiApikeyID, apikeyRegenerateV1Request)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling ObjectApikeyApi#apikeyRegenerateV1")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling ObjectApikeyApi#apikeyRegenerateV1")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
pkiApikeyID kotlin.Int
apikeyRegenerateV1Request ApikeyRegenerateV1Request

Return type

ApikeyRegenerateV1Response

Authorization

Configure Authorization: ApiClient.apiKey["Authorization"] = "" ApiClient.apiKeyPrefix["Authorization"] = ""

HTTP request headers

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