Interface DataApiConfig

Export

DataApiConfig

Hierarchy

  • DataApiConfig

Properties

can_evaluate? create_user_on_auth? disabled? return_type? run_as_user_id? run_as_user_id_script_source? secret_name? validation_method? versions?

Properties

Optional can_evaluate

can_evaluate?: any

A JSON expression that evaluates to true if an endpoint is allowed to run in response to an incoming request.

Memberof

DataApiConfig

Optional create_user_on_auth

create_user_on_auth?: any

Memberof

DataApiConfig

Optional disabled

disabled?: any

Memberof

DataApiConfig

Optional return_type

return_type?: EndpointDataFormat

The default data format returned by Data API endpoints.

Memberof

DataApiConfig

Optional run_as_user_id

run_as_user_id?: any

An application user's account ID. If defined, endpoints will always run as the specified user.

Memberof

DataApiConfig

Optional run_as_user_id_script_source

run_as_user_id_script_source?: any

Stringified source code for a function that returns an application user's account ID. If defined, endpoints execute the function on every request and run as the user with the ID returned from the function.

Memberof

DataApiConfig

Optional secret_name

secret_name?: any

If validation_method is set to \"SECRET_AS_QUERY_PARAM\" or \"VERIFY_PAYLOAD\", this is the name of the Secret that authorizes requests.

Memberof

DataApiConfig

Optional validation_method

validation_method?: DataApiConfigValidationMethodEnum

Memberof

DataApiConfig

Optional versions

versions?: any

Memberof

DataApiConfig

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc