v1

latestOpenAPI 3.0.42026-08-068161,1253.1 MB

Bans and blocks

Universes

Users

Update User Restriction

Update the user restriction.

patch/cloud/v2/universes/{universe_id}/user-restrictions/{user_restriction_id}

Path parameters

universe_idstring required

The universe ID.

user_restriction_idstring required

The user-restriction ID.

Query parameters

updateMaskstring field-mask

The list of fields to update.

The game_join_restriction field must be updated atomically; field masks that index into game_join_restriction (such as "game_join_restriction.active") are not supported.

idempotencyKey.keystring

The unique key to use for idempotency.

idempotencyKey.firstSentstring date-time

Example:2023-07-05T12:34:56Z

The timestamp at which the first request was sent.

If this is further in the past than the lifetime of the idempotency key (which may exceed the annotated minimum lifetime), the server must return an error.

Request body

pathstring

The resource path of the user restriction.

Formats:

universes/{universe_id}/user-restrictions/{user_restriction_id}
universes/{universe_id}/places/{place_id}/user-restrictions/{user_restriction_id}

updateTimestring date-time

The timestamp when the user restriction was last updated.

userstring

The affected user.

Example request

{
  "path": "universes/123/user-restrictions/123",
  "updateTime": "2023-07-05T12:34:56Z",
  "user": "users/156",
  "gameJoinRestriction": {
    "active": true,
    "startTime": "2023-07-05T12:34:56Z",
    "duration": "3s",
    "privateReason": "some private reason",
    "displayReason": "some display reason",
    "excludeAltAccounts": true,
    "inherited": true
  }
}

Response