API key security schemes

Defines an API key security scheme that can be used by the operations.

Usage

class_api_key_security_scheme(
  parameter_name = character(),
  location = c("query", "header", "cookie")
)

Arguments

parameter_name

Character vector (required). The names of the header, query or cookie parameters to be used.

location

Character vector (required). The location of the API key. Valid values are "query", "header" or "cookie".

Value

An api_key_security_scheme S7 object, with fields parameter_name

and location.

See also

security scheme objects as_api_key_security_scheme(), as_oauth2_authorization_code_flow(), as_oauth2_implicit_flow(), as_oauth2_security_scheme(), as_oauth2_token_flow(), as_scopes(), as_security_scheme(), as_security_scheme_details(), as_security_schemes(), class_oauth2_authorization_code_flow(), class_oauth2_implicit_flow(), class_oauth2_security_scheme(), class_oauth2_token_flow(), class_scopes(), class_security_scheme_details(), class_security_schemes()

components object as_api_key_security_scheme(), as_components(), as_oauth2_authorization_code_flow(), as_oauth2_implicit_flow(), as_oauth2_security_scheme(), as_oauth2_token_flow(), as_reference(), as_schema(), as_scopes(), as_security_scheme(), as_security_scheme_details(), as_security_schemes(), class_components(), class_oauth2_authorization_code_flow(), class_oauth2_implicit_flow(), class_oauth2_security_scheme(), class_oauth2_token_flow(), class_reference(), class_schema(), class_scopes(), class_security_scheme_details(), class_security_schemes()

Examples

class_api_key_security_scheme(
  parameter_name = "Authorization",
  location = "header"
)
#> <rapid::api_key_security_scheme>
#>  @ parameter_name: chr "Authorization"
#>  @ location      : chr "header"