Skip to content

Latest commit

 

History

History
186 lines (101 loc) · 4.87 KB

Hsk.md

File metadata and controls

186 lines (101 loc) · 4.87 KB

Hsk

Properties

Name Type Description Notes
Kty Pointer to string The key type (EC or RSA) [optional]
Use Pointer to string Get the use of the key on the HSM. When the key use is "sig" (signature), the private key on the HSM is used to sign data and the corresponding public key is used to verify the signature. When the key use is "enc" (encryption), the private key on the HSM is used to decrypt encrypted data which have been encrypted with the corresponding public key [optional]
Kid Pointer to string Key ID for the key on the HSM. [optional]
HsmName Pointer to string The name of the HSM. The identifier for the HSM that sits behind the Authlete server. For example, "google". [optional]
Handle Pointer to string The handle for the key on the HSM. A handle is a base64url-encoded 256-bit random value (43 letters) which is assigned by Authlete on the call of the /api/hsk/create API [optional]
PublicKey Pointer to string The public key that corresponds to the key on the HSM. [optional]

Methods

NewHsk

func NewHsk() *Hsk

NewHsk instantiates a new Hsk object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewHskWithDefaults

func NewHskWithDefaults() *Hsk

NewHskWithDefaults instantiates a new Hsk object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetKty

func (o *Hsk) GetKty() string

GetKty returns the Kty field if non-nil, zero value otherwise.

GetKtyOk

func (o *Hsk) GetKtyOk() (*string, bool)

GetKtyOk returns a tuple with the Kty field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetKty

func (o *Hsk) SetKty(v string)

SetKty sets Kty field to given value.

HasKty

func (o *Hsk) HasKty() bool

HasKty returns a boolean if a field has been set.

GetUse

func (o *Hsk) GetUse() string

GetUse returns the Use field if non-nil, zero value otherwise.

GetUseOk

func (o *Hsk) GetUseOk() (*string, bool)

GetUseOk returns a tuple with the Use field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetUse

func (o *Hsk) SetUse(v string)

SetUse sets Use field to given value.

HasUse

func (o *Hsk) HasUse() bool

HasUse returns a boolean if a field has been set.

GetKid

func (o *Hsk) GetKid() string

GetKid returns the Kid field if non-nil, zero value otherwise.

GetKidOk

func (o *Hsk) GetKidOk() (*string, bool)

GetKidOk returns a tuple with the Kid field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetKid

func (o *Hsk) SetKid(v string)

SetKid sets Kid field to given value.

HasKid

func (o *Hsk) HasKid() bool

HasKid returns a boolean if a field has been set.

GetHsmName

func (o *Hsk) GetHsmName() string

GetHsmName returns the HsmName field if non-nil, zero value otherwise.

GetHsmNameOk

func (o *Hsk) GetHsmNameOk() (*string, bool)

GetHsmNameOk returns a tuple with the HsmName field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHsmName

func (o *Hsk) SetHsmName(v string)

SetHsmName sets HsmName field to given value.

HasHsmName

func (o *Hsk) HasHsmName() bool

HasHsmName returns a boolean if a field has been set.

GetHandle

func (o *Hsk) GetHandle() string

GetHandle returns the Handle field if non-nil, zero value otherwise.

GetHandleOk

func (o *Hsk) GetHandleOk() (*string, bool)

GetHandleOk returns a tuple with the Handle field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetHandle

func (o *Hsk) SetHandle(v string)

SetHandle sets Handle field to given value.

HasHandle

func (o *Hsk) HasHandle() bool

HasHandle returns a boolean if a field has been set.

GetPublicKey

func (o *Hsk) GetPublicKey() string

GetPublicKey returns the PublicKey field if non-nil, zero value otherwise.

GetPublicKeyOk

func (o *Hsk) GetPublicKeyOk() (*string, bool)

GetPublicKeyOk returns a tuple with the PublicKey field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPublicKey

func (o *Hsk) SetPublicKey(v string)

SetPublicKey sets PublicKey field to given value.

HasPublicKey

func (o *Hsk) HasPublicKey() bool

HasPublicKey returns a boolean if a field has been set.

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