CreatePassthroughConfigRequest
Defined in: src/types/passthrough.ts:8
Request body for creating a passthrough service configuration.
Properties
Section titled “Properties”api_key?
Section titled “api_key?”
optionalapi_key?:string
Defined in: src/types/passthrough.ts:16
The API key used for authentication.
api_url
Section titled “api_url”api_url:
string
Defined in: src/types/passthrough.ts:12
The API URL for the passthrough service.
auth_field_name_in_resp?
Section titled “auth_field_name_in_resp?”
optionalauth_field_name_in_resp?:string
Defined in: src/types/passthrough.ts:24
The field name in the login response that contains the auth token.
auth_send_medium?
Section titled “auth_send_medium?”
optionalauth_send_medium?:string
Defined in: src/types/passthrough.ts:26
How the auth credential is sent (e.g., header, query).
auth_token?
Section titled “auth_token?”
optionalauth_token?:string
Defined in: src/types/passthrough.ts:18
The auth token used for authentication.
auth_type?
Section titled “auth_type?”
optionalauth_type?:string
Defined in: src/types/passthrough.ts:14
The authentication type (e.g., api_key, token, login).
login_api_auth_send_medium?
Section titled “login_api_auth_send_medium?”
optionallogin_api_auth_send_medium?:string
Defined in: src/types/passthrough.ts:30
How the auth credential is sent in the login API request.
login_api_request_type?
Section titled “login_api_request_type?”
optionallogin_api_request_type?:string
Defined in: src/types/passthrough.ts:28
The HTTP method used for the login API request.
login_api_url?
Section titled “login_api_url?”
optionallogin_api_url?:string
Defined in: src/types/passthrough.ts:20
The login API URL for token-based authentication.
login_credentials?
Section titled “login_credentials?”
optionallogin_credentials?:Record<string,unknown>
Defined in: src/types/passthrough.ts:22
Credentials payload sent to the login API.
service_name
Section titled “service_name”service_name:
string
Defined in: src/types/passthrough.ts:10
The name of the passthrough service.