All URIs are relative to http://csp.infoblox.com/api/ddi/v1
Method | HTTP request | Description |
---|---|---|
Delete | Delete /keys/kerberos/{id} | Delete the Kerberos key. |
List | Get /keys/kerberos | Retrieve Kerberos keys. |
Read | Get /keys/kerberos/{id} | Retrieve the Kerberos key. |
Update | Patch /keys/kerberos/{id} | Update the Kerberos key. |
Delete(ctx, id).Execute()
Delete the Kerberos key.
package main
import (
"context"
"fmt"
"os"
"github.com/infobloxopen/bloxone-go-client/keys"
)
func main() {
id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource
apiClient := keys.NewAPIClient()
r, err := apiClient.KerberosAPI.Delete(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `KerberosAPI.Delete``: %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. | |
id | string | An application specific resource identity of a resource |
Other parameters are passed through a pointer to a KerberosAPIDeleteRequest
struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListKerberosKeyResponse List(ctx).Fields(fields).Filter(filter).Offset(offset).Limit(limit).PageToken(pageToken).OrderBy(orderBy).Tfilter(tfilter).TorderBy(torderBy).Execute()
Retrieve Kerberos keys.
package main
import (
"context"
"fmt"
"os"
"github.com/infobloxopen/bloxone-go-client/keys"
)
func main() {
apiClient := keys.NewAPIClient()
resp, r, err := apiClient.KerberosAPI.List(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `KerberosAPI.List``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `List`: ListKerberosKeyResponse
fmt.Fprintf(os.Stdout, "Response from `KerberosAPI.List`: %v\n", resp)
}
Other parameters are passed through a pointer to a KerberosAPIListRequest
struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
fields | string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. | |
filter | string | A collection of response resources can be filtered by a logical expression string that includes JSON tag references to values in each resource, literal values, and logical operators. If a resource does not have the specified tag, its value is assumed to be null. Literal values include numbers (integer and floating-point), and quoted (both single- or double-quoted) literal strings, and 'null'. The following operators are commonly used in filter expressions: | Op |
offset | int32 | The integer index (zero-origin) of the offset into a collection of resources. If omitted or null the value is assumed to be '0'. | |
limit | int32 | The integer number of resources to be returned in the response. The service may impose maximum value. If omitted the service may impose a default value. | |
pageToken | string | The service-defined string used to identify a page of resources. A null value indicates the first page. | |
orderBy | string | A collection of response resources can be sorted by their JSON tags. For a 'flat' resource, the tag name is straightforward. If sorting is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, its value is assumed to be null.) Specify this parameter as a comma-separated list of JSON tag names. The sort direction can be specified by a suffix separated by whitespace before the tag name. The suffix 'asc' sorts the data in ascending order. The suffix 'desc' sorts the data in descending order. If no suffix is specified the data is sorted in ascending order. | |
tfilter | string | This parameter is used for filtering by tags. | |
torderBy | string | This parameter is used for sorting by tags. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ReadKerberosKeyResponse Read(ctx, id).Fields(fields).Execute()
Retrieve the Kerberos key.
package main
import (
"context"
"fmt"
"os"
"github.com/infobloxopen/bloxone-go-client/keys"
)
func main() {
id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource
apiClient := keys.NewAPIClient()
resp, r, err := apiClient.KerberosAPI.Read(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `KerberosAPI.Read``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `Read`: ReadKerberosKeyResponse
fmt.Fprintf(os.Stdout, "Response from `KerberosAPI.Read`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | An application specific resource identity of a resource |
Other parameters are passed through a pointer to a KerberosAPIReadRequest
struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
fields | string | A collection of response resources can be transformed by specifying a set of JSON tags to be returned. For a “flat” resource, the tag name is straightforward. If field selection is allowed on non-flat hierarchical resources, the service should implement a qualified naming scheme such as dot-qualification to reference data down the hierarchy. If a resource does not have the specified tag, the tag does not appear in the output resource. Specify this parameter as a comma-separated list of JSON tag names. |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdateKerberosKeyResponse Update(ctx, id).Body(body).Execute()
Update the Kerberos key.
package main
import (
"context"
"fmt"
"os"
"github.com/infobloxopen/bloxone-go-client/keys"
)
func main() {
id := "a5183192-1e00-475f-b334-38e1f0bb1bc7" // string | An application specific resource identity of a resource
body := *keys.NewKerberosKey() // KerberosKey |
apiClient := keys.NewAPIClient()
resp, r, err := apiClient.KerberosAPI.Update(context.Background(), id).Body(body).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `KerberosAPI.Update``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `Update`: UpdateKerberosKeyResponse
fmt.Fprintf(os.Stdout, "Response from `KerberosAPI.Update`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | An application specific resource identity of a resource |
Other parameters are passed through a pointer to a KerberosAPIUpdateRequest
struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
body | KerberosKey |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]