This API exposes
7 operations
across 4 paths,
and defines 59 schemas.
It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
The identity and technical contract details declared by the specification.
access_schemas-session_duration
string
The amount of time that tokens issued for this application will be valid. Must be in the format 300ms or 2h45m. Valid time units are: ns, us (or µs), ms, s, m,…
access_options_preflight_bypass
boolean
Allows options preflight requests to bypass Access authentication and go directly to the origin. Cannot turn on if corsheaders is set.
access_apps_components-schemas-single_response-2
access_schemas-self_hosted_props
object
17 properties
2 required
access_api-response-collection
object
access_apps_components-schemas-name
string
The name of the application.
access_components-schemas-domain
string
The domain and path that Access will secure.
access_schemas-warp_props
access_custom_deny_message
string
The custom error message shown to a user when they are denied access to the application.
access_identifier
string
Identifier
access_allowed_idps
array
The identity providers your users can select when connecting to this application. Defaults to all IdPs configured in your account.
access_service_auth_401_redirect
boolean
Returns a 401 status code when the request is blocked by a Service Auth policy.
access_schemas-cors_headers
object
8 properties
access_allow_all_methods
boolean
Allows all HTTP request methods.
access_allow_all_headers
boolean
Allows all HTTP request headers.
access_api-response-common-failure
object
4 properties
4 required
access_result_info
object
4 properties
access_schemas-bookmark_props
object
5 properties
2 required
access_max_age
number
The maximum number of seconds the results of a preflight request can be cached.
access_schemas-app_launcher_props
access_scim_config_authentication_oauth2
object
Attributes for configuring OAuth 2 authentication scheme for SCIM provisioning to an application.
6 properties
5 required
access_schemas-allowed_origins
array
Allowed origins.
access_allow_credentials
boolean
When set to true, includes credentials (cookies, authorization headers, or TLS client certificates) with requests.
access_schemas-feature_app_props
object
6 properties
1 required
access_schemas-oidc_saas_app
object
16 properties
access_allow_all_origins
boolean
Allows all origins.
access_schemas-empty_response
access_schemas-basic_app_response_props
object
5 properties
access_app_launcher_visible
boolean
Displays the application in the App Launcher.
access_apps_components-schemas-response_collection-2
access_logo_url
string
The image URL for the logo shown in the App Launcher dashboard.
access_api-response-common
object
3 properties
3 required
access_schemas-policy_check_response
access_schemas-custom_deny_url
string
The custom URL a user is redirected to when they are denied access to the application.
access_schemas-biso_props
access_schemas-scim_config
object
Configuration for provisioning to this application via SCIM. This is currently in closed beta.
6 properties
2 required
access_schemas-aud
string
Audience tag.
access_scim_config_authentication_http_basic
object
Attributes for configuring HTTP Basic authentication scheme for SCIM provisioning to an application.
3 properties
3 required
access_scim_config_authentication_oauth_bearer_token
object
Attributes for configuring OAuth Bearer Token authentication scheme for SCIM provisioning to an application.
2 properties
2 required
access_type
string
The application type.
access_scim_config_mapping
object
Transformations and filters applied to resources before they are provisioned in the remote SCIM service.
5 properties
1 required
access_http_only_cookie_attribute
boolean
Enables the HttpOnly cookie attribute, which increases security against XSS attacks.
access_skip_interstitial
boolean
Enables automatic authentication through cloudflared.
access_schemas-saml_saas_app
object
11 properties
access_same_site_cookie_attribute
string
Sets the SameSite cookie setting, which provides increased security against CSRF attacks.
access_allowed_methods
array
Allowed HTTP request methods.
access_schemas-auto_redirect_to_identity
boolean
When set to true, users skip the identity provider selection step during login. You must specify only one identity provider in allowedidps.
access_schemas-saas_props
object
7 properties
access_schemas-allowed_headers
array
Allowed HTTP request headers.
access_enable_binding_cookie
boolean
Enables the binding cookie, which increases security against compromised authorization tokens and CSRF attacks.
access_api-response-single
object
The full machine-readable OpenAPI contract behind this narrative.
