Interface Access

Control access to content.

Hierarchy

  • Access

Indexable

[k: string]: unknown

Properties

deny_access? token_auth? token_auth_denial_code? token_auth_ignore_url_case? token_auth_keys? token_auth_parameter?

Properties

Optional deny_access

deny_access?: boolean

Determines whether requests are rejected with a 403 Forbidden response.

Optional token_auth

token_auth?: boolean

Determines whether Token-Based Authentication will be applied to a request.

Optional token_auth_denial_code

token_auth_denial_code?: HttpResponseNoBody

Optional token_auth_ignore_url_case

token_auth_ignore_url_case?: boolean

Determines whether URL comparisons made by the following Token-Based Authentication parameters are case-sensitive: ec_url_allow, ec_ref_allow, ec_ref_deny.

Optional token_auth_keys

token_auth_keys?: {
    backup?: string;
    backup_min_version?: "v2" | "v3";
    primary?: string;
    primary_min_version?: "v2" | "v3";
}

Type declaration

  • Optional backup?: string
  • Optional backup_min_version?: "v2" | "v3"
  • Optional primary?: string
  • Optional primary_min_version?: "v2" | "v3"

Optional token_auth_parameter

token_auth_parameter?: string

Settings

Member Visibility

Theme

Generated using TypeDoc