Users
This is a simple module that supports listing Users.
Example Syntax
name: List Users
ionoscloudsdk.ionoscloud.user_info: null
register: user_list_response
Returned object
{
"changed": false,
"users": [
{
"entities": {
"groups": {
"href": "https://api.ionos.com/cloudapi/v6/um/users/<USER_ID>/groups",
"id": "<USER_ID>/groups",
"items": null,
"type": "collection"
},
"owns": {
"href": "https://api.ionos.com/cloudapi/v6/um/users/<USER_ID>/owns",
"id": "<USER_ID>/owns",
"items": null,
"type": "collection"
}
},
"href": "https://api.ionos.com/cloudapi/v6/um/users/<USER_ID>",
"id": "<USER_ID>",
"metadata": {
"created_date": "2023-02-09T16:26:34+00:00",
"etag": "37a6259cc0c1dae299a7866489dff0bd",
"last_login": null
},
"properties": {
"active": true,
"administrator": false,
"email": "<EMAIL>",
"firstname": "John",
"force_sec_auth": false,
"lastname": "Doe",
"s3_canonical_user_id": "<s3_canonical_user_id>",
"sec_auth_active": false
},
"type": "user"
},
{
"entities": {
"groups": {
"href": "https://api.ionos.com/cloudapi/v6/um/users/<USER_ID>/groups",
"id": "<USER_ID>/groups",
"items": null,
"type": "collection"
},
"owns": {
"href": "https://api.ionos.com/cloudapi/v6/um/users/<USER_ID>/owns",
"id": "<USER_ID>/owns",
"items": null,
"type": "collection"
}
},
"href": "https://api.ionos.com/cloudapi/v6/um/users/<USER_ID>",
"id": "<USER_ID>",
"metadata": {
"created_date": "2023-08-03T14:07:59+00:00",
"etag": "37a6259cc0c1dae299a7866489dff0bd",
"last_login": null
},
"properties": {
"active": true,
"administrator": false,
"email": "<EMAIL>",
"firstname": "John1",
"force_sec_auth": false,
"lastname": "Doe",
"s3_canonical_user_id": "<s3_canonical_user_id>",
"sec_auth_active": false
},
"type": "user"
}
],
"failed": false
}
For more examples please check out the tests here.
Available parameters:
group str
False
The name or ID of the group.
depth int
False
The depth used when retrieving the items. Default: 1
filters dict
False
Filter that can be used to list only objects which have a certain set of propeties. Filters should be a dict with a key containing keys and value pair in the following format: 'properties.name': 'server_name'
api_url str
False
The Ionos API base URL.
certificate_fingerprint str
False
The Ionos API certificate fingerprint.
username str
False
The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str
False
The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str
False
The Ionos token. Overrides the IONOS_TOKEN environment variable.
Last updated