Skip to main content

ExternalProvider API

All URIs are relative to http://localhost:1000

MethodHTTP requestDescription
externalProviderApiKeyCreatePOST /external_provider/api_key/create/external_provider/api_key/create [POST]
externalProviderApiKeyDeletePOST /external_provider/api_key/delete/external_provider/api_key/delete [POST]
externalProviderApiKeyUpdatePOST /external_provider/api_key/update/external_provider/api_key/update [POST]

externalProviderApiKeyCreate

CreatedExternalProviderApiKey externalProviderApiKeyCreate(precreatedExternalProviderApiKey)

/external_provider/api_key/create [POST]

This will create a specific external_provider api_key from a specific user Auth0UserMetadata

Example

// Import classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = ExternalProviderApi()
val precreatedExternalProviderApiKey : PrecreatedExternalProviderApiKey = // PrecreatedExternalProviderApiKey |
try {
val result : CreatedExternalProviderApiKey = apiInstance.externalProviderApiKeyCreate(precreatedExternalProviderApiKey)
println(result)
} catch (e: ClientException) {
println("4xx response calling ExternalProviderApi#externalProviderApiKeyCreate")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ExternalProviderApi#externalProviderApiKeyCreate")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
precreatedExternalProviderApiKeyPrecreatedExternalProviderApiKey[optional]

Return type

CreatedExternalProviderApiKey

Authorization

No authorization required

HTTP request headers

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

externalProviderApiKeyDelete

DeletedExternalProviderApiKey externalProviderApiKeyDelete(predeletedExternalProviderApiKey)

/external_provider/api_key/delete [POST]

This will remove a specific external_provider api_key from a specific user Auth0UserMetadata

Example

// Import classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = ExternalProviderApi()
val predeletedExternalProviderApiKey : PredeletedExternalProviderApiKey = // PredeletedExternalProviderApiKey |
try {
val result : DeletedExternalProviderApiKey = apiInstance.externalProviderApiKeyDelete(predeletedExternalProviderApiKey)
println(result)
} catch (e: ClientException) {
println("4xx response calling ExternalProviderApi#externalProviderApiKeyDelete")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ExternalProviderApi#externalProviderApiKeyDelete")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
predeletedExternalProviderApiKeyPredeletedExternalProviderApiKey[optional]

Return type

DeletedExternalProviderApiKey

Authorization

No authorization required

HTTP request headers

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

externalProviderApiKeyUpdate

UpdatedExternalProviderApiKey externalProviderApiKeyUpdate(preupdatedExternalProviderApiKey)

/external_provider/api_key/update [POST]

This will update a specific external_provider api_key from a specific user Auth0UserMetadata

Example

// Import classes:
import app.pieces.pieces-os-client.infrastructure.*
import app.pieces.pieces-os-client.models.*

val apiInstance = ExternalProviderApi()
val preupdatedExternalProviderApiKey : PreupdatedExternalProviderApiKey = // PreupdatedExternalProviderApiKey |
try {
val result : UpdatedExternalProviderApiKey = apiInstance.externalProviderApiKeyUpdate(preupdatedExternalProviderApiKey)
println(result)
} catch (e: ClientException) {
println("4xx response calling ExternalProviderApi#externalProviderApiKeyUpdate")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling ExternalProviderApi#externalProviderApiKeyUpdate")
e.printStackTrace()
}

Parameters

NameTypeDescriptionNotes
preupdatedExternalProviderApiKeyPreupdatedExternalProviderApiKey[optional]

Return type

UpdatedExternalProviderApiKey

Authorization

No authorization required

HTTP request headers

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