Set the sign-up setting

POST

/api/v1/auth/settings/signup

const url = 'https://example.com/api/v1/auth/settings/signup';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"open_signup":true}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/v1/auth/settings/signup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "open_signup": true }'

Sets the sign-up setting. It requires a signed-in User with the admin scope and the admin or owner Role. It also requires a recent passkey check. It can return 401 if the session is missing or expired, 403 if access is denied and 429 if the request limit is reached. Route: /api/v1/auth/settings/signup. Inputs: . A recent account assertion is required. Do not automatically replay this operation after an uncertain result.

Authorizations

installationBearer
browserSession

Request Body^required

application/json

object

open_signup

required

boolean

Example^generated

{
  "open_signup": true
}

Responses

204

429

application/json

object

code

required

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}

Set the sign-up setting

Authorizations

Request Bodyrequired

Examplegenerated

Responses

204

429

Examplegenerated

Request Body^required

Example^generated

Example^generated