Project: ORY Hydra (Provisioning / Key Management)
File: JwkApi.md

All URIs are relative to http://localhost Method | HTTP request | Description | - | - | Post /admin/keys/{set} | Create JSON Web Key | Delete /admin/keys/{set}/{kid} | Delete JSON Web Key | Delete /admin/keys/{set} | Delete JSON Web Key Set | Get /admin/keys/{set}/{kid} | Get JSON Web Key | Get /admin/keys/{set} | Retrieve a JSON Web Key Set | Put /admin/keys/{set}/{kid} | Set JSON Web Key | Put /admin/keys/{set} | Update a JSON Web Key Set JsonWebKeySet CreateJsonWebKeySet(ctx, set).CreateJsonWebKeySet(createJsonWebKeySet).Execute() Create JSON Web Key ```go package main import ( "context" "fmt" "os" openapiclient "github.com/ory/hydra-client-go/v2" ) func main() { set := "set_example" // string | The JSON Web Key Set ID createJsonWebKeySet := *openapiclient.NewCreateJsonWebKeySet("Algexample", "Kidexample", "Use_example") // CreateJsonWebKeySet | configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.JwkApi.CreateJsonWebKeySet(context.Background(), set).CreateJsonWebKeySet(createJsonWebKeySet).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `JwkApi.CreateJsonWebKeySet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `CreateJsonWebKeySet`: JsonWebKeySet fmt.Fprintf(os.Stdout, "Response from `JwkApi.CreateJsonWebKeySet`: %v\n", resp) } ``` Name | Type | Description | Notes | - | - | - ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. set | string | The JSON Web Key Set ID | Other parameters are passed through a pointer to a apiCreateJsonWebKeySetRequest struct via the builder pattern Name | Type | Description | Notes | - | - | - createJsonWebKeySet | | | No authorization required Content-Type: application/json Accept: application/json DeleteJsonWebKey(ctx, set, kid).Execute() Delete JSON Web Key ```go package main import ( "context" "fmt" "os" openapiclient "github.com/ory/hydra-client-go/v2" ) func main() { set := "set_example" // string | The JSON Web Key Set kid := "kid_example" // string | The JSON Web Key ID (kid) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) r, err := apiClient.JwkApi.DeleteJsonWebKey(context.Background(), set, kid).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `JwkApi.DeleteJsonWebKey``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } } ``` Name | Type | Description | Notes | - | - | - ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. set | string | The JSON Web Key Set | kid | string | The JSON Web Key ID (kid) | Other parameters are passed through a pointer to a apiDeleteJsonWebKeyRequest struct via the builder pattern Name | Type | Description | Notes | - | - | - (empty response body) No authorization required Content-Type: Not defined Accept: application/json DeleteJsonWebKeySet(ctx, set).Execute() Delete JSON Web Key Set ```go package main import ( "context" "fmt" "os" openapiclient "github.com/ory/hydra-client-go/v2" ) func main() { set := "set_example" // string | The JSON Web Key Set configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) r, err := apiClient.JwkApi.DeleteJsonWebKeySet(context.Background(), set).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `JwkApi.DeleteJsonWebKeySet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } } ``` Name | Type | Description | Notes | - | - | - ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. set | string | The JSON Web Key Set | Other parameters are passed through a pointer to a apiDeleteJsonWebKeySetRequest struct via the builder pattern Name | Type | Description | Notes | - | - | - (empty response body) No authorization required Content-Type: Not defined Accept: application/json JsonWebKeySet GetJsonWebKey(ctx, set, kid).Execute() Get JSON Web Key ```go package main import ( "context" "fmt" "os" openapiclient "github.com/ory/hydra-client-go/v2" ) func main() { set := "set_example" // string | JSON Web Key Set ID kid := "kid_example" // string | JSON Web Key ID configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.JwkApi.GetJsonWebKey(context.Background(), set, kid).Execute() if err != nil {

"Error when calling `JwkApi.GetJsonWebKey``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `GetJsonWebKey`: JsonWebKeySet fmt.Fprintf(os.Stdout, "Response from `JwkApi.GetJsonWebKey`: %v\n", resp) } ``` Name | Type | Description | Notes | - | - | - ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. set | string | JSON Web Key Set ID | kid | string | JSON Web Key ID | Other parameters are passed through a pointer to a apiGetJsonWebKeyRequest struct via the builder pattern Name | Type | Description | Notes | - | - | - No authorization required Content-Type: Not defined Accept: application/json JsonWebKeySet GetJsonWebKeySet(ctx, set).Execute() Retrieve a JSON Web Key Set ```go package main import ( "context" "fmt" "os" openapiclient "github.com/ory/hydra-client-go/v2" ) func main() { set := "set_example" // string | JSON Web Key Set ID configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.JwkApi.GetJsonWebKeySet(context.Background(), set).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `JwkApi.GetJsonWebKeySet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `GetJsonWebKeySet`: JsonWebKeySet fmt.Fprintf(os.Stdout, "Response from `JwkApi.GetJsonWebKeySet`: %v\n", resp) } ``` Name | Type | Description | Notes | - | - | - ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. set | string | JSON Web Key Set ID | Other parameters are passed through a pointer to a apiGetJsonWebKeySetRequest struct via the builder pattern Name | Type | Description | Notes | - | - | - No authorization required Content-Type: Not defined Accept: application/json JsonWebKey SetJsonWebKey(ctx, set, kid).JsonWebKey(jsonWebKey).Execute() Set JSON Web Key ```go package main import ( "context" "fmt" "os" openapiclient "github.com/ory/hydra-client-go/v2" ) func main() { set := "set_example" // string | The JSON Web Key Set ID kid := "kid_example" // string | JSON Web Key ID jsonWebKey := *openapiclient.NewJsonWebKey("RS256", "1603dfe0af8f4596", "RSA", "sig") // JsonWebKey | (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.JwkApi.SetJsonWebKey(context.Background(), set, kid).JsonWebKey(jsonWebKey).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `JwkApi.SetJsonWebKey``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `SetJsonWebKey`: JsonWebKey fmt.Fprintf(os.Stdout, "Response from `JwkApi.SetJsonWebKey`: %v\n", resp) } ``` Name | Type | Description | Notes | - | - | - ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. set | string | The JSON Web Key Set ID | kid | string | JSON Web Key ID | Other parameters are passed through a pointer to a apiSetJsonWebKeyRequest struct via the builder pattern Name | Type | Description | Notes | - | - | - jsonWebKey | | | No authorization required Content-Type: application/json Accept: application/json JsonWebKeySet SetJsonWebKeySet(ctx, set).JsonWebKeySet(jsonWebKeySet).Execute() Update a JSON Web Key Set ```go package main import ( "context" "fmt" "os" openapiclient "github.com/ory/hydra-client-go/v2" ) func main() { set := "set_example" // string | The JSON Web Key Set ID jsonWebKeySet := *openapiclient.NewJsonWebKeySet() // JsonWebKeySet | (optional) configuration := openapiclient.NewConfiguration() apiClient := openapiclient.NewAPIClient(configuration) resp, r, err := apiClient.JwkApi.SetJsonWebKeySet(context.Background(), set).JsonWebKeySet(jsonWebKeySet).Execute() if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `JwkApi.SetJsonWebKeySet``: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } // response from `SetJsonWebKeySet`: JsonWebKeySet fmt.Fprintf(os.Stdout, "Response from `JwkApi.SetJsonWebKeySet`: %v\n", resp) } ``` Name | Type | Description | Notes | - | - | - ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. set | string | The JSON Web Key Set ID | Other parameters are passed through a pointer to a apiSetJsonWebKeySetRequest struct via the builder pattern Name | Type | Description | Notes | - | - | - jsonWebKeySet | | | No authorization required Content-Type: application/json Accept: application/json