forked from TrueCloudLab/lego
109 lines
6.6 KiB
Go
109 lines
6.6 KiB
Go
package egoscale
|
|
|
|
// User represents a User
|
|
type User struct {
|
|
APIKey string `json:"apikey,omitempty" doc:"the api key of the user"`
|
|
Account string `json:"account,omitempty" doc:"the account name of the user"`
|
|
AccountID *UUID `json:"accountid,omitempty" doc:"the account ID of the user"`
|
|
AccountType int16 `json:"accounttype,omitempty" doc:"the account type of the user"`
|
|
Created string `json:"created,omitempty" doc:"the date and time the user account was created"`
|
|
Domain string `json:"domain,omitempty" doc:"the domain name of the user"`
|
|
DomainID *UUID `json:"domainid,omitempty" doc:"the domain ID of the user"`
|
|
Email string `json:"email,omitempty" doc:"the user email address"`
|
|
FirstName string `json:"firstname,omitempty" doc:"the user firstname"`
|
|
ID *UUID `json:"id,omitempty" doc:"the user ID"`
|
|
IsCallerChildDomain bool `json:"iscallerchilddomain,omitempty" doc:"the boolean value representing if the updating target is in caller's child domain"`
|
|
IsDefault bool `json:"isdefault,omitempty" doc:"true if user is default, false otherwise"`
|
|
LastName string `json:"lastname,omitempty" doc:"the user lastname"`
|
|
RoleID *UUID `json:"roleid,omitempty" doc:"the ID of the role"`
|
|
RoleName string `json:"rolename,omitempty" doc:"the name of the role"`
|
|
RoleType string `json:"roletype,omitempty" doc:"the type of the role"`
|
|
SecretKey string `json:"secretkey,omitempty" doc:"the secret key of the user"`
|
|
State string `json:"state,omitempty" doc:"the user state"`
|
|
Timezone string `json:"timezone,omitempty" doc:"the timezone user was created in"`
|
|
UserName string `json:"username,omitempty" doc:"the user name"`
|
|
}
|
|
|
|
// RegisterUserKeys registers a new set of key of the given user
|
|
//
|
|
// NB: only the APIKey and SecretKey will be filled
|
|
type RegisterUserKeys struct {
|
|
ID *UUID `json:"id" doc:"User id"`
|
|
_ bool `name:"registerUserKeys" description:"This command allows a user to register for the developer API, returning a secret key and an API key. This request is made through the integration API port, so it is a privileged command and must be made on behalf of a user. It is up to the implementer just how the username and password are entered, and then how that translates to an integration API request. Both secret key and API key should be returned to the user"`
|
|
}
|
|
|
|
func (RegisterUserKeys) response() interface{} {
|
|
return new(User)
|
|
}
|
|
|
|
// CreateUser represents the creation of a User
|
|
type CreateUser struct {
|
|
Account string `json:"account" doc:"Creates the user under the specified account. If no account is specified, the username will be used as the account name."`
|
|
Email string `json:"email" doc:"email"`
|
|
FirstName string `json:"firstname" doc:"firstname"`
|
|
LastName string `json:"lastname" doc:"lastname"`
|
|
Password string `json:"password" doc:"Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section."`
|
|
UserName string `json:"username" doc:"Unique username."`
|
|
DomainID *UUID `json:"domainid,omitempty" doc:"Creates the user under the specified domain. Has to be accompanied with the account parameter"`
|
|
Timezone string `json:"timezone,omitempty" doc:"Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format."`
|
|
UserID *UUID `json:"userid,omitempty" doc:"User UUID, required for adding account from external provisioning system"`
|
|
_ bool `name:"createUser" description:"Creates a user for an account that already exists"`
|
|
}
|
|
|
|
func (CreateUser) response() interface{} {
|
|
return new(User)
|
|
}
|
|
|
|
// UpdateUser represents the modification of a User
|
|
type UpdateUser struct {
|
|
ID *UUID `json:"id" doc:"User uuid"`
|
|
Email string `json:"email,omitempty" doc:"email"`
|
|
FirstName string `json:"firstname,omitempty" doc:"first name"`
|
|
LastName string `json:"lastname,omitempty" doc:"last name"`
|
|
Password string `json:"password,omitempty" doc:"Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter"`
|
|
Timezone string `json:"timezone,omitempty" doc:"Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format."`
|
|
UserAPIKey string `json:"userapikey,omitempty" doc:"The API key for the user. Must be specified with userSecretKey"`
|
|
UserName string `json:"username,omitempty" doc:"Unique username"`
|
|
UserSecretKey string `json:"usersecretkey,omitempty" doc:"The secret key for the user. Must be specified with userApiKey"`
|
|
_ bool `name:"updateUser" description:"Updates a user account"`
|
|
}
|
|
|
|
func (UpdateUser) response() interface{} {
|
|
return new(User)
|
|
}
|
|
|
|
// ListUsers represents the search for Users
|
|
type ListUsers struct {
|
|
Account string `json:"account,omitempty" doc:"list resources by account. Must be used with the domainId parameter."`
|
|
AccountType int64 `json:"accounttype,omitempty" doc:"List users by account type. Valid types include admin, domain-admin, read-only-admin, or user."`
|
|
DomainID *UUID `json:"domainid,omitempty" doc:"list only resources belonging to the domain specified"`
|
|
ID *UUID `json:"id,omitempty" doc:"List user by ID."`
|
|
IsRecursive bool `json:"isrecursive,omitempty" doc:"defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves."`
|
|
Keyword string `json:"keyword,omitempty" doc:"List by keyword"`
|
|
ListAll bool `json:"listall,omitempty" doc:"If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false"`
|
|
Page int `json:"page,omitempty"`
|
|
PageSize int `json:"pagesize,omitempty"`
|
|
State string `json:"state,omitempty" doc:"List users by state of the user account."`
|
|
Username string `json:"username,omitempty" doc:"List user by the username"`
|
|
_ bool `name:"listUsers" description:"Lists user accounts"`
|
|
}
|
|
|
|
// ListUsersResponse represents a list of users
|
|
type ListUsersResponse struct {
|
|
Count int `json:"count"`
|
|
User []User `json:"user"`
|
|
}
|
|
|
|
func (ListUsers) response() interface{} {
|
|
return new(ListUsersResponse)
|
|
}
|
|
|
|
// DeleteUser deletes a user for an account
|
|
type DeleteUser struct {
|
|
ID *UUID `json:"id" doc:"id of the user to be deleted"`
|
|
_ bool `name:"deleteUser" description:"Deletes a user for an account"`
|
|
}
|
|
|
|
func (DeleteUser) response() interface{} {
|
|
return new(booleanResponse)
|
|
}
|