Users
1. users(id=None, **query)
Lists users.
Parameters:
| Name | Type | Description |
|---|---|---|
| id (optional) | String | user id. Provided to get specific user |
| query(optional) | Dict | queries |
Return value: User Object or a list of User Object
Return value example:
username : wangy
email : [email protected]
name : wangy
enabled : True
id : 001d63352c9e4a04abce96b331ea1971
tenantId : 0791bf29fcf442bf8a0f4fd9b5875ee4
username : chao
email : None
name : chao
enabled : True
id : 0591e23306d64bb6bee8fe8660b401ca
tenantId : 97eea2eaf8fa486884be24fbaa492ec3
…
2. create_user(**attr)
Create a user.
Parameters: attr(Dict)
| Name | Type | Description |
|---|---|---|
| tenantID | String | The tenant id. |
| password | String | The user password. |
| enabled | Boolean | Indicates whether the tenant is enabled or disabled. |
| name | String | user name. |
| String | The user email. |
Parameters example:
user = cloud.identity.create_user(email="[email protected]", password=None, enabled=True, name="pytest22", tenantId='97eea2eaf8fa486884be24fbaa492ec3')
Return value: User Object
Return value example:
username : pytest22
name : pytest22
enabled : True
tenantId : 97eea2eaf8fa486884be24fbaa492ec3
id : 24d0a7cd15e440f094d94a4a61462e0e
password : None
email : [email protected]
3. update_user(user_id, **attr)
Updates a user.
Parameters: user_id(string),attr(Dict)
| Name | Type | Description |
|---|---|---|
| tenantID | String | The tenant id. |
| password | String | The user password. |
| enabled | Boolean | Indicates whether the tenant is enabled or disabled. |
| name | String | user name. |
| String | The user email. |
Return value: User Object
Return value example:
username : pytest22
name : pytest22
extra : {u'email': u'[email protected]'}
enabled : True
tenantId : 97eea2eaf8fa486884be24fbaa492ec3
id : 24d0a7cd15e440f094d94a4a61462e0e
password : None
email : [email protected]
4. delete_user(user_id)
Delete a user.
Parameters: user_id(string)
Return value: Status Code
Normal response codes: 204
Error response codes: 413,405,404,403,401,400,503