admin.users.users#
Collection Note
This module is part of the nokia.eda_core_v1 collection. To install the collection, use:
Added in version0.3.0. Synopsis#
- Description will be added soon.
Parameters#
| Parameter | Defaults / Choices | Comments |
|---|---|---|
| auth_token str required | HTTP authentication (Bearer authentication) string in the format of "Bearer TOKEN". Required unless state is cronly. | |
| base_url str required | EDA API URL including the schema and port (if non standard for the provided schema). Example - https://try.eda.demo:9443. Required unless state is cronly. | |
| ca_path str required | A path to the PEM-encoded CA certificate to use for TLS verification. Required unless state is cronly. | |
| email str | Email address of the user whose user record should be retrieved. | |
| enabled bool | None | |
| first_name str | None | |
| groups list | Contains the UUIDs of the groups of which the user is a member. | |
| last_name str | None | |
| max_sessions int | None | |
| password str | None | |
| state str required | Choices: absent, query, present | State of the requested resource object. |
| status dict | None | |
| tls_skip_verify bool required | A flag to control the TLS verification of the session. Required unless state is cronly. | |
| username str | Username of the user whose user record should be retrieved. | |
| uuid str required | The UUID or userid of the user whose user record should be deleted. |
Authors#
- Roman Dodin (@hellt)