> You are reading the Docusign Developer Documentation. For clean Markdown of any page, append .md to the page URL.
>
> Documentation indexes by section:
> - APIs and SDKs: https://docusign.docs.buildwithfern.com/docs/llms.txt
> - Platform 101: https://docusign.docs.buildwithfern.com/platform/llms.txt
> - Extension Apps: https://docusign.docs.buildwithfern.com/extension-apps/llms.txt
> - Docusign CLI: https://docusign.docs.buildwithfern.com/docusign-cli/llms.txt
>
> Authentication (OAuth, JWT Grant, M2M): https://docusign.docs.buildwithfern.com/platform/auth
> Webhooks and Connect: https://docusign.docs.buildwithfern.com/platform/webhooks
>
> OpenAPI specifications: https://docusign.docs.buildwithfern.com/openapi.json
> MCP server: https://docusign.docs.buildwithfern.com/_mcp/server

# Get event media

GET https://proof-d.docusign.net/restapi/api/v1.0/events/{entityType}/{entityId}/{eventId}/media/{mediaId}

Gets the media item related to a specific event. This call is built using the response to the `list Events` request (see the `include_media` parameter).

### Related topics

- [How to retrieve ID Evidence events](/docs/idevidence-api/how-to/retrieve-idevidence-events/)
- [How to retrieve ID Evidence media](/docs/idevidence-api/how-to/retrieve-idevidence-media/)

Reference: https://developers.docusign.com/docs/idevidence-api/reference/idevidence/events/getmedia

## Authentication

- `Authorization` header (bearer token, required) — A [resource token](/docs/idevidence-api/idevidence101/resource-tokens), sent as `Authorization: Bearer <resource token>`. Get it by calling [EnvelopeRecipients:createRecipientProofFileResourceToken](/docs/esign-rest-api/reference/envelopes/enveloperecipients/createrecipientprooffileresourcetoken) with your OAuth token. A resource token is valid for 2 minutes.

## Servers

- `https://proof-d.docusign.net` (Demo, default)
- `https://proof.docusign.net` (Production)

## Request

### Path parameters

- `eventId` (string, required) — The id of the event as recorded in the database. Optional.
- `mediaId` (string, required) — The id of the media associated with the event. Optional.
- `entityType` (string, required) — The type of the entity (for example room, user or envelope). ID Evidence only supports the `person` (recipient) entity type. Optional.
- `entityId` (string, required) — The id of the Docusign entity. Optional.
- `version` (string, required, default: 1.0) — The requested API version

## Response

### 200

Success

## Errors

### 400 Bad Request Error

Bad Request

- `error` (enum, optional) — The code associated with the error condition.
  - Allowed values: `internal_server_error`, `unauthorized`, `unauthorized_strong_auth_required`, `unauthorized_recent_creds_required`, `unauthorized_strong_auth_and_recent_creds_required`, `unauthorized_jwt_bearer_required`, `invalid_request_parameter_value`, `consent_required`, `proof_locked`, `user_locked`, `not_enough_proofs_for_tfa`, `no_code_submitted`, `invalid_channel`, `tfa_voice_blocked`, `proof_already_exists`, `too_many_proofs`, `too_many_authenticator_apps`, `timespan_out_of_range`, `cant_delete_primary_email_proof`, `password_change_not_allowed`, `email_change_not_allowed`, `cannot_use_same_email`, `invalid_code`, `invalid_organization`, `invalid_organization_name`, `organization_default_account_cannot_be_deleted`, `invalid_organization_admin`, `invalid_organization_admin_user`, `organization_admin_cannot_remove_self`, `admin_email_already_mapped_to_organization`, `admin_user_already_mapped_to_organization`, `invalid_organization_account`, `account_already_mapped_to_an_organization`, `invalid_account`, `invalid_permission_profile`, `invalid_member_group`, `invalid_language_culture`, `invalid_password_reset_inactive_user`, `invalid_password_reset_federated_user`, `invalid_email_change_already_in_use`, `invalid_email_change_federated_user`, `invalid_email_change_domain_reserved`, `max_keys_allowed`, `invalid_user`, `invalid_grant`, `invalid_request`, `no_recovery_info_found`, `user_not_found`, `UserNotFound`, `invalid_term`, `invalid_production_account_id`, `production_account_id_not_admin`, `envelope_not_sent`, `password_change_validation_failed`, `password_validation_questions_count`, `password_validation_complexity`, `password_validation_history`, `password_validation_banned`, `sso_not_allowed`, `username_email_awaiting_activation`, `invalid_email_address`, `invalid_send_activation_request`, `invalid_organization_default_account`, `signup_invalid_invite_token`, `invite_not_enabled_for_client`, `username_email_already_exists`, `IdentityProviderFriendlyNameAlreadyInUse`, `IdentityProviderIssuerAlreadyInUse`, `IdentityProviderInsertFailed`, `invalid_user_default_account`, `max_members_reached`, `invalid_locale`, `OrganizationReservedDomainVerifyFailed`, `OrganizationInvalid`, `OrganizationReservedDomainInvalidHostName`, `OrganizationReservedDomainInsertFailed`, `OrganizationReservedDomainHostNameMismatch`, `OrganizationReservedDomainInvalid`, `OrganizationReservedDomainNotFound`, `OrganizationOrganizationReservedDomainMismatch`, `InvalidModel`, `ClientApplicationMaxReached`, `ClientApplicationDuplicateClientID`, `ClientApplicationInsertFailed`, `ClientApplicationDeleteFailed`, `IdentityProviderInvalid`, `IdentityProviderCertificateInvalid`, `IdentityProviderCertificateMismatch`, `IdentityProviderNotFound`, `OrganizationIdentityProviderMismatch`, `missing_identity_provider_ids`, `AppReviewJobNotFound`, `AppReviewJobInsertFailed`, `AppReviewJobExpired`, `ReactivationOfRedundantMembership`, `appliance_pool_internal_server_error`, `cannot_delete_referenced_appliance_pool`, `cannot_delete_last_appliance`, `appliance_type_mismatch`, `invalid_appliance_id`, `appliance_pool_id_mismatch`, `appliance_pool_id_invalid`, `organization_id_mismatch`, `invalid_appliance_type`, `not_legacy_account`, `account_already_linked`, `no_appliance_in_pool`, `appliance_type_endpoint_mismatch`, `invalid_appliance_status`, `invalid_organization_id`, `appliance_add_error`, `appliance_update_error`, `appliance_get_legacy_error`, `appliance_get_pool_summary_error`, `appliance_health_check_error`, `appliance_account_has_used_pool_error`, `user_identity_not_found`, `partner_not_found`, `invalid_plan_id`, `invalid_distributor_code`, `invalid_account_name`, `create_account_error`, `order_search_invalid`, `invalid_account_id`, `invalid_account_address`, `invalid_account_admin_user`, `partner_account_user_exists`, `partner_account_email_reserved`, `partner_account_domain_managed_by_identity_provider`, `partner_account_email_has_free_trial`, `partner_account_error`, `account_not_associated_with_partner`, `account_not_found`, `account_closed`, `partner_billing_event_not_found`, `partner_event_not_found`, `invalid_partner_id`, `invalid_event_type`, `invalid_status`, `invalid_retry_count`, `partner_id_cannot_be_updated`, `event_type_cannot_be_updated`, `event_date_cannot_be_updated`, `event_trace_token_cannot_be_updated`, `event_correlation_id_cannot_be_updated`, `event_properties_cannot_be_updated`, `event_properties_cannot_be_added`, `invalid_client_id`, `client_not_found`, `plan_not_found`, `partner_has_no_plans`, `plan_not_supported`, `invalid_role_name`, `role_not_found`, `invalid_partner_name`, `partner_name_not_found`, `invalid_user_id`, `invalid_role_id`, `invalid_role`, `partner_id_mismatch`, `invalid_account_seats`, `duplicate_account`, `invalid_address`, `invalid_country`, `invalid_state_province`, `invalid_plan_configuration`, `invalid_product_rate_plan`, `invalid_included_seats`, `invalid_organization_permission`, `invalid_cancellation_reason`, `cancellation_date_not_set`, `directory_provider_not_found`, `directory_provider_feature_already_in_use`, `directory_provider_already_activated`, `directory_provider_organization_entitlement_is_not_allowed`, `invalid_azure_admin`, `invalid_query`, `invalid_organization_delegated_admin`, `delegated_admin_already_exists`, `insufficient_organization_delegated_permission`, `managed_token_not_found`, `managed_token_update_blocked`, `managed_token_update_notpersisted`, `managed_token_redemption_failure`, `managed_token_already_exists`, `managed_token_mismatched_subject_type`, `managed_token_expiration_in_past`, `managed_token_invalid_externalclaims`, `managed_token_resources_too_large`, `redirect_uri_not_registered`, `scopes_invalid`, `non_userbased_token`, `userinvite_not_found`, `userinvite_invalid_token`, `userinvite_invalid_response_type`, `userinvite_invalid_email`, `managedtoken_load_failed`, `managedtoken_create_failed`, `managedtoken_revoke_failed`, `resourcetoken_redeem_failed`, `servicetoken_load_failed`, `userinvite_already_exists`, `userinvite_unmanaged_membership_not_allowed`, `userinvite_account_not_found`, `userinvite_user_mismatch`, `userinvite_account_not_active`, `userinvite_user_not_found`, `userinvite_invalid_use_selection`, `userinvite_membership_already_exists`, `userinvite_bad_request`, `userinvite_request_secret_uri_not_enabled`, `signup_state_too_large`, `signup_invalid_locale`, `too_many_tokens_per_resource_id`, `redirect_uri_used_for_external_claims`, `invalid_account_status_for_action`, `max_audit_log_page_size_exceeded`, `invalid_audit_log_paging_request`, `address_does_not_exist`, `invalid_user_name`, `invalid_user_status`, `partner_missing_properties`, `partner_customer_invalid_license_information`, `partner_license_callback_failed`, `partner_certificate_callback_failed`, `partner_oauth_callback_failed`, `invalid_notification_type`, `invalid_default_account_id`, `user_not_a_member_of_account`, `organization_export_requests_pending`, `organization_export_type_invalid`, `organization_export_request_not_found`, `organization_export_task_processing_timeout`, `organization_export_task_queued_timeout`, `organization_export_task_max_allowed`, `organization_export_task_invalid_resultsetstorage`, `organization_import_not_found`, `organization_import_bad_request_header`, `organization_import_bad_csv_content`, `invalid_id_request`, `invalid_eid_request`, `organization_export_task_not_found`, `proof_service_validation_model_not_found`, `organization_import_processing_timeout`, `proof_service_invalid_model_type`, `proof_service_proof_file_not_exists`, `proof_service_proof_file_bad_owner`, `proof_service_model_validation_failure`, `proof_service_request_entity_too_large`, `proof_service_unreadable_payload`, `proof_service_view_schema_invalid`, `proof_service_front_view_not_exists`, `proof_service_view_schema_not_found`, `proof_service_event_not_found`, `proof_service_event_media_not_found`, `proof_service_event_media_unauthorized`, `proof_service_error`, `proof_service_proof_file_duplicate`, `proof_service_schema_conflict`, `proof_service_view_conflict`, `forbidden`, `invalid_photoid_request`, `invalid_identityweb_resource_request`, `identityweb_manual_review_disabled`, `identityweb_vendor_response_validation_failed`, `organization_import_no_csv_results`, `organization_import_export_pending`, `organization_export_import_pending`, `organization_import_delete_status_queued`, `organization_import_max_records`, `organization_import_max_total_records`, `organization_import_max_account_records`, `organization_import_max_site_records`, `organization_import_max_accounts`, `organization_import_could_not_be_queued`, `organization_import_import_pending`, `organization_import_max_imports`, `principal_throttled`, `service_unavailable`, `invalid_template`, `invalid_admin_communication_principal`, `invalid_admin_communication`, `max_admin_communication_aggregations_exceeded`, `missing_admin_communication_subject`, `unable_to_send_orgadmin_invitation`, `order_already_exists`, `order_not_found`, `order_invalid_product_state`, `order_invalid_state`, `accountproduct_account_not_found`, `invalid_accountproduct`, `accountproduct_update_failed`, `accountproduct_provision_failed`, `freetrial_alreay_claimed`, `accountproduct_activation_failed`, `provision_token_create_failed`, `order_free_trial_already_claimed`, `transaction_management_client_error`, `transaction_management_service_error`, `provision_client_failed`, `accountproduct_cancellation_failed`, `accountproduct_upgrade_failed`, `account_information_not_specified`, `appliance_latest_release_error`, `appliance_release_error`, `appliance_release_file_error`, `auto_activate_member_in_non_active_account`, `organization_export_domain_selection_invalid`, `organization_export_account_selection_invalid`, `invalid_metadata`, `organization_disallowed_for_account`, `unable_to_send_orgaccount_invitation`, `unsupported_principal_type`, `invalid_phone_number`, `identity_session_creation_error`, `invalid_mapping_code`, `create_mobile_session_throttled`, `identity_client_logging_error`, `organization_account_settings_import_imports_pending`, `organization_account_settings_import_exports_pending`, `organization_export_account_settings_import_pending`, `declined_invitation_update_not_allowed`, `accepted_invitation_access_not_allowed`, `missing_current_authenticated_principal_information`, `invalid_caller_information`, `public_key_insert_header_content_invalid`, `public_key_insert_user_public_key_already_existed`, `public_key_insert_unable_to_read_public_key`, `public_key_insert_unable_to_locate_public_key`, `public_key_insert_empty_request_body`, `public_key_unable_to_process_public_key`, `public_key_not_found`, `public_key_id_empty`, `public_key_id_invalid`, `public_key_content_invalid`, `public_key_not_supported`, `public_key_malformatted`, `account_update_failed`, `account_change_plan_failed`, `account_creation_failed`, `accountproduct_invalid_status`, `accountproduct_not_exist`, `accountproduct_expire_failed`, `proofservice_management_disabled`, `invalid_product`, `not_supported`, `identity_workflow_not_found`, `identity_workflow_signature_method_not_found`, `identity_workflow_claim_unknown_provider_type`, `identity_workflow_invalid_externalclaim_properties`, `public_key_api_invalid_modulus`, `public_key_api_invalid_exponent`, `public_key_api_invalid_public_key`, `public_key_api_no_user_mapping_to_given_public_key`, `duplicate_unit_of_measure`, `membership_close_not_allowed`, `immutableid_already_exists`, `organization_has_no_verified_reserved_domains`, `get_account_groups_failed`, `organization_missing_entitlement`, `config_missing_apps_or_values`, `missing_pen_required_claims`, `account_sync_failed`, `invalid_uri`, `invalid_site`, `provision_rest_client_error`, `product_master_entry_not_found`, `provision_orderservicev2_bad_request`, `linked_identity_provider_record_not_found`, `accountproduct_freetrial_not_eligible`, `order_invalid_product`, `protect_api_invalid_action_context`, `protect_api_rules_error`, `protect_api_invalid_recaptcha_configuration`, `protect_api_invalid_recaptcha_verification_error`, `protect_api_invalid_config`, `protect_api_approval_error`, `order_invalid_account`, `order_invalid_source`, `order_invalid_user`, `provision_queue_failure`, `invalid_organization_entitlement`, `product_master_invalid_external_key`, `product_master_entry_invalid_internal_id`, `order_provision_failed`, `protect_api_report_abuse_request_error`, `protect_api_report_abuse_email_error`, `protect_api_report_abuse_error`, `protect_api_report_abuse_config_error`, `protect_api_report_abuse_web_error`, `invalid_region`, `billing_profile_get_failed`, `current_plan_get_failed`, `billing_profile_update_failed`, `billing_profile_account_not_found`, `billing_profile_account_plan_not_found`, `billing_profile_invalid_currency`, `billing_profile_invalid_zuora_id`, `billing_profile_invalid_external_billing_system_id`, `billing_profile_external_billing_usage_start_date_required`, `billing_profile_accountbilling_active_required`, `feature_disabled_in_jump_to_mobile_session`, `requested_format_mismatch`, `organization_entitlement_invalid_rights`, `invalid_image`
- `error_description` (string, optional) — A brief message describing the error condition.
- `error_inner` (string, optional) — The previous exceptions in the call stack.
- `error_stack` (string, optional) — The error stacktrace.
- `reference_id` (string, optional) — The reference identifier corresponding to the trace token.
- `service_error_code` (string, optional) — The service error code.

### 401 Unauthorized Error

Unauthorized

- `error` (enum, optional) — The code associated with the error condition.
  - Allowed values: `internal_server_error`, `unauthorized`, `unauthorized_strong_auth_required`, `unauthorized_recent_creds_required`, `unauthorized_strong_auth_and_recent_creds_required`, `unauthorized_jwt_bearer_required`, `invalid_request_parameter_value`, `consent_required`, `proof_locked`, `user_locked`, `not_enough_proofs_for_tfa`, `no_code_submitted`, `invalid_channel`, `tfa_voice_blocked`, `proof_already_exists`, `too_many_proofs`, `too_many_authenticator_apps`, `timespan_out_of_range`, `cant_delete_primary_email_proof`, `password_change_not_allowed`, `email_change_not_allowed`, `cannot_use_same_email`, `invalid_code`, `invalid_organization`, `invalid_organization_name`, `organization_default_account_cannot_be_deleted`, `invalid_organization_admin`, `invalid_organization_admin_user`, `organization_admin_cannot_remove_self`, `admin_email_already_mapped_to_organization`, `admin_user_already_mapped_to_organization`, `invalid_organization_account`, `account_already_mapped_to_an_organization`, `invalid_account`, `invalid_permission_profile`, `invalid_member_group`, `invalid_language_culture`, `invalid_password_reset_inactive_user`, `invalid_password_reset_federated_user`, `invalid_email_change_already_in_use`, `invalid_email_change_federated_user`, `invalid_email_change_domain_reserved`, `max_keys_allowed`, `invalid_user`, `invalid_grant`, `invalid_request`, `no_recovery_info_found`, `user_not_found`, `UserNotFound`, `invalid_term`, `invalid_production_account_id`, `production_account_id_not_admin`, `envelope_not_sent`, `password_change_validation_failed`, `password_validation_questions_count`, `password_validation_complexity`, `password_validation_history`, `password_validation_banned`, `sso_not_allowed`, `username_email_awaiting_activation`, `invalid_email_address`, `invalid_send_activation_request`, `invalid_organization_default_account`, `signup_invalid_invite_token`, `invite_not_enabled_for_client`, `username_email_already_exists`, `IdentityProviderFriendlyNameAlreadyInUse`, `IdentityProviderIssuerAlreadyInUse`, `IdentityProviderInsertFailed`, `invalid_user_default_account`, `max_members_reached`, `invalid_locale`, `OrganizationReservedDomainVerifyFailed`, `OrganizationInvalid`, `OrganizationReservedDomainInvalidHostName`, `OrganizationReservedDomainInsertFailed`, `OrganizationReservedDomainHostNameMismatch`, `OrganizationReservedDomainInvalid`, `OrganizationReservedDomainNotFound`, `OrganizationOrganizationReservedDomainMismatch`, `InvalidModel`, `ClientApplicationMaxReached`, `ClientApplicationDuplicateClientID`, `ClientApplicationInsertFailed`, `ClientApplicationDeleteFailed`, `IdentityProviderInvalid`, `IdentityProviderCertificateInvalid`, `IdentityProviderCertificateMismatch`, `IdentityProviderNotFound`, `OrganizationIdentityProviderMismatch`, `missing_identity_provider_ids`, `AppReviewJobNotFound`, `AppReviewJobInsertFailed`, `AppReviewJobExpired`, `ReactivationOfRedundantMembership`, `appliance_pool_internal_server_error`, `cannot_delete_referenced_appliance_pool`, `cannot_delete_last_appliance`, `appliance_type_mismatch`, `invalid_appliance_id`, `appliance_pool_id_mismatch`, `appliance_pool_id_invalid`, `organization_id_mismatch`, `invalid_appliance_type`, `not_legacy_account`, `account_already_linked`, `no_appliance_in_pool`, `appliance_type_endpoint_mismatch`, `invalid_appliance_status`, `invalid_organization_id`, `appliance_add_error`, `appliance_update_error`, `appliance_get_legacy_error`, `appliance_get_pool_summary_error`, `appliance_health_check_error`, `appliance_account_has_used_pool_error`, `user_identity_not_found`, `partner_not_found`, `invalid_plan_id`, `invalid_distributor_code`, `invalid_account_name`, `create_account_error`, `order_search_invalid`, `invalid_account_id`, `invalid_account_address`, `invalid_account_admin_user`, `partner_account_user_exists`, `partner_account_email_reserved`, `partner_account_domain_managed_by_identity_provider`, `partner_account_email_has_free_trial`, `partner_account_error`, `account_not_associated_with_partner`, `account_not_found`, `account_closed`, `partner_billing_event_not_found`, `partner_event_not_found`, `invalid_partner_id`, `invalid_event_type`, `invalid_status`, `invalid_retry_count`, `partner_id_cannot_be_updated`, `event_type_cannot_be_updated`, `event_date_cannot_be_updated`, `event_trace_token_cannot_be_updated`, `event_correlation_id_cannot_be_updated`, `event_properties_cannot_be_updated`, `event_properties_cannot_be_added`, `invalid_client_id`, `client_not_found`, `plan_not_found`, `partner_has_no_plans`, `plan_not_supported`, `invalid_role_name`, `role_not_found`, `invalid_partner_name`, `partner_name_not_found`, `invalid_user_id`, `invalid_role_id`, `invalid_role`, `partner_id_mismatch`, `invalid_account_seats`, `duplicate_account`, `invalid_address`, `invalid_country`, `invalid_state_province`, `invalid_plan_configuration`, `invalid_product_rate_plan`, `invalid_included_seats`, `invalid_organization_permission`, `invalid_cancellation_reason`, `cancellation_date_not_set`, `directory_provider_not_found`, `directory_provider_feature_already_in_use`, `directory_provider_already_activated`, `directory_provider_organization_entitlement_is_not_allowed`, `invalid_azure_admin`, `invalid_query`, `invalid_organization_delegated_admin`, `delegated_admin_already_exists`, `insufficient_organization_delegated_permission`, `managed_token_not_found`, `managed_token_update_blocked`, `managed_token_update_notpersisted`, `managed_token_redemption_failure`, `managed_token_already_exists`, `managed_token_mismatched_subject_type`, `managed_token_expiration_in_past`, `managed_token_invalid_externalclaims`, `managed_token_resources_too_large`, `redirect_uri_not_registered`, `scopes_invalid`, `non_userbased_token`, `userinvite_not_found`, `userinvite_invalid_token`, `userinvite_invalid_response_type`, `userinvite_invalid_email`, `managedtoken_load_failed`, `managedtoken_create_failed`, `managedtoken_revoke_failed`, `resourcetoken_redeem_failed`, `servicetoken_load_failed`, `userinvite_already_exists`, `userinvite_unmanaged_membership_not_allowed`, `userinvite_account_not_found`, `userinvite_user_mismatch`, `userinvite_account_not_active`, `userinvite_user_not_found`, `userinvite_invalid_use_selection`, `userinvite_membership_already_exists`, `userinvite_bad_request`, `userinvite_request_secret_uri_not_enabled`, `signup_state_too_large`, `signup_invalid_locale`, `too_many_tokens_per_resource_id`, `redirect_uri_used_for_external_claims`, `invalid_account_status_for_action`, `max_audit_log_page_size_exceeded`, `invalid_audit_log_paging_request`, `address_does_not_exist`, `invalid_user_name`, `invalid_user_status`, `partner_missing_properties`, `partner_customer_invalid_license_information`, `partner_license_callback_failed`, `partner_certificate_callback_failed`, `partner_oauth_callback_failed`, `invalid_notification_type`, `invalid_default_account_id`, `user_not_a_member_of_account`, `organization_export_requests_pending`, `organization_export_type_invalid`, `organization_export_request_not_found`, `organization_export_task_processing_timeout`, `organization_export_task_queued_timeout`, `organization_export_task_max_allowed`, `organization_export_task_invalid_resultsetstorage`, `organization_import_not_found`, `organization_import_bad_request_header`, `organization_import_bad_csv_content`, `invalid_id_request`, `invalid_eid_request`, `organization_export_task_not_found`, `proof_service_validation_model_not_found`, `organization_import_processing_timeout`, `proof_service_invalid_model_type`, `proof_service_proof_file_not_exists`, `proof_service_proof_file_bad_owner`, `proof_service_model_validation_failure`, `proof_service_request_entity_too_large`, `proof_service_unreadable_payload`, `proof_service_view_schema_invalid`, `proof_service_front_view_not_exists`, `proof_service_view_schema_not_found`, `proof_service_event_not_found`, `proof_service_event_media_not_found`, `proof_service_event_media_unauthorized`, `proof_service_error`, `proof_service_proof_file_duplicate`, `proof_service_schema_conflict`, `proof_service_view_conflict`, `forbidden`, `invalid_photoid_request`, `invalid_identityweb_resource_request`, `identityweb_manual_review_disabled`, `identityweb_vendor_response_validation_failed`, `organization_import_no_csv_results`, `organization_import_export_pending`, `organization_export_import_pending`, `organization_import_delete_status_queued`, `organization_import_max_records`, `organization_import_max_total_records`, `organization_import_max_account_records`, `organization_import_max_site_records`, `organization_import_max_accounts`, `organization_import_could_not_be_queued`, `organization_import_import_pending`, `organization_import_max_imports`, `principal_throttled`, `service_unavailable`, `invalid_template`, `invalid_admin_communication_principal`, `invalid_admin_communication`, `max_admin_communication_aggregations_exceeded`, `missing_admin_communication_subject`, `unable_to_send_orgadmin_invitation`, `order_already_exists`, `order_not_found`, `order_invalid_product_state`, `order_invalid_state`, `accountproduct_account_not_found`, `invalid_accountproduct`, `accountproduct_update_failed`, `accountproduct_provision_failed`, `freetrial_alreay_claimed`, `accountproduct_activation_failed`, `provision_token_create_failed`, `order_free_trial_already_claimed`, `transaction_management_client_error`, `transaction_management_service_error`, `provision_client_failed`, `accountproduct_cancellation_failed`, `accountproduct_upgrade_failed`, `account_information_not_specified`, `appliance_latest_release_error`, `appliance_release_error`, `appliance_release_file_error`, `auto_activate_member_in_non_active_account`, `organization_export_domain_selection_invalid`, `organization_export_account_selection_invalid`, `invalid_metadata`, `organization_disallowed_for_account`, `unable_to_send_orgaccount_invitation`, `unsupported_principal_type`, `invalid_phone_number`, `identity_session_creation_error`, `invalid_mapping_code`, `create_mobile_session_throttled`, `identity_client_logging_error`, `organization_account_settings_import_imports_pending`, `organization_account_settings_import_exports_pending`, `organization_export_account_settings_import_pending`, `declined_invitation_update_not_allowed`, `accepted_invitation_access_not_allowed`, `missing_current_authenticated_principal_information`, `invalid_caller_information`, `public_key_insert_header_content_invalid`, `public_key_insert_user_public_key_already_existed`, `public_key_insert_unable_to_read_public_key`, `public_key_insert_unable_to_locate_public_key`, `public_key_insert_empty_request_body`, `public_key_unable_to_process_public_key`, `public_key_not_found`, `public_key_id_empty`, `public_key_id_invalid`, `public_key_content_invalid`, `public_key_not_supported`, `public_key_malformatted`, `account_update_failed`, `account_change_plan_failed`, `account_creation_failed`, `accountproduct_invalid_status`, `accountproduct_not_exist`, `accountproduct_expire_failed`, `proofservice_management_disabled`, `invalid_product`, `not_supported`, `identity_workflow_not_found`, `identity_workflow_signature_method_not_found`, `identity_workflow_claim_unknown_provider_type`, `identity_workflow_invalid_externalclaim_properties`, `public_key_api_invalid_modulus`, `public_key_api_invalid_exponent`, `public_key_api_invalid_public_key`, `public_key_api_no_user_mapping_to_given_public_key`, `duplicate_unit_of_measure`, `membership_close_not_allowed`, `immutableid_already_exists`, `organization_has_no_verified_reserved_domains`, `get_account_groups_failed`, `organization_missing_entitlement`, `config_missing_apps_or_values`, `missing_pen_required_claims`, `account_sync_failed`, `invalid_uri`, `invalid_site`, `provision_rest_client_error`, `product_master_entry_not_found`, `provision_orderservicev2_bad_request`, `linked_identity_provider_record_not_found`, `accountproduct_freetrial_not_eligible`, `order_invalid_product`, `protect_api_invalid_action_context`, `protect_api_rules_error`, `protect_api_invalid_recaptcha_configuration`, `protect_api_invalid_recaptcha_verification_error`, `protect_api_invalid_config`, `protect_api_approval_error`, `order_invalid_account`, `order_invalid_source`, `order_invalid_user`, `provision_queue_failure`, `invalid_organization_entitlement`, `product_master_invalid_external_key`, `product_master_entry_invalid_internal_id`, `order_provision_failed`, `protect_api_report_abuse_request_error`, `protect_api_report_abuse_email_error`, `protect_api_report_abuse_error`, `protect_api_report_abuse_config_error`, `protect_api_report_abuse_web_error`, `invalid_region`, `billing_profile_get_failed`, `current_plan_get_failed`, `billing_profile_update_failed`, `billing_profile_account_not_found`, `billing_profile_account_plan_not_found`, `billing_profile_invalid_currency`, `billing_profile_invalid_zuora_id`, `billing_profile_invalid_external_billing_system_id`, `billing_profile_external_billing_usage_start_date_required`, `billing_profile_accountbilling_active_required`, `feature_disabled_in_jump_to_mobile_session`, `requested_format_mismatch`, `organization_entitlement_invalid_rights`, `invalid_image`
- `error_description` (string, optional) — A brief message describing the error condition.
- `error_inner` (string, optional) — The previous exceptions in the call stack.
- `error_stack` (string, optional) — The error stacktrace.
- `reference_id` (string, optional) — The reference identifier corresponding to the trace token.
- `service_error_code` (string, optional) — The service error code.

### 403 Forbidden Error

Forbidden

- `error` (enum, optional) — The code associated with the error condition.
  - Allowed values: `internal_server_error`, `unauthorized`, `unauthorized_strong_auth_required`, `unauthorized_recent_creds_required`, `unauthorized_strong_auth_and_recent_creds_required`, `unauthorized_jwt_bearer_required`, `invalid_request_parameter_value`, `consent_required`, `proof_locked`, `user_locked`, `not_enough_proofs_for_tfa`, `no_code_submitted`, `invalid_channel`, `tfa_voice_blocked`, `proof_already_exists`, `too_many_proofs`, `too_many_authenticator_apps`, `timespan_out_of_range`, `cant_delete_primary_email_proof`, `password_change_not_allowed`, `email_change_not_allowed`, `cannot_use_same_email`, `invalid_code`, `invalid_organization`, `invalid_organization_name`, `organization_default_account_cannot_be_deleted`, `invalid_organization_admin`, `invalid_organization_admin_user`, `organization_admin_cannot_remove_self`, `admin_email_already_mapped_to_organization`, `admin_user_already_mapped_to_organization`, `invalid_organization_account`, `account_already_mapped_to_an_organization`, `invalid_account`, `invalid_permission_profile`, `invalid_member_group`, `invalid_language_culture`, `invalid_password_reset_inactive_user`, `invalid_password_reset_federated_user`, `invalid_email_change_already_in_use`, `invalid_email_change_federated_user`, `invalid_email_change_domain_reserved`, `max_keys_allowed`, `invalid_user`, `invalid_grant`, `invalid_request`, `no_recovery_info_found`, `user_not_found`, `UserNotFound`, `invalid_term`, `invalid_production_account_id`, `production_account_id_not_admin`, `envelope_not_sent`, `password_change_validation_failed`, `password_validation_questions_count`, `password_validation_complexity`, `password_validation_history`, `password_validation_banned`, `sso_not_allowed`, `username_email_awaiting_activation`, `invalid_email_address`, `invalid_send_activation_request`, `invalid_organization_default_account`, `signup_invalid_invite_token`, `invite_not_enabled_for_client`, `username_email_already_exists`, `IdentityProviderFriendlyNameAlreadyInUse`, `IdentityProviderIssuerAlreadyInUse`, `IdentityProviderInsertFailed`, `invalid_user_default_account`, `max_members_reached`, `invalid_locale`, `OrganizationReservedDomainVerifyFailed`, `OrganizationInvalid`, `OrganizationReservedDomainInvalidHostName`, `OrganizationReservedDomainInsertFailed`, `OrganizationReservedDomainHostNameMismatch`, `OrganizationReservedDomainInvalid`, `OrganizationReservedDomainNotFound`, `OrganizationOrganizationReservedDomainMismatch`, `InvalidModel`, `ClientApplicationMaxReached`, `ClientApplicationDuplicateClientID`, `ClientApplicationInsertFailed`, `ClientApplicationDeleteFailed`, `IdentityProviderInvalid`, `IdentityProviderCertificateInvalid`, `IdentityProviderCertificateMismatch`, `IdentityProviderNotFound`, `OrganizationIdentityProviderMismatch`, `missing_identity_provider_ids`, `AppReviewJobNotFound`, `AppReviewJobInsertFailed`, `AppReviewJobExpired`, `ReactivationOfRedundantMembership`, `appliance_pool_internal_server_error`, `cannot_delete_referenced_appliance_pool`, `cannot_delete_last_appliance`, `appliance_type_mismatch`, `invalid_appliance_id`, `appliance_pool_id_mismatch`, `appliance_pool_id_invalid`, `organization_id_mismatch`, `invalid_appliance_type`, `not_legacy_account`, `account_already_linked`, `no_appliance_in_pool`, `appliance_type_endpoint_mismatch`, `invalid_appliance_status`, `invalid_organization_id`, `appliance_add_error`, `appliance_update_error`, `appliance_get_legacy_error`, `appliance_get_pool_summary_error`, `appliance_health_check_error`, `appliance_account_has_used_pool_error`, `user_identity_not_found`, `partner_not_found`, `invalid_plan_id`, `invalid_distributor_code`, `invalid_account_name`, `create_account_error`, `order_search_invalid`, `invalid_account_id`, `invalid_account_address`, `invalid_account_admin_user`, `partner_account_user_exists`, `partner_account_email_reserved`, `partner_account_domain_managed_by_identity_provider`, `partner_account_email_has_free_trial`, `partner_account_error`, `account_not_associated_with_partner`, `account_not_found`, `account_closed`, `partner_billing_event_not_found`, `partner_event_not_found`, `invalid_partner_id`, `invalid_event_type`, `invalid_status`, `invalid_retry_count`, `partner_id_cannot_be_updated`, `event_type_cannot_be_updated`, `event_date_cannot_be_updated`, `event_trace_token_cannot_be_updated`, `event_correlation_id_cannot_be_updated`, `event_properties_cannot_be_updated`, `event_properties_cannot_be_added`, `invalid_client_id`, `client_not_found`, `plan_not_found`, `partner_has_no_plans`, `plan_not_supported`, `invalid_role_name`, `role_not_found`, `invalid_partner_name`, `partner_name_not_found`, `invalid_user_id`, `invalid_role_id`, `invalid_role`, `partner_id_mismatch`, `invalid_account_seats`, `duplicate_account`, `invalid_address`, `invalid_country`, `invalid_state_province`, `invalid_plan_configuration`, `invalid_product_rate_plan`, `invalid_included_seats`, `invalid_organization_permission`, `invalid_cancellation_reason`, `cancellation_date_not_set`, `directory_provider_not_found`, `directory_provider_feature_already_in_use`, `directory_provider_already_activated`, `directory_provider_organization_entitlement_is_not_allowed`, `invalid_azure_admin`, `invalid_query`, `invalid_organization_delegated_admin`, `delegated_admin_already_exists`, `insufficient_organization_delegated_permission`, `managed_token_not_found`, `managed_token_update_blocked`, `managed_token_update_notpersisted`, `managed_token_redemption_failure`, `managed_token_already_exists`, `managed_token_mismatched_subject_type`, `managed_token_expiration_in_past`, `managed_token_invalid_externalclaims`, `managed_token_resources_too_large`, `redirect_uri_not_registered`, `scopes_invalid`, `non_userbased_token`, `userinvite_not_found`, `userinvite_invalid_token`, `userinvite_invalid_response_type`, `userinvite_invalid_email`, `managedtoken_load_failed`, `managedtoken_create_failed`, `managedtoken_revoke_failed`, `resourcetoken_redeem_failed`, `servicetoken_load_failed`, `userinvite_already_exists`, `userinvite_unmanaged_membership_not_allowed`, `userinvite_account_not_found`, `userinvite_user_mismatch`, `userinvite_account_not_active`, `userinvite_user_not_found`, `userinvite_invalid_use_selection`, `userinvite_membership_already_exists`, `userinvite_bad_request`, `userinvite_request_secret_uri_not_enabled`, `signup_state_too_large`, `signup_invalid_locale`, `too_many_tokens_per_resource_id`, `redirect_uri_used_for_external_claims`, `invalid_account_status_for_action`, `max_audit_log_page_size_exceeded`, `invalid_audit_log_paging_request`, `address_does_not_exist`, `invalid_user_name`, `invalid_user_status`, `partner_missing_properties`, `partner_customer_invalid_license_information`, `partner_license_callback_failed`, `partner_certificate_callback_failed`, `partner_oauth_callback_failed`, `invalid_notification_type`, `invalid_default_account_id`, `user_not_a_member_of_account`, `organization_export_requests_pending`, `organization_export_type_invalid`, `organization_export_request_not_found`, `organization_export_task_processing_timeout`, `organization_export_task_queued_timeout`, `organization_export_task_max_allowed`, `organization_export_task_invalid_resultsetstorage`, `organization_import_not_found`, `organization_import_bad_request_header`, `organization_import_bad_csv_content`, `invalid_id_request`, `invalid_eid_request`, `organization_export_task_not_found`, `proof_service_validation_model_not_found`, `organization_import_processing_timeout`, `proof_service_invalid_model_type`, `proof_service_proof_file_not_exists`, `proof_service_proof_file_bad_owner`, `proof_service_model_validation_failure`, `proof_service_request_entity_too_large`, `proof_service_unreadable_payload`, `proof_service_view_schema_invalid`, `proof_service_front_view_not_exists`, `proof_service_view_schema_not_found`, `proof_service_event_not_found`, `proof_service_event_media_not_found`, `proof_service_event_media_unauthorized`, `proof_service_error`, `proof_service_proof_file_duplicate`, `proof_service_schema_conflict`, `proof_service_view_conflict`, `forbidden`, `invalid_photoid_request`, `invalid_identityweb_resource_request`, `identityweb_manual_review_disabled`, `identityweb_vendor_response_validation_failed`, `organization_import_no_csv_results`, `organization_import_export_pending`, `organization_export_import_pending`, `organization_import_delete_status_queued`, `organization_import_max_records`, `organization_import_max_total_records`, `organization_import_max_account_records`, `organization_import_max_site_records`, `organization_import_max_accounts`, `organization_import_could_not_be_queued`, `organization_import_import_pending`, `organization_import_max_imports`, `principal_throttled`, `service_unavailable`, `invalid_template`, `invalid_admin_communication_principal`, `invalid_admin_communication`, `max_admin_communication_aggregations_exceeded`, `missing_admin_communication_subject`, `unable_to_send_orgadmin_invitation`, `order_already_exists`, `order_not_found`, `order_invalid_product_state`, `order_invalid_state`, `accountproduct_account_not_found`, `invalid_accountproduct`, `accountproduct_update_failed`, `accountproduct_provision_failed`, `freetrial_alreay_claimed`, `accountproduct_activation_failed`, `provision_token_create_failed`, `order_free_trial_already_claimed`, `transaction_management_client_error`, `transaction_management_service_error`, `provision_client_failed`, `accountproduct_cancellation_failed`, `accountproduct_upgrade_failed`, `account_information_not_specified`, `appliance_latest_release_error`, `appliance_release_error`, `appliance_release_file_error`, `auto_activate_member_in_non_active_account`, `organization_export_domain_selection_invalid`, `organization_export_account_selection_invalid`, `invalid_metadata`, `organization_disallowed_for_account`, `unable_to_send_orgaccount_invitation`, `unsupported_principal_type`, `invalid_phone_number`, `identity_session_creation_error`, `invalid_mapping_code`, `create_mobile_session_throttled`, `identity_client_logging_error`, `organization_account_settings_import_imports_pending`, `organization_account_settings_import_exports_pending`, `organization_export_account_settings_import_pending`, `declined_invitation_update_not_allowed`, `accepted_invitation_access_not_allowed`, `missing_current_authenticated_principal_information`, `invalid_caller_information`, `public_key_insert_header_content_invalid`, `public_key_insert_user_public_key_already_existed`, `public_key_insert_unable_to_read_public_key`, `public_key_insert_unable_to_locate_public_key`, `public_key_insert_empty_request_body`, `public_key_unable_to_process_public_key`, `public_key_not_found`, `public_key_id_empty`, `public_key_id_invalid`, `public_key_content_invalid`, `public_key_not_supported`, `public_key_malformatted`, `account_update_failed`, `account_change_plan_failed`, `account_creation_failed`, `accountproduct_invalid_status`, `accountproduct_not_exist`, `accountproduct_expire_failed`, `proofservice_management_disabled`, `invalid_product`, `not_supported`, `identity_workflow_not_found`, `identity_workflow_signature_method_not_found`, `identity_workflow_claim_unknown_provider_type`, `identity_workflow_invalid_externalclaim_properties`, `public_key_api_invalid_modulus`, `public_key_api_invalid_exponent`, `public_key_api_invalid_public_key`, `public_key_api_no_user_mapping_to_given_public_key`, `duplicate_unit_of_measure`, `membership_close_not_allowed`, `immutableid_already_exists`, `organization_has_no_verified_reserved_domains`, `get_account_groups_failed`, `organization_missing_entitlement`, `config_missing_apps_or_values`, `missing_pen_required_claims`, `account_sync_failed`, `invalid_uri`, `invalid_site`, `provision_rest_client_error`, `product_master_entry_not_found`, `provision_orderservicev2_bad_request`, `linked_identity_provider_record_not_found`, `accountproduct_freetrial_not_eligible`, `order_invalid_product`, `protect_api_invalid_action_context`, `protect_api_rules_error`, `protect_api_invalid_recaptcha_configuration`, `protect_api_invalid_recaptcha_verification_error`, `protect_api_invalid_config`, `protect_api_approval_error`, `order_invalid_account`, `order_invalid_source`, `order_invalid_user`, `provision_queue_failure`, `invalid_organization_entitlement`, `product_master_invalid_external_key`, `product_master_entry_invalid_internal_id`, `order_provision_failed`, `protect_api_report_abuse_request_error`, `protect_api_report_abuse_email_error`, `protect_api_report_abuse_error`, `protect_api_report_abuse_config_error`, `protect_api_report_abuse_web_error`, `invalid_region`, `billing_profile_get_failed`, `current_plan_get_failed`, `billing_profile_update_failed`, `billing_profile_account_not_found`, `billing_profile_account_plan_not_found`, `billing_profile_invalid_currency`, `billing_profile_invalid_zuora_id`, `billing_profile_invalid_external_billing_system_id`, `billing_profile_external_billing_usage_start_date_required`, `billing_profile_accountbilling_active_required`, `feature_disabled_in_jump_to_mobile_session`, `requested_format_mismatch`, `organization_entitlement_invalid_rights`, `invalid_image`
- `error_description` (string, optional) — A brief message describing the error condition.
- `error_inner` (string, optional) — The previous exceptions in the call stack.
- `error_stack` (string, optional) — The error stacktrace.
- `reference_id` (string, optional) — The reference identifier corresponding to the trace token.
- `service_error_code` (string, optional) — The service error code.

### 404 Not Found Error

Not Found

- `error` (enum, optional) — The code associated with the error condition.
  - Allowed values: `internal_server_error`, `unauthorized`, `unauthorized_strong_auth_required`, `unauthorized_recent_creds_required`, `unauthorized_strong_auth_and_recent_creds_required`, `unauthorized_jwt_bearer_required`, `invalid_request_parameter_value`, `consent_required`, `proof_locked`, `user_locked`, `not_enough_proofs_for_tfa`, `no_code_submitted`, `invalid_channel`, `tfa_voice_blocked`, `proof_already_exists`, `too_many_proofs`, `too_many_authenticator_apps`, `timespan_out_of_range`, `cant_delete_primary_email_proof`, `password_change_not_allowed`, `email_change_not_allowed`, `cannot_use_same_email`, `invalid_code`, `invalid_organization`, `invalid_organization_name`, `organization_default_account_cannot_be_deleted`, `invalid_organization_admin`, `invalid_organization_admin_user`, `organization_admin_cannot_remove_self`, `admin_email_already_mapped_to_organization`, `admin_user_already_mapped_to_organization`, `invalid_organization_account`, `account_already_mapped_to_an_organization`, `invalid_account`, `invalid_permission_profile`, `invalid_member_group`, `invalid_language_culture`, `invalid_password_reset_inactive_user`, `invalid_password_reset_federated_user`, `invalid_email_change_already_in_use`, `invalid_email_change_federated_user`, `invalid_email_change_domain_reserved`, `max_keys_allowed`, `invalid_user`, `invalid_grant`, `invalid_request`, `no_recovery_info_found`, `user_not_found`, `UserNotFound`, `invalid_term`, `invalid_production_account_id`, `production_account_id_not_admin`, `envelope_not_sent`, `password_change_validation_failed`, `password_validation_questions_count`, `password_validation_complexity`, `password_validation_history`, `password_validation_banned`, `sso_not_allowed`, `username_email_awaiting_activation`, `invalid_email_address`, `invalid_send_activation_request`, `invalid_organization_default_account`, `signup_invalid_invite_token`, `invite_not_enabled_for_client`, `username_email_already_exists`, `IdentityProviderFriendlyNameAlreadyInUse`, `IdentityProviderIssuerAlreadyInUse`, `IdentityProviderInsertFailed`, `invalid_user_default_account`, `max_members_reached`, `invalid_locale`, `OrganizationReservedDomainVerifyFailed`, `OrganizationInvalid`, `OrganizationReservedDomainInvalidHostName`, `OrganizationReservedDomainInsertFailed`, `OrganizationReservedDomainHostNameMismatch`, `OrganizationReservedDomainInvalid`, `OrganizationReservedDomainNotFound`, `OrganizationOrganizationReservedDomainMismatch`, `InvalidModel`, `ClientApplicationMaxReached`, `ClientApplicationDuplicateClientID`, `ClientApplicationInsertFailed`, `ClientApplicationDeleteFailed`, `IdentityProviderInvalid`, `IdentityProviderCertificateInvalid`, `IdentityProviderCertificateMismatch`, `IdentityProviderNotFound`, `OrganizationIdentityProviderMismatch`, `missing_identity_provider_ids`, `AppReviewJobNotFound`, `AppReviewJobInsertFailed`, `AppReviewJobExpired`, `ReactivationOfRedundantMembership`, `appliance_pool_internal_server_error`, `cannot_delete_referenced_appliance_pool`, `cannot_delete_last_appliance`, `appliance_type_mismatch`, `invalid_appliance_id`, `appliance_pool_id_mismatch`, `appliance_pool_id_invalid`, `organization_id_mismatch`, `invalid_appliance_type`, `not_legacy_account`, `account_already_linked`, `no_appliance_in_pool`, `appliance_type_endpoint_mismatch`, `invalid_appliance_status`, `invalid_organization_id`, `appliance_add_error`, `appliance_update_error`, `appliance_get_legacy_error`, `appliance_get_pool_summary_error`, `appliance_health_check_error`, `appliance_account_has_used_pool_error`, `user_identity_not_found`, `partner_not_found`, `invalid_plan_id`, `invalid_distributor_code`, `invalid_account_name`, `create_account_error`, `order_search_invalid`, `invalid_account_id`, `invalid_account_address`, `invalid_account_admin_user`, `partner_account_user_exists`, `partner_account_email_reserved`, `partner_account_domain_managed_by_identity_provider`, `partner_account_email_has_free_trial`, `partner_account_error`, `account_not_associated_with_partner`, `account_not_found`, `account_closed`, `partner_billing_event_not_found`, `partner_event_not_found`, `invalid_partner_id`, `invalid_event_type`, `invalid_status`, `invalid_retry_count`, `partner_id_cannot_be_updated`, `event_type_cannot_be_updated`, `event_date_cannot_be_updated`, `event_trace_token_cannot_be_updated`, `event_correlation_id_cannot_be_updated`, `event_properties_cannot_be_updated`, `event_properties_cannot_be_added`, `invalid_client_id`, `client_not_found`, `plan_not_found`, `partner_has_no_plans`, `plan_not_supported`, `invalid_role_name`, `role_not_found`, `invalid_partner_name`, `partner_name_not_found`, `invalid_user_id`, `invalid_role_id`, `invalid_role`, `partner_id_mismatch`, `invalid_account_seats`, `duplicate_account`, `invalid_address`, `invalid_country`, `invalid_state_province`, `invalid_plan_configuration`, `invalid_product_rate_plan`, `invalid_included_seats`, `invalid_organization_permission`, `invalid_cancellation_reason`, `cancellation_date_not_set`, `directory_provider_not_found`, `directory_provider_feature_already_in_use`, `directory_provider_already_activated`, `directory_provider_organization_entitlement_is_not_allowed`, `invalid_azure_admin`, `invalid_query`, `invalid_organization_delegated_admin`, `delegated_admin_already_exists`, `insufficient_organization_delegated_permission`, `managed_token_not_found`, `managed_token_update_blocked`, `managed_token_update_notpersisted`, `managed_token_redemption_failure`, `managed_token_already_exists`, `managed_token_mismatched_subject_type`, `managed_token_expiration_in_past`, `managed_token_invalid_externalclaims`, `managed_token_resources_too_large`, `redirect_uri_not_registered`, `scopes_invalid`, `non_userbased_token`, `userinvite_not_found`, `userinvite_invalid_token`, `userinvite_invalid_response_type`, `userinvite_invalid_email`, `managedtoken_load_failed`, `managedtoken_create_failed`, `managedtoken_revoke_failed`, `resourcetoken_redeem_failed`, `servicetoken_load_failed`, `userinvite_already_exists`, `userinvite_unmanaged_membership_not_allowed`, `userinvite_account_not_found`, `userinvite_user_mismatch`, `userinvite_account_not_active`, `userinvite_user_not_found`, `userinvite_invalid_use_selection`, `userinvite_membership_already_exists`, `userinvite_bad_request`, `userinvite_request_secret_uri_not_enabled`, `signup_state_too_large`, `signup_invalid_locale`, `too_many_tokens_per_resource_id`, `redirect_uri_used_for_external_claims`, `invalid_account_status_for_action`, `max_audit_log_page_size_exceeded`, `invalid_audit_log_paging_request`, `address_does_not_exist`, `invalid_user_name`, `invalid_user_status`, `partner_missing_properties`, `partner_customer_invalid_license_information`, `partner_license_callback_failed`, `partner_certificate_callback_failed`, `partner_oauth_callback_failed`, `invalid_notification_type`, `invalid_default_account_id`, `user_not_a_member_of_account`, `organization_export_requests_pending`, `organization_export_type_invalid`, `organization_export_request_not_found`, `organization_export_task_processing_timeout`, `organization_export_task_queued_timeout`, `organization_export_task_max_allowed`, `organization_export_task_invalid_resultsetstorage`, `organization_import_not_found`, `organization_import_bad_request_header`, `organization_import_bad_csv_content`, `invalid_id_request`, `invalid_eid_request`, `organization_export_task_not_found`, `proof_service_validation_model_not_found`, `organization_import_processing_timeout`, `proof_service_invalid_model_type`, `proof_service_proof_file_not_exists`, `proof_service_proof_file_bad_owner`, `proof_service_model_validation_failure`, `proof_service_request_entity_too_large`, `proof_service_unreadable_payload`, `proof_service_view_schema_invalid`, `proof_service_front_view_not_exists`, `proof_service_view_schema_not_found`, `proof_service_event_not_found`, `proof_service_event_media_not_found`, `proof_service_event_media_unauthorized`, `proof_service_error`, `proof_service_proof_file_duplicate`, `proof_service_schema_conflict`, `proof_service_view_conflict`, `forbidden`, `invalid_photoid_request`, `invalid_identityweb_resource_request`, `identityweb_manual_review_disabled`, `identityweb_vendor_response_validation_failed`, `organization_import_no_csv_results`, `organization_import_export_pending`, `organization_export_import_pending`, `organization_import_delete_status_queued`, `organization_import_max_records`, `organization_import_max_total_records`, `organization_import_max_account_records`, `organization_import_max_site_records`, `organization_import_max_accounts`, `organization_import_could_not_be_queued`, `organization_import_import_pending`, `organization_import_max_imports`, `principal_throttled`, `service_unavailable`, `invalid_template`, `invalid_admin_communication_principal`, `invalid_admin_communication`, `max_admin_communication_aggregations_exceeded`, `missing_admin_communication_subject`, `unable_to_send_orgadmin_invitation`, `order_already_exists`, `order_not_found`, `order_invalid_product_state`, `order_invalid_state`, `accountproduct_account_not_found`, `invalid_accountproduct`, `accountproduct_update_failed`, `accountproduct_provision_failed`, `freetrial_alreay_claimed`, `accountproduct_activation_failed`, `provision_token_create_failed`, `order_free_trial_already_claimed`, `transaction_management_client_error`, `transaction_management_service_error`, `provision_client_failed`, `accountproduct_cancellation_failed`, `accountproduct_upgrade_failed`, `account_information_not_specified`, `appliance_latest_release_error`, `appliance_release_error`, `appliance_release_file_error`, `auto_activate_member_in_non_active_account`, `organization_export_domain_selection_invalid`, `organization_export_account_selection_invalid`, `invalid_metadata`, `organization_disallowed_for_account`, `unable_to_send_orgaccount_invitation`, `unsupported_principal_type`, `invalid_phone_number`, `identity_session_creation_error`, `invalid_mapping_code`, `create_mobile_session_throttled`, `identity_client_logging_error`, `organization_account_settings_import_imports_pending`, `organization_account_settings_import_exports_pending`, `organization_export_account_settings_import_pending`, `declined_invitation_update_not_allowed`, `accepted_invitation_access_not_allowed`, `missing_current_authenticated_principal_information`, `invalid_caller_information`, `public_key_insert_header_content_invalid`, `public_key_insert_user_public_key_already_existed`, `public_key_insert_unable_to_read_public_key`, `public_key_insert_unable_to_locate_public_key`, `public_key_insert_empty_request_body`, `public_key_unable_to_process_public_key`, `public_key_not_found`, `public_key_id_empty`, `public_key_id_invalid`, `public_key_content_invalid`, `public_key_not_supported`, `public_key_malformatted`, `account_update_failed`, `account_change_plan_failed`, `account_creation_failed`, `accountproduct_invalid_status`, `accountproduct_not_exist`, `accountproduct_expire_failed`, `proofservice_management_disabled`, `invalid_product`, `not_supported`, `identity_workflow_not_found`, `identity_workflow_signature_method_not_found`, `identity_workflow_claim_unknown_provider_type`, `identity_workflow_invalid_externalclaim_properties`, `public_key_api_invalid_modulus`, `public_key_api_invalid_exponent`, `public_key_api_invalid_public_key`, `public_key_api_no_user_mapping_to_given_public_key`, `duplicate_unit_of_measure`, `membership_close_not_allowed`, `immutableid_already_exists`, `organization_has_no_verified_reserved_domains`, `get_account_groups_failed`, `organization_missing_entitlement`, `config_missing_apps_or_values`, `missing_pen_required_claims`, `account_sync_failed`, `invalid_uri`, `invalid_site`, `provision_rest_client_error`, `product_master_entry_not_found`, `provision_orderservicev2_bad_request`, `linked_identity_provider_record_not_found`, `accountproduct_freetrial_not_eligible`, `order_invalid_product`, `protect_api_invalid_action_context`, `protect_api_rules_error`, `protect_api_invalid_recaptcha_configuration`, `protect_api_invalid_recaptcha_verification_error`, `protect_api_invalid_config`, `protect_api_approval_error`, `order_invalid_account`, `order_invalid_source`, `order_invalid_user`, `provision_queue_failure`, `invalid_organization_entitlement`, `product_master_invalid_external_key`, `product_master_entry_invalid_internal_id`, `order_provision_failed`, `protect_api_report_abuse_request_error`, `protect_api_report_abuse_email_error`, `protect_api_report_abuse_error`, `protect_api_report_abuse_config_error`, `protect_api_report_abuse_web_error`, `invalid_region`, `billing_profile_get_failed`, `current_plan_get_failed`, `billing_profile_update_failed`, `billing_profile_account_not_found`, `billing_profile_account_plan_not_found`, `billing_profile_invalid_currency`, `billing_profile_invalid_zuora_id`, `billing_profile_invalid_external_billing_system_id`, `billing_profile_external_billing_usage_start_date_required`, `billing_profile_accountbilling_active_required`, `feature_disabled_in_jump_to_mobile_session`, `requested_format_mismatch`, `organization_entitlement_invalid_rights`, `invalid_image`
- `error_description` (string, optional) — A brief message describing the error condition.
- `error_inner` (string, optional) — The previous exceptions in the call stack.
- `error_stack` (string, optional) — The error stacktrace.
- `reference_id` (string, optional) — The reference identifier corresponding to the trace token.
- `service_error_code` (string, optional) — The service error code.

### 412 Precondition Failed Error

Client Error

- `error` (enum, optional) — The code associated with the error condition.
  - Allowed values: `internal_server_error`, `unauthorized`, `unauthorized_strong_auth_required`, `unauthorized_recent_creds_required`, `unauthorized_strong_auth_and_recent_creds_required`, `unauthorized_jwt_bearer_required`, `invalid_request_parameter_value`, `consent_required`, `proof_locked`, `user_locked`, `not_enough_proofs_for_tfa`, `no_code_submitted`, `invalid_channel`, `tfa_voice_blocked`, `proof_already_exists`, `too_many_proofs`, `too_many_authenticator_apps`, `timespan_out_of_range`, `cant_delete_primary_email_proof`, `password_change_not_allowed`, `email_change_not_allowed`, `cannot_use_same_email`, `invalid_code`, `invalid_organization`, `invalid_organization_name`, `organization_default_account_cannot_be_deleted`, `invalid_organization_admin`, `invalid_organization_admin_user`, `organization_admin_cannot_remove_self`, `admin_email_already_mapped_to_organization`, `admin_user_already_mapped_to_organization`, `invalid_organization_account`, `account_already_mapped_to_an_organization`, `invalid_account`, `invalid_permission_profile`, `invalid_member_group`, `invalid_language_culture`, `invalid_password_reset_inactive_user`, `invalid_password_reset_federated_user`, `invalid_email_change_already_in_use`, `invalid_email_change_federated_user`, `invalid_email_change_domain_reserved`, `max_keys_allowed`, `invalid_user`, `invalid_grant`, `invalid_request`, `no_recovery_info_found`, `user_not_found`, `UserNotFound`, `invalid_term`, `invalid_production_account_id`, `production_account_id_not_admin`, `envelope_not_sent`, `password_change_validation_failed`, `password_validation_questions_count`, `password_validation_complexity`, `password_validation_history`, `password_validation_banned`, `sso_not_allowed`, `username_email_awaiting_activation`, `invalid_email_address`, `invalid_send_activation_request`, `invalid_organization_default_account`, `signup_invalid_invite_token`, `invite_not_enabled_for_client`, `username_email_already_exists`, `IdentityProviderFriendlyNameAlreadyInUse`, `IdentityProviderIssuerAlreadyInUse`, `IdentityProviderInsertFailed`, `invalid_user_default_account`, `max_members_reached`, `invalid_locale`, `OrganizationReservedDomainVerifyFailed`, `OrganizationInvalid`, `OrganizationReservedDomainInvalidHostName`, `OrganizationReservedDomainInsertFailed`, `OrganizationReservedDomainHostNameMismatch`, `OrganizationReservedDomainInvalid`, `OrganizationReservedDomainNotFound`, `OrganizationOrganizationReservedDomainMismatch`, `InvalidModel`, `ClientApplicationMaxReached`, `ClientApplicationDuplicateClientID`, `ClientApplicationInsertFailed`, `ClientApplicationDeleteFailed`, `IdentityProviderInvalid`, `IdentityProviderCertificateInvalid`, `IdentityProviderCertificateMismatch`, `IdentityProviderNotFound`, `OrganizationIdentityProviderMismatch`, `missing_identity_provider_ids`, `AppReviewJobNotFound`, `AppReviewJobInsertFailed`, `AppReviewJobExpired`, `ReactivationOfRedundantMembership`, `appliance_pool_internal_server_error`, `cannot_delete_referenced_appliance_pool`, `cannot_delete_last_appliance`, `appliance_type_mismatch`, `invalid_appliance_id`, `appliance_pool_id_mismatch`, `appliance_pool_id_invalid`, `organization_id_mismatch`, `invalid_appliance_type`, `not_legacy_account`, `account_already_linked`, `no_appliance_in_pool`, `appliance_type_endpoint_mismatch`, `invalid_appliance_status`, `invalid_organization_id`, `appliance_add_error`, `appliance_update_error`, `appliance_get_legacy_error`, `appliance_get_pool_summary_error`, `appliance_health_check_error`, `appliance_account_has_used_pool_error`, `user_identity_not_found`, `partner_not_found`, `invalid_plan_id`, `invalid_distributor_code`, `invalid_account_name`, `create_account_error`, `order_search_invalid`, `invalid_account_id`, `invalid_account_address`, `invalid_account_admin_user`, `partner_account_user_exists`, `partner_account_email_reserved`, `partner_account_domain_managed_by_identity_provider`, `partner_account_email_has_free_trial`, `partner_account_error`, `account_not_associated_with_partner`, `account_not_found`, `account_closed`, `partner_billing_event_not_found`, `partner_event_not_found`, `invalid_partner_id`, `invalid_event_type`, `invalid_status`, `invalid_retry_count`, `partner_id_cannot_be_updated`, `event_type_cannot_be_updated`, `event_date_cannot_be_updated`, `event_trace_token_cannot_be_updated`, `event_correlation_id_cannot_be_updated`, `event_properties_cannot_be_updated`, `event_properties_cannot_be_added`, `invalid_client_id`, `client_not_found`, `plan_not_found`, `partner_has_no_plans`, `plan_not_supported`, `invalid_role_name`, `role_not_found`, `invalid_partner_name`, `partner_name_not_found`, `invalid_user_id`, `invalid_role_id`, `invalid_role`, `partner_id_mismatch`, `invalid_account_seats`, `duplicate_account`, `invalid_address`, `invalid_country`, `invalid_state_province`, `invalid_plan_configuration`, `invalid_product_rate_plan`, `invalid_included_seats`, `invalid_organization_permission`, `invalid_cancellation_reason`, `cancellation_date_not_set`, `directory_provider_not_found`, `directory_provider_feature_already_in_use`, `directory_provider_already_activated`, `directory_provider_organization_entitlement_is_not_allowed`, `invalid_azure_admin`, `invalid_query`, `invalid_organization_delegated_admin`, `delegated_admin_already_exists`, `insufficient_organization_delegated_permission`, `managed_token_not_found`, `managed_token_update_blocked`, `managed_token_update_notpersisted`, `managed_token_redemption_failure`, `managed_token_already_exists`, `managed_token_mismatched_subject_type`, `managed_token_expiration_in_past`, `managed_token_invalid_externalclaims`, `managed_token_resources_too_large`, `redirect_uri_not_registered`, `scopes_invalid`, `non_userbased_token`, `userinvite_not_found`, `userinvite_invalid_token`, `userinvite_invalid_response_type`, `userinvite_invalid_email`, `managedtoken_load_failed`, `managedtoken_create_failed`, `managedtoken_revoke_failed`, `resourcetoken_redeem_failed`, `servicetoken_load_failed`, `userinvite_already_exists`, `userinvite_unmanaged_membership_not_allowed`, `userinvite_account_not_found`, `userinvite_user_mismatch`, `userinvite_account_not_active`, `userinvite_user_not_found`, `userinvite_invalid_use_selection`, `userinvite_membership_already_exists`, `userinvite_bad_request`, `userinvite_request_secret_uri_not_enabled`, `signup_state_too_large`, `signup_invalid_locale`, `too_many_tokens_per_resource_id`, `redirect_uri_used_for_external_claims`, `invalid_account_status_for_action`, `max_audit_log_page_size_exceeded`, `invalid_audit_log_paging_request`, `address_does_not_exist`, `invalid_user_name`, `invalid_user_status`, `partner_missing_properties`, `partner_customer_invalid_license_information`, `partner_license_callback_failed`, `partner_certificate_callback_failed`, `partner_oauth_callback_failed`, `invalid_notification_type`, `invalid_default_account_id`, `user_not_a_member_of_account`, `organization_export_requests_pending`, `organization_export_type_invalid`, `organization_export_request_not_found`, `organization_export_task_processing_timeout`, `organization_export_task_queued_timeout`, `organization_export_task_max_allowed`, `organization_export_task_invalid_resultsetstorage`, `organization_import_not_found`, `organization_import_bad_request_header`, `organization_import_bad_csv_content`, `invalid_id_request`, `invalid_eid_request`, `organization_export_task_not_found`, `proof_service_validation_model_not_found`, `organization_import_processing_timeout`, `proof_service_invalid_model_type`, `proof_service_proof_file_not_exists`, `proof_service_proof_file_bad_owner`, `proof_service_model_validation_failure`, `proof_service_request_entity_too_large`, `proof_service_unreadable_payload`, `proof_service_view_schema_invalid`, `proof_service_front_view_not_exists`, `proof_service_view_schema_not_found`, `proof_service_event_not_found`, `proof_service_event_media_not_found`, `proof_service_event_media_unauthorized`, `proof_service_error`, `proof_service_proof_file_duplicate`, `proof_service_schema_conflict`, `proof_service_view_conflict`, `forbidden`, `invalid_photoid_request`, `invalid_identityweb_resource_request`, `identityweb_manual_review_disabled`, `identityweb_vendor_response_validation_failed`, `organization_import_no_csv_results`, `organization_import_export_pending`, `organization_export_import_pending`, `organization_import_delete_status_queued`, `organization_import_max_records`, `organization_import_max_total_records`, `organization_import_max_account_records`, `organization_import_max_site_records`, `organization_import_max_accounts`, `organization_import_could_not_be_queued`, `organization_import_import_pending`, `organization_import_max_imports`, `principal_throttled`, `service_unavailable`, `invalid_template`, `invalid_admin_communication_principal`, `invalid_admin_communication`, `max_admin_communication_aggregations_exceeded`, `missing_admin_communication_subject`, `unable_to_send_orgadmin_invitation`, `order_already_exists`, `order_not_found`, `order_invalid_product_state`, `order_invalid_state`, `accountproduct_account_not_found`, `invalid_accountproduct`, `accountproduct_update_failed`, `accountproduct_provision_failed`, `freetrial_alreay_claimed`, `accountproduct_activation_failed`, `provision_token_create_failed`, `order_free_trial_already_claimed`, `transaction_management_client_error`, `transaction_management_service_error`, `provision_client_failed`, `accountproduct_cancellation_failed`, `accountproduct_upgrade_failed`, `account_information_not_specified`, `appliance_latest_release_error`, `appliance_release_error`, `appliance_release_file_error`, `auto_activate_member_in_non_active_account`, `organization_export_domain_selection_invalid`, `organization_export_account_selection_invalid`, `invalid_metadata`, `organization_disallowed_for_account`, `unable_to_send_orgaccount_invitation`, `unsupported_principal_type`, `invalid_phone_number`, `identity_session_creation_error`, `invalid_mapping_code`, `create_mobile_session_throttled`, `identity_client_logging_error`, `organization_account_settings_import_imports_pending`, `organization_account_settings_import_exports_pending`, `organization_export_account_settings_import_pending`, `declined_invitation_update_not_allowed`, `accepted_invitation_access_not_allowed`, `missing_current_authenticated_principal_information`, `invalid_caller_information`, `public_key_insert_header_content_invalid`, `public_key_insert_user_public_key_already_existed`, `public_key_insert_unable_to_read_public_key`, `public_key_insert_unable_to_locate_public_key`, `public_key_insert_empty_request_body`, `public_key_unable_to_process_public_key`, `public_key_not_found`, `public_key_id_empty`, `public_key_id_invalid`, `public_key_content_invalid`, `public_key_not_supported`, `public_key_malformatted`, `account_update_failed`, `account_change_plan_failed`, `account_creation_failed`, `accountproduct_invalid_status`, `accountproduct_not_exist`, `accountproduct_expire_failed`, `proofservice_management_disabled`, `invalid_product`, `not_supported`, `identity_workflow_not_found`, `identity_workflow_signature_method_not_found`, `identity_workflow_claim_unknown_provider_type`, `identity_workflow_invalid_externalclaim_properties`, `public_key_api_invalid_modulus`, `public_key_api_invalid_exponent`, `public_key_api_invalid_public_key`, `public_key_api_no_user_mapping_to_given_public_key`, `duplicate_unit_of_measure`, `membership_close_not_allowed`, `immutableid_already_exists`, `organization_has_no_verified_reserved_domains`, `get_account_groups_failed`, `organization_missing_entitlement`, `config_missing_apps_or_values`, `missing_pen_required_claims`, `account_sync_failed`, `invalid_uri`, `invalid_site`, `provision_rest_client_error`, `product_master_entry_not_found`, `provision_orderservicev2_bad_request`, `linked_identity_provider_record_not_found`, `accountproduct_freetrial_not_eligible`, `order_invalid_product`, `protect_api_invalid_action_context`, `protect_api_rules_error`, `protect_api_invalid_recaptcha_configuration`, `protect_api_invalid_recaptcha_verification_error`, `protect_api_invalid_config`, `protect_api_approval_error`, `order_invalid_account`, `order_invalid_source`, `order_invalid_user`, `provision_queue_failure`, `invalid_organization_entitlement`, `product_master_invalid_external_key`, `product_master_entry_invalid_internal_id`, `order_provision_failed`, `protect_api_report_abuse_request_error`, `protect_api_report_abuse_email_error`, `protect_api_report_abuse_error`, `protect_api_report_abuse_config_error`, `protect_api_report_abuse_web_error`, `invalid_region`, `billing_profile_get_failed`, `current_plan_get_failed`, `billing_profile_update_failed`, `billing_profile_account_not_found`, `billing_profile_account_plan_not_found`, `billing_profile_invalid_currency`, `billing_profile_invalid_zuora_id`, `billing_profile_invalid_external_billing_system_id`, `billing_profile_external_billing_usage_start_date_required`, `billing_profile_accountbilling_active_required`, `feature_disabled_in_jump_to_mobile_session`, `requested_format_mismatch`, `organization_entitlement_invalid_rights`, `invalid_image`
- `error_description` (string, optional) — A brief message describing the error condition.
- `error_inner` (string, optional) — The previous exceptions in the call stack.
- `error_stack` (string, optional) — The error stacktrace.
- `reference_id` (string, optional) — The reference identifier corresponding to the trace token.
- `service_error_code` (string, optional) — The service error code.

## Examples

**Response**

```json
{}
```