APIs.io Engineering Platform Access Applications API
The Access Applications API from APIs.io Engineering Platform — 4 operation(s) for access applications.
This API exposes 7 operations across 4 paths, and defines 119 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.
7 operations
4 paths
119 schemas
1 DELETE3 GET2 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
APIs.io Engineering Platform Access Applications API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 7
Across 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Access Applications 7
GET
/accounts/{account_id}/access/apps
APIs.io Engineering Platform List Access applications
POST
/accounts/{account_id}/access/apps
APIs.io Engineering Platform Add an Access application
DELETE
/accounts/{account_id}/access/apps/{app_id}
APIs.io Engineering Platform Delete an Access application
GET
/accounts/{account_id}/access/apps/{app_id}
APIs.io Engineering Platform Get an Access application
PUT
/accounts/{account_id}/access/apps/{app_id}
APIs.io Engineering Platform Update an Access application
POST
/accounts/{account_id}/access/apps/{app_id}/revoke_tokens
APIs.io Engineering Platform Revoke application tokens
GET
/accounts/{account_id}/access/apps/{app_id}/user_policy_checks
APIs.io Engineering Platform Test Access policies
Schemas 119
The contract defines 119 schemas that model the data the API accepts and returns. The most detailed are access_self_hosted_props (23 properties), access_oidc_saas_app (16 properties), access_policy_resp (14 properties), access_saml_saas_app (13 properties). Each schema is shown below with its type and property counts.
access_approval_groups
array
Administrators who can approve a temporary authentication request.
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_service_token_rule
object
Matches a specific Access Service Token
1 property
1 required
access_api-response-collection
object
access_policy_components-schemas-name
string
The name of the Access policy.
access_vnc_props
access_identifier
string
Identifier
access_allowed_origins
array
Allowed origins.
access_approval_required
boolean
Requires the user to request access from an administrator at the start of each session.
access_allow_all_origins
boolean
Allows all origins.
access_schemas-empty_response
access_app_launcher_props
access_app_launcher_visible
boolean
Displays the application in the App Launcher.
access_email_rule
object
Matches a specific email.
1 property
1 required
access_external_evaluation_rule
object
Create Allow or Block policies which evaluate the user based on custom criteria.
1 property
1 required
access_app_response
access_footer_links
array
The links in the App Launcher footer.
access_landing_page_design
object
The design of the App Launcher landing page shown to users when they log in.
5 properties
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_self_hosted_props
object
23 properties
2 required
access_timestamp
string
access_message
string
The message shown on the landing page.
access_cors_headers
object
8 properties
access_same_site_cookie_attribute
string
Sets the SameSite cookie setting, which provides increased security against CSRF attacks.
access_app_req_embedded_scim_config
object
1 property
access_button_color
string
The background color of the log in button on the landing page.
access_ssh_props
access_button_text_color
string
The color of the text in the log in button on the landing page.
access_purpose_justification_prompt
string
A custom message that will appear on the purpose justification screen.
access_basic_app_response_props
object
5 properties
access_app_resp_embedded_policies
object
The policies that will apply to the application.
1 property
access_include
array
Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.
access_app_req_embedded_policies
object
1 property
access_any_valid_service_token_rule
object
Matches any valid Access Service Token
1 property
1 required
access_rule
object
access_github_organization_rule
object
Matches a Github organization. Requires a Github identity provider.
1 property
1 required
access_app_policy_response
object
1 property
access_custom_non_identity_deny_url
string
The custom URL a user is redirected to when they are denied access to the application when failing non-identity rules.
access_custom_deny_message
string
The custom error message shown to a user when they are denied access to the application.
access_app_policy_link
object
A JSON that links a reusable policy to an application.
2 properties
access_api-response-common-failure
object
4 properties
4 required
access_ip_list_rule
object
Matches an IP address from a list.
1 property
1 required
access_scim_config_authentication_oauth2
object
Attributes for configuring OAuth 2 authentication scheme for SCIM provisioning to an application.
6 properties
5 required
access_ip_rule
object
Matches an IP address block.
1 property
1 required
access_isolation_required
boolean
Require this application to be served in an isolated browser for users matching this policy. 'Client Web Isolation' must be on for the account in order to use…
access_apps_components-schemas-single_response
access_okta_group_rule
object
Matches an Okta group. Requires an Okta identity provider.
1 property
1 required
access_components-schemas-session_duration
string
The amount of time that tokens issued for the application will be valid. Must be in the format 300ms or 2h45m. Valid time units are: ns, us (or µs), ms, s, m,…
access_schemas-exclude
array
Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules.
access_type
string
The application type.
access_skip_interstitial
boolean
Enables automatic authentication through cloudflared.
access_everyone_rule
object
Matches everyone.
1 property
1 required
access_path_cookie_attribute
boolean
Enables cookie paths to scope an application's JWT to the application path. If disabled, the JWT will scope to the hostname by default
access_warp_props
access_oidc_saas_app
object
16 properties
access_azure_group_rule
object
Matches an Azure group. Requires an Azure identity provider.
1 property
1 required
access_custom_deny_url
string
The custom URL a user is redirected to when they are denied access to the application when failing identity-based rules.
access_app_id
access_saas_props
object
9 properties
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_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_uuid
string
UUID
access_apps_components-schemas-name
string
The name of the application.
access_allow_all_methods
boolean
Allows all HTTP request methods.
access_schemas-allow_authenticate_via_warp
boolean
When set to true, users can authenticate to this application using their WARP session. When set to false this application will always require direct IdP authen…
access_authentication_method_rule
object
Enforce different MFA options
1 property
1 required
access_apps_components-schemas-response_collection
access_country_rule
object
Matches a specific country
1 property
1 required
access_app_policy_request
access_max_age
number
The maximum number of seconds the results of a preflight request can be cached.
access_purpose_justification_required
boolean
Require users to enter a justification when they log in to the application.
access_gsuite_group_rule
object
Matches a group in Google Workspace. Requires a Google Workspace identity provider.
1 property
1 required
access_scim_config
object
Configuration for provisioning to this application via SCIM. This is currently in closed beta.
6 properties
2 required
access_api-response-common
object
3 properties
3 required
access_domain_rule
object
Match an entire email domain.
1 property
1 required
access_policy_check_response
access_schemas-custom_pages
array
The custom pages that will be displayed when applicable for this application
access_device_posture_rule
object
Enforces a device posture rule has run successfully
1 property
1 required
access_id_response
access_email_list_rule
object
Matches an email address from a list.
1 property
1 required
access_allowed_methods
array
Allowed HTTP request methods.
access_tags
array
The tags you want assigned to an application. Tags are used to filter applications in the App Launcher dashboard.
access_self_hosted_domains
array
List of domains that Access will secure.
access_image_url
string
The URL of the image shown on the landing page.
access_feature_app_props
object
12 properties
1 required
access_policy_req
object
11 properties
3 required
access_schemas-require
array
Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules.
access_skip_app_launcher_login_page
boolean
Determines when to skip the App Launcher landing page.
access_title
string
The title shown on the landing page.
access_app_launcher_logo_url
string
The image URL of the logo shown in the App Launcher header.
access_bg_color
string
The background color of the App Launcher page.
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_saml_saas_app
object
13 properties
access_allow_all_headers
boolean
Allows all HTTP request headers.
access_service_auth_401_redirect
boolean
Returns a 401 status code when the request is blocked by a Service Auth policy.
access_saml_group_rule
object
Matches a SAML group. Requires a SAML identity provider.
1 property
1 required
access_access_group_rule
object
Matches an Access group.
1 property
1 required
access_result_info
object
4 properties
access_policy_resp
object
14 properties
access_allow_credentials
boolean
When set to true, includes credentials (cookies, authorization headers, or TLS client certificates) with requests.
access_app_request
access_logo_url
string
The image URL for the logo shown in the App Launcher dashboard.
access_messages
array
access_biso_props
access_allowed_headers
array
Allowed HTTP request headers.
access_decision
string
The action Access will take if a user matches this policy.
access_schemas-aud
string
Audience tag.
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_domain
string
The primary hostname and path that Access will secure. If the app is visible in the App Launcher dashboard, this is the domain that will be displayed.
access_precedence
integer
The order of execution for this policy. Must be unique for each policy within an app.
access_approval_group
object
A group of email addresses that can approve a temporary authentication request.
3 properties
1 required
access_header_bg_color
string
The background color of the App Launcher header.
access_bookmark_props
object
6 properties
access_enable_binding_cookie
boolean
Enables the binding cookie, which increases security against compromised authorization tokens and CSRF attacks.
access_certificate_rule
object
Matches any valid client certificate.
1 property
1 required
access_schemas-uuid
string
The UUID of the policy
access_api-response-single
object
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Access Applications