admin.groups.groups#
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. | |
| description str | Description will be added soon. | |
| full-roles bool | If true, the full definitions of the roles associated with the group are returned, rather than just the role names. | |
| full-users bool | If true, the full definitions of the users which are members of the group are returned, rather than just the user names. | |
| isFederated bool | If true, indicates that the group was imported from a federated LDAP server | |
| name str | Name of the groups. Required when state is query or absent. | |
| roles list | Contains the names of the ClusterRoles and Roles roles associated with the group. A Role name has the form namesspace:rolename, whereas a ClusteRole name is a simple rolename, without a colon or a namespace. | |
| state str required | Choices: absent, query, present | State of the requested resource object. |
| tlsSkipVerify bool required | A flag to control the TLS verification of the session. Required unless state is cronly. | |
| users list | Contains the usernames of the users who are members of the group | |
| uuid str required | The UUID of the EDA user group which should be deleted. |
Authors#
- Roman Dodin (@hellt)