Set Registration Mode

PUT

/api/superadmin/config/registration-mode

curl --request PUT \
  --url https://example.com/api/superadmin/config/registration-mode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "mode": "example" }'

Update the platform registration mode.

Valid values: open | invite_only | invite_or_code | closed

Authorizations

• HTTPBearer

Request Body ^required

Media type application/json

SetRegistrationModeRequest

object

mode

required

Mode

string

Example ^generated

{
  "mode": "example"
}

Responses

200

Successful Response

Media type application/json

RegistrationModeResponse

object

mode

required

Mode

string

Example ^generated

{
  "mode": "example"
}

422

Validation Error

Media type application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}