Skip to content
Zautha

Change a member's role

PATCH
/v1/backend/organizations/{organizationId}/memberships/{userId}
curl --request PATCH \
  --url https://api.zautha.com/v1/backend/organizations/example/memberships/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "role": "example" }'

Refused when it would leave the organization without a member who can manage its members and delete it.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
organizationId
required
string
userId
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
role
required
null | string

Example generated

{
  "role": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
id
required
string
/^orgmem_[0-9a-hjkmnp-tv-z]{26}$/
object
required
string
organization
required
object
id
required
string
/^org_[0-9a-hjkmnp-tv-z]{26}$/
object
required
string
name
required
string
slug
required
null | string
max_allowed_memberships
required
integer format: int32
admin_delete_enabled
required
boolean
members_count
required
integer format: int32
created_by
required
One of:
null
public_metadata
required
object
private_metadata
required
object
created_at
required
string format: date-time
updated_at
required
string format: date-time
role
required
string
role_name
required
string
permissions
required
Array<string>
public_metadata
required
object
private_metadata
required
object
public_user_data
required
object
user_id
required
string
/^user_[0-9a-hjkmnp-tv-z]{26}$/
first_name
required
null | string
last_name
required
null | string
identifier
required
string
created_at
required
string format: date-time
updated_at
required
string format: date-time

Example generated

{
  "id": "example",
  "object": "example",
  "organization": {
    "id": "example",
    "object": "example",
    "name": "example",
    "slug": "example",
    "max_allowed_memberships": 1,
    "admin_delete_enabled": true,
    "members_count": 1,
    "created_by": "example",
    "public_metadata": {},
    "private_metadata": {},
    "created_at": "2026-04-15T12:00:00Z",
    "updated_at": "2026-04-15T12:00:00Z"
  },
  "role": "example",
  "role_name": "example",
  "permissions": [
    "example"
  ],
  "public_metadata": {},
  "private_metadata": {},
  "public_user_data": {
    "user_id": "example",
    "first_name": "example",
    "last_name": "example",
    "identifier": "example"
  },
  "created_at": "2026-04-15T12:00:00Z",
  "updated_at": "2026-04-15T12:00:00Z"
}

400

Section titled “400”

The request is malformed, or a field is not valid (validation_failed names each one in errors).

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
trace_id
required
string
reverification
object
level
required
string
Allowed values: first_factor second_factor multi_factor
after_minutes
required
integer format: int32
>= 1 <= 1440
tasks
Array<string>
Allowed values: setup_mfa choose_organization
errors
Array<object>
object
field
required
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
message
required
string

Example 

{
  "code": "bad_request",
  "reverification": {
    "level": "first_factor"
  },
  "tasks": [
    "setup_mfa"
  ],
  "errors": [
    {
      "code": "bad_request"
    }
  ]
}

401

Section titled “401”

The secret key is missing or not valid.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
trace_id
required
string
reverification
object
level
required
string
Allowed values: first_factor second_factor multi_factor
after_minutes
required
integer format: int32
>= 1 <= 1440
tasks
Array<string>
Allowed values: setup_mfa choose_organization
errors
Array<object>
object
field
required
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
message
required
string

Example 

{
  "code": "bad_request",
  "reverification": {
    "level": "first_factor"
  },
  "tasks": [
    "setup_mfa"
  ],
  "errors": [
    {
      "code": "bad_request"
    }
  ]
}

404

Section titled “404”

Not Found.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
trace_id
required
string
reverification
object
level
required
string
Allowed values: first_factor second_factor multi_factor
after_minutes
required
integer format: int32
>= 1 <= 1440
tasks
Array<string>
Allowed values: setup_mfa choose_organization
errors
Array<object>
object
field
required
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
message
required
string

Example 

{
  "code": "bad_request",
  "reverification": {
    "level": "first_factor"
  },
  "tasks": [
    "setup_mfa"
  ],
  "errors": [
    {
      "code": "bad_request"
    }
  ]
}

415

Section titled “415”

Unsupported Media Type.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
trace_id
required
string
reverification
object
level
required
string
Allowed values: first_factor second_factor multi_factor
after_minutes
required
integer format: int32
>= 1 <= 1440
tasks
Array<string>
Allowed values: setup_mfa choose_organization
errors
Array<object>
object
field
required
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
message
required
string

Example 

{
  "code": "bad_request",
  "reverification": {
    "level": "first_factor"
  },
  "tasks": [
    "setup_mfa"
  ],
  "errors": [
    {
      "code": "bad_request"
    }
  ]
}

422

Section titled “422”

Unprocessable Entity.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
trace_id
required
string
reverification
object
level
required
string
Allowed values: first_factor second_factor multi_factor
after_minutes
required
integer format: int32
>= 1 <= 1440
tasks
Array<string>
Allowed values: setup_mfa choose_organization
errors
Array<object>
object
field
required
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
message
required
string

Example 

{
  "code": "bad_request",
  "reverification": {
    "level": "first_factor"
  },
  "tasks": [
    "setup_mfa"
  ],
  "errors": [
    {
      "code": "bad_request"
    }
  ]
}

429

Section titled “429”

Too many requests with this secret key. Retry after the seconds in Retry-After.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
trace_id
required
string
reverification
object
level
required
string
Allowed values: first_factor second_factor multi_factor
after_minutes
required
integer format: int32
>= 1 <= 1440
tasks
Array<string>
Allowed values: setup_mfa choose_organization
errors
Array<object>
object
field
required
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
message
required
string

Example 

{
  "code": "bad_request",
  "reverification": {
    "level": "first_factor"
  },
  "tasks": [
    "setup_mfa"
  ],
  "errors": [
    {
      "code": "bad_request"
    }
  ]
}

Headers

Section titled “Headers”
Retry-After
integer format: int32

Seconds to wait before retrying.

503

Section titled “503”

The service is temporarily unavailable. Try again shortly.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
trace_id
required
string
reverification
object
level
required
string
Allowed values: first_factor second_factor multi_factor
after_minutes
required
integer format: int32
>= 1 <= 1440
tasks
Array<string>
Allowed values: setup_mfa choose_organization
errors
Array<object>
object
field
required
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
message
required
string

Example 

{
  "code": "bad_request",
  "reverification": {
    "level": "first_factor"
  },
  "tasks": [
    "setup_mfa"
  ],
  "errors": [
    {
      "code": "bad_request"
    }
  ]
}