admin.users.users#
Collection Note
This module is part of the nokia.eda_core_v1 collection. To install the collection, use:
Added in version1.0.0. Synopsis#
- Description will be added soon.
Parameters#
| Parameter | Defaults / Choices | Comments |
|---|---|---|
| authToken str required | HTTP authentication (Bearer authentication) string in the format of "Bearer TOKEN". Required unless state is cronly. | |
| baseUrl 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. | |
| caPath 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 | Description will be added soon. | |
| firstName str | Description will be added soon. | |
| groups list | Contains the UUIDs of the groups of which the user is a member. | |
| lastName str | Description will be added soon. | |
| maxSessions int | Description will be added soon. | |
| password str | Description will be added soon. | |
| state str required | Choices: absent, query, present | State of the requested resource object. |
| status dict | Description will be added soon. | |
| tlsSkipVerify 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)