Skip to content

User

Bases: DuploResourceV2

apply

Apply a service.

create

Create a new user.

CLI Usage

duploctl user create -f 'user.yaml'
Contents of the user.yaml file
Username: nobody@example.com
Roles:
- User
VpnPassword: "********"
ApiTokens: []
IsReadOnly: false
IsVpnConfigCreated: false
IsVpnConfigUpdated: false
IsConfirmationEmailSent: false
Devspaces:
  IsEnabled: false
  IsAdmin: false
SourceLastRefresh: 0

Parameters:

Name Type Description Default
body BODY

The user body.

required

Returns:

Name Type Description
message dict

A success message.

delete

Delete a User.

CLI Usage
duploctl user delete <name>

Parameters:

Name Type Description Default
name NAME

The name of the user to delete.

required

Returns:

Name Type Description
message dict

A success message.

endpoint

Portal-scoped endpoint for V2 resources.

Returns the path as-is for portal-level resources. This will be overridden by tenant-scoped injection if scope="tenant".

find

Find a User by their username.

list

Retrieve a list of all users in the Duplo system.

wait

Wait for Resource

Waits for a the given wait_check callable to complete successfully. If the global wait_timeout is set on the DuploClient, it will override the timeout parameter so that a user can always choose their own timeout for waiting operations. The timeout param for other functions is just a default value for that particular resource operation.

Parameters:

Name Type Description Default
wait_check callable

A callable function to check if the resource is ready.

required
timeout int

The maximum time to wait in seconds. Default is 3600 seconds (1 hour).

3600
poll int

The polling interval in seconds. Default is 10 seconds.

10