io7m | single-page | multi-page | epub | Idstore User Manual 1.0.0-beta0001
5.2.22. set
Previous
5.2. Admin Shell Command Reference
Up
5.2.24. user-ban-delete
Next

# 5.2.23. user-ban-create

- 5.2.23.1. Name
- 5.2.23.2. Description
- 5.2.23.3. Example

## 5.2.23.1. Name

1
user-ban-create - Ban a user.

## 5.2.23.2. Description

1
The user-ban-create command creates a new ban for a user.

### 5.2.23.2.2. Parameters

Parameter | Type | Cardinality | Default | Description
--- | --- | --- | --- | ---
--expires-on | java.time.OffsetDateTime | [0, 1] |  | The time/date the ban expires.
--reason | java.lang.String | [1, 1] |  | The ban reason.
--user | java.util.UUID | [1, 1] |  | The user ID.

## 5.2.23.3. Example

### 5.2.23.3.1. Example

    [idstore]# user-ban-create
    > --user 3a193a61-9427-4c24-8bd4-667d19914970
    > --expires-on 2100-01-01T00:00:00+00:00
    > --reason "You did something objectionable"

5.2.22. set
Previous
5.2. Admin Shell Command Reference
Up
5.2.24. user-ban-delete
Next
io7m | single-page | multi-page | epub | Idstore User Manual 1.0.0-beta0001