1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
|
package users
import (
"net/url"
"strings"
"github.com/gophercloud/gophercloud"
"github.com/gophercloud/gophercloud/openstack/identity/v3/groups"
"github.com/gophercloud/gophercloud/openstack/identity/v3/projects"
"github.com/gophercloud/gophercloud/pagination"
)
// Option is a specific option defined at the API to enable features
// on a user account.
type Option string
const (
IgnoreChangePasswordUponFirstUse Option = "ignore_change_password_upon_first_use"
IgnorePasswordExpiry Option = "ignore_password_expiry"
IgnoreLockoutFailureAttempts Option = "ignore_lockout_failure_attempts"
MultiFactorAuthRules Option = "multi_factor_auth_rules"
MultiFactorAuthEnabled Option = "multi_factor_auth_enabled"
)
// ListOptsBuilder allows extensions to add additional parameters to
// the List request
type ListOptsBuilder interface {
ToUserListQuery() (string, error)
}
// ListOpts provides options to filter the List results.
type ListOpts struct {
// DomainID filters the response by a domain ID.
DomainID string `q:"domain_id"`
// Enabled filters the response by enabled users.
Enabled *bool `q:"enabled"`
// IdpID filters the response by an Identity Provider ID.
IdPID string `q:"idp_id"`
// Name filters the response by username.
Name string `q:"name"`
// PasswordExpiresAt filters the response based on expiring passwords.
PasswordExpiresAt string `q:"password_expires_at"`
// ProtocolID filters the response by protocol ID.
ProtocolID string `q:"protocol_id"`
// UniqueID filters the response by unique ID.
UniqueID string `q:"unique_id"`
// Filters filters the response by custom filters such as
// 'name__contains=foo'
Filters map[string]string `q:"-"`
}
// ToUserListQuery formats a ListOpts into a query string.
func (opts ListOpts) ToUserListQuery() (string, error) {
q, err := gophercloud.BuildQueryString(opts)
if err != nil {
return "", err
}
params := q.Query()
for k, v := range opts.Filters {
i := strings.Index(k, "__")
if i > 0 && i < len(k)-2 {
params.Add(k, v)
} else {
return "", InvalidListFilter{FilterName: k}
}
}
q = &url.URL{RawQuery: params.Encode()}
return q.String(), err
}
// List enumerates the Users to which the current token has access.
func List(client *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager {
url := listURL(client)
if opts != nil {
query, err := opts.ToUserListQuery()
if err != nil {
return pagination.Pager{Err: err}
}
url += query
}
return pagination.NewPager(client, url, func(r pagination.PageResult) pagination.Page {
return UserPage{pagination.LinkedPageBase{PageResult: r}}
})
}
// Get retrieves details on a single user, by ID.
func Get(client *gophercloud.ServiceClient, id string) (r GetResult) {
resp, err := client.Get(getURL(client, id), &r.Body, nil)
_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
return
}
// CreateOptsBuilder allows extensions to add additional parameters to
// the Create request.
type CreateOptsBuilder interface {
ToUserCreateMap() (map[string]interface{}, error)
}
// CreateOpts provides options used to create a user.
type CreateOpts struct {
// Name is the name of the new user.
Name string `json:"name" required:"true"`
// DefaultProjectID is the ID of the default project of the user.
DefaultProjectID string `json:"default_project_id,omitempty"`
// Description is a description of the user.
Description string `json:"description,omitempty"`
// DomainID is the ID of the domain the user belongs to.
DomainID string `json:"domain_id,omitempty"`
// Enabled sets the user status to enabled or disabled.
Enabled *bool `json:"enabled,omitempty"`
// Extra is free-form extra key/value pairs to describe the user.
Extra map[string]interface{} `json:"-"`
// Options are defined options in the API to enable certain features.
Options map[Option]interface{} `json:"options,omitempty"`
// Password is the password of the new user.
Password string `json:"password,omitempty"`
}
// ToUserCreateMap formats a CreateOpts into a create request.
func (opts CreateOpts) ToUserCreateMap() (map[string]interface{}, error) {
b, err := gophercloud.BuildRequestBody(opts, "user")
if err != nil {
return nil, err
}
if opts.Extra != nil {
if v, ok := b["user"].(map[string]interface{}); ok {
for key, value := range opts.Extra {
v[key] = value
}
}
}
return b, nil
}
// Create creates a new User.
func Create(client *gophercloud.ServiceClient, opts CreateOptsBuilder) (r CreateResult) {
b, err := opts.ToUserCreateMap()
if err != nil {
r.Err = err
return
}
resp, err := client.Post(createURL(client), &b, &r.Body, &gophercloud.RequestOpts{
OkCodes: []int{201},
})
_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
return
}
// UpdateOptsBuilder allows extensions to add additional parameters to
// the Update request.
type UpdateOptsBuilder interface {
ToUserUpdateMap() (map[string]interface{}, error)
}
// UpdateOpts provides options for updating a user account.
type UpdateOpts struct {
// Name is the name of the new user.
Name string `json:"name,omitempty"`
// DefaultProjectID is the ID of the default project of the user.
DefaultProjectID string `json:"default_project_id,omitempty"`
// Description is a description of the user.
Description *string `json:"description,omitempty"`
// DomainID is the ID of the domain the user belongs to.
DomainID string `json:"domain_id,omitempty"`
// Enabled sets the user status to enabled or disabled.
Enabled *bool `json:"enabled,omitempty"`
// Extra is free-form extra key/value pairs to describe the user.
Extra map[string]interface{} `json:"-"`
// Options are defined options in the API to enable certain features.
Options map[Option]interface{} `json:"options,omitempty"`
// Password is the password of the new user.
Password string `json:"password,omitempty"`
}
// ToUserUpdateMap formats a UpdateOpts into an update request.
func (opts UpdateOpts) ToUserUpdateMap() (map[string]interface{}, error) {
b, err := gophercloud.BuildRequestBody(opts, "user")
if err != nil {
return nil, err
}
if opts.Extra != nil {
if v, ok := b["user"].(map[string]interface{}); ok {
for key, value := range opts.Extra {
v[key] = value
}
}
}
return b, nil
}
// Update updates an existing User.
func Update(client *gophercloud.ServiceClient, userID string, opts UpdateOptsBuilder) (r UpdateResult) {
b, err := opts.ToUserUpdateMap()
if err != nil {
r.Err = err
return
}
resp, err := client.Patch(updateURL(client, userID), &b, &r.Body, &gophercloud.RequestOpts{
OkCodes: []int{200},
})
_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
return
}
// ChangePasswordOptsBuilder allows extensions to add additional parameters to
// the ChangePassword request.
type ChangePasswordOptsBuilder interface {
ToUserChangePasswordMap() (map[string]interface{}, error)
}
// ChangePasswordOpts provides options for changing password for a user.
type ChangePasswordOpts struct {
// OriginalPassword is the original password of the user.
OriginalPassword string `json:"original_password"`
// Password is the new password of the user.
Password string `json:"password"`
}
// ToUserChangePasswordMap formats a ChangePasswordOpts into a ChangePassword request.
func (opts ChangePasswordOpts) ToUserChangePasswordMap() (map[string]interface{}, error) {
b, err := gophercloud.BuildRequestBody(opts, "user")
if err != nil {
return nil, err
}
return b, nil
}
// ChangePassword changes password for a user.
func ChangePassword(client *gophercloud.ServiceClient, userID string, opts ChangePasswordOptsBuilder) (r ChangePasswordResult) {
b, err := opts.ToUserChangePasswordMap()
if err != nil {
r.Err = err
return
}
resp, err := client.Post(changePasswordURL(client, userID), &b, nil, &gophercloud.RequestOpts{
OkCodes: []int{204},
})
_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
return
}
// Delete deletes a user.
func Delete(client *gophercloud.ServiceClient, userID string) (r DeleteResult) {
resp, err := client.Delete(deleteURL(client, userID), nil)
_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
return
}
// ListGroups enumerates groups user belongs to.
func ListGroups(client *gophercloud.ServiceClient, userID string) pagination.Pager {
url := listGroupsURL(client, userID)
return pagination.NewPager(client, url, func(r pagination.PageResult) pagination.Page {
return groups.GroupPage{LinkedPageBase: pagination.LinkedPageBase{PageResult: r}}
})
}
// AddToGroup adds a user to a group.
func AddToGroup(client *gophercloud.ServiceClient, groupID, userID string) (r AddToGroupResult) {
url := addToGroupURL(client, groupID, userID)
resp, err := client.Put(url, nil, nil, &gophercloud.RequestOpts{
OkCodes: []int{204},
})
_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
return
}
// IsMemberOfGroup checks whether a user belongs to a group.
func IsMemberOfGroup(client *gophercloud.ServiceClient, groupID, userID string) (r IsMemberOfGroupResult) {
url := isMemberOfGroupURL(client, groupID, userID)
resp, err := client.Head(url, &gophercloud.RequestOpts{
OkCodes: []int{204, 404},
})
_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
if r.Err == nil {
if resp.StatusCode == 204 {
r.isMember = true
}
}
return
}
// RemoveFromGroup removes a user from a group.
func RemoveFromGroup(client *gophercloud.ServiceClient, groupID, userID string) (r RemoveFromGroupResult) {
url := removeFromGroupURL(client, groupID, userID)
resp, err := client.Delete(url, &gophercloud.RequestOpts{
OkCodes: []int{204},
})
_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
return
}
// ListProjects enumerates groups user belongs to.
func ListProjects(client *gophercloud.ServiceClient, userID string) pagination.Pager {
url := listProjectsURL(client, userID)
return pagination.NewPager(client, url, func(r pagination.PageResult) pagination.Page {
return projects.ProjectPage{LinkedPageBase: pagination.LinkedPageBase{PageResult: r}}
})
}
// ListInGroup enumerates users that belong to a group.
func ListInGroup(client *gophercloud.ServiceClient, groupID string, opts ListOptsBuilder) pagination.Pager {
url := listInGroupURL(client, groupID)
if opts != nil {
query, err := opts.ToUserListQuery()
if err != nil {
return pagination.Pager{Err: err}
}
url += query
}
return pagination.NewPager(client, url, func(r pagination.PageResult) pagination.Page {
return UserPage{pagination.LinkedPageBase{PageResult: r}}
})
}
|