Class UserSecret

Defined in File UserSecret.h

Page Contents

Nested Relationships
- Nested Types
Inheritance Relationships
- Base Type
Class Documentation

Nested Relationships

Nested Types

Class UserSecret::Type

Inheritance Relationships

Base Type

public axr::sdk::EntityBase (Class EntityBase)

Class Documentation

class UserSecret : public axr::sdk::EntityBase 

Public Functions

inline UserSecret()

inline UserSecret(const UserSecret &value)

inline UserSecret(UserSecret &&value)

inline virtual ~UserSecret()

inline virtual UserSecret &SetProperties(const std::map<utility::string_t, Variant> &value) override: Sets the object’s underlying map of stored values.

inline virtual UserSecret &SetProperties(std::map<utility::string_t, Variant> &&value) override: Sets the underlying map of stored values for the object.

inline virtual UserSecret &SetProperty(const utility::char_t *name, const Variant &value) override: Sets the property of the given name to the provided value.

inline virtual UserSecret &SetProperty(const utility::string_t &name, const Variant &value) override: Sets the property of the given name to the provided value.

inline virtual UserSecret &SetRemoteUrl(const utility::string_t &url) override: Returns the URL of the remote server endpoint where the object is managed.

inline virtual UserSecret &SetUid(const utility::string_t &value) override

Sets the value of the Uid property.

Parameters: value – The value to set.

inline virtual UserSecret &SetDateCreated(const datetime &value) override

Sets the value of the DateCreated property.

Parameters: value – The value to set.

inline virtual UserSecret &SetDateModified(const datetime &value) override

Sets the value of the DateModified property.

Parameters: value – The value to set.

inline virtual UserSecret &SetVersion(const uint64_t value) override

Sets the value of the Version property.

Parameters: value – The value to set.

virtual void Validate() override

utility::string_t GetUserId() const: Returns the value of the UserId property as a utility::string_t.

UserSecret &SetUserId(const utility::string_t &value)

Sets the value of the UserId property.

Parameters: value – The value to set.

const Type *GetType() const: Returns the value of the Type property.

UserSecret &SetType(const Type *value)

Sets the value of the Type property.

Parameters: value – The value to set.

utility::string_t GetSecret() const: Returns the value of the Secret property as a utility::string_t.

UserSecret &SetSecret(const utility::string_t &value)

Sets the value of the Secret property.

Parameters: value – The value to set.

Public Static Functions

static inline const utility::char_t *ClassName(): Returns the fully qualified name of the class.

class Type : public axr::sdk::StringEnum<Type>

Public Static Attributes

static const Type *APIKEY

static const Type *DEVICE

static const Type *MFA

static const Type *MFA_BACKUP

static const Type *PASSWORD