Set Organization Feature

Sets an organization feature. This activity must be approved by the current root quorum.

POST

/

public

/

v1

/

submit

/

set_organization_feature

Authorizations

API Key

X-Stamp

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

parameters field

Show details

parameters.name

enum<string>

required

Enum options: FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY, FEATURE_NAME_WEBAUTHN_ORIGINS, FEATURE_NAME_EMAIL_AUTH, FEATURE_NAME_EMAIL_RECOVERY, FEATURE_NAME_WEBHOOK, FEATURE_NAME_SMS_AUTH, FEATURE_NAME_OTP_EMAIL_AUTH

parameters.value

string

required

Optional value for the feature. Will override existing values if feature is already set.

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.setOrganizationFeatureIntent

object

required

The setOrganizationFeatureIntent object

Show setOrganizationFeatureIntent details

activity.intent.setOrganizationFeatureIntent.name

enum

required

name field

Enum options: FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY, FEATURE_NAME_WEBAUTHN_ORIGINS, FEATURE_NAME_EMAIL_AUTH, FEATURE_NAME_EMAIL_RECOVERY, FEATURE_NAME_WEBHOOK, FEATURE_NAME_SMS_AUTH, FEATURE_NAME_OTP_EMAIL_AUTH

activity.intent.setOrganizationFeatureIntent.value

string

required

Optional value for the feature. Will override existing values if feature is already set.

activity.result

object

required

The result of the activity

Show result details

activity.result.setOrganizationFeatureResult

object

required

The setOrganizationFeatureResult object

Show setOrganizationFeatureResult details

activity.result.setOrganizationFeatureResult.features

array

required

Resulting list of organization features.

Show features details

activity.result.setOrganizationFeatureResult.features.name

enum

name field

Enum options: FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY, FEATURE_NAME_WEBAUTHN_ORIGINS, FEATURE_NAME_EMAIL_AUTH, FEATURE_NAME_EMAIL_RECOVERY, FEATURE_NAME_WEBHOOK, FEATURE_NAME_SMS_AUTH, FEATURE_NAME_OTP_EMAIL_AUTH

activity.result.setOrganizationFeatureResult.features.value

string

value field

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/set_organization_feature \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "name": "<FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY>",
        "value": "<string>"
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "setOrganizationFeatureIntent": {
            "name": "<FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY>",
            "value": "<string>"
          }
        },
        "result": {
          "setOrganizationFeatureResult": {
            "features": [
              {
                "name": "<FEATURE_NAME_ROOT_USER_EMAIL_RECOVERY>",
                "value": "<string>"
              }
            ]
          }
        }
      }
    }
  }
}