rbxcloud 0.17.0

CLI and SDK for the Roblox Open Cloud APIs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

# User Restriction API

## Get
Get user restriction information.
```
Usage: rbxcloud user-restriction get [OPTIONS] --universe-id <UNIVERSE_ID> --user-id <USER_ID> --api-key <API_KEY>

Options:
  -u, --universe-id <UNIVERSE_ID>  Universe ID
  -U, --user-id <USER_ID>          User ID
  -P, --place-id <PLACE_ID>        Place ID
  -p, --pretty                     Pretty-print the JSON response
  -a, --api-key <API_KEY>          Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
  -h, --help                       Print help
```

## Update
Update user restriction information.
```
Usage: rbxcloud user-restriction update [OPTIONS] --universe-id <UNIVERSE_ID> --user-id <USER_ID> --api-key <API_KEY>

Options:
  -u, --universe-id <UNIVERSE_ID>        Universe ID
  -U, --user-id <USER_ID>                User ID
  -P, --place-id <PLACE_ID>              Place ID
  -A, --active <ACTIVE>                  Restriction active [possible values: true, false]
  -d, --duration <DURATION>              Restriction duration (seconds)
  -r, --private-reason <PRIVATE_REASON>  Private reason
  -D, --display-reason <DISPLAY_REASON>  Display reason
  -e, --exclude-alts <EXCLUDE_ALTS>      Exclude alternate accounts [possible values: true, false]
  -p, --pretty                           Pretty-print the JSON response
  -a, --api-key <API_KEY>                Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
  -h, --help                             Print help
```

## List
List user restrictions.
```
Usage: rbxcloud user-restriction list [OPTIONS] --universe-id <UNIVERSE_ID> --api-key <API_KEY>

Options:
  -u, --universe-id <UNIVERSE_ID>  Universe ID
  -P, --place-id <PLACE_ID>        Place ID
  -s, --page-size <PAGE_SIZE>      Max page size
  -t, --token <TOKEN>              Next page token
  -f, --filter <FILTER>            Filter
  -p, --pretty                     Pretty-print the JSON response
  -a, --api-key <API_KEY>          Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
  -h, --help                       Print help
```

## Logs
List user restriction logs.
```
Usage: rbxcloud user-restriction logs [OPTIONS] --universe-id <UNIVERSE_ID> --api-key <API_KEY>

Options:
  -u, --universe-id <UNIVERSE_ID>  Universe ID
  -P, --place-id <PLACE_ID>        Place ID
  -s, --page-size <PAGE_SIZE>      Max page size
  -t, --token <TOKEN>              Next page token
  -f, --filter <FILTER>            Filter
  -p, --pretty                     Pretty-print the JSON response
  -a, --api-key <API_KEY>          Roblox Open Cloud API Key [env: RBXCLOUD_API_KEY=]
  -h, --help                       Print help
```