HskOperationsApi.md

\HskOperationsApi

All URIs are relative to https://api.authlete.com

Method	HTTP request	Description
HskCreateApi	Post /api/hsk/create	/api/hsk/create API
HskDeleteApi	Delete /api/hsk/delete/{handle}	/api/hsk/delete/{handle} API
HskGetApi	Get /api/hsk/get/{handle}	/api/hsk/get/{handle} API
HskGetListApi	Get /api/hsk/get/list	/api/hsk/get/list API

HskCreateApi

HskCreateResponse HskCreateApi(ctx).HskCreateRequest(hskCreateRequest).Execute()

/api/hsk/create API

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    hskCreateRequest := *openapiclient.NewHskCreateRequest() // HskCreateRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.HskOperationsApi.HskCreateApi(context.Background()).HskCreateRequest(hskCreateRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `HskOperationsApi.HskCreateApi``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `HskCreateApi`: HskCreateResponse
    fmt.Fprintf(os.Stdout, "Response from `HskOperationsApi.HskCreateApi`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiHskCreateApiRequest struct via the builder pattern

Name	Type	Description	Notes
hskCreateRequest	HskCreateRequest

Return type

HskCreateResponse

Authorization

ServiceOwnerCredentials

HTTP request headers

• Content-Type: application/json, application/x-www-form-urlencoded
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HskDeleteApi

HskDeleteResponse HskDeleteApi(ctx, handle).Execute()

/api/hsk/delete/{handle} API

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    handle := "handle_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.HskOperationsApi.HskDeleteApi(context.Background(), handle).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `HskOperationsApi.HskDeleteApi``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `HskDeleteApi`: HskDeleteResponse
    fmt.Fprintf(os.Stdout, "Response from `HskOperationsApi.HskDeleteApi`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
handle	string

Other Parameters

Other parameters are passed through a pointer to a apiHskDeleteApiRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

HskDeleteResponse

Authorization

ServiceOwnerCredentials

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HskGetApi

HskGetResponse HskGetApi(ctx, handle).Execute()

/api/hsk/get/{handle} API

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    handle := "handle_example" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.HskOperationsApi.HskGetApi(context.Background(), handle).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `HskOperationsApi.HskGetApi``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `HskGetApi`: HskGetResponse
    fmt.Fprintf(os.Stdout, "Response from `HskOperationsApi.HskGetApi`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
handle	string

Other Parameters

Other parameters are passed through a pointer to a apiHskGetApiRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

HskGetResponse

Authorization

ServiceOwnerCredentials

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HskGetListApi

HskGetListResponse HskGetListApi(ctx).Execute()

/api/hsk/get/list API

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.HskOperationsApi.HskGetListApi(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `HskOperationsApi.HskGetListApi``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `HskGetListApi`: HskGetListResponse
    fmt.Fprintf(os.Stdout, "Response from `HskOperationsApi.HskGetListApi`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiHskGetListApiRequest struct via the builder pattern

Return type

HskGetListResponse

Authorization

ServiceOwnerCredentials

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]