API

Create an application

post
https://{hostname}/crux/v1/mgmt-pop/apps

Creates a new application. After successful creation, additional steps are needed to deploy the application, depending on the application type. Refer to Application creation workflow.

Query Params
string
required

The Akamai contract identifier for your Enterprise Application Access product.

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Enterprise Access Application properties.

advanced_settings
object

Application config version advanced settings.

agents
array of objects
length ≥ 1

Target connectors for deploying the application configuration.

agents
app
object

Specifies the application for the application directory.

app_category
object

Specifies the category the application belongs to.

boolean

Whether the application configuration is deployed.

string
length ≥ 1

A URL identifying the application configuration's logo icon.

integer
enum
Defaults to 1

The operational status of the application configuration. Either 1 for No, 2 for Pending, or 3 for Okay.

Allowed:
integer
enum
Defaults to 1

The access application profile. Either 1 for HTTP, 2 for SharePoint, 3 for Jira, 4 for RDP, 5 for VNC, 6 for ssh, 7 for Jenkins, 8 for Confluence, or 9 for TCP.

integer
enum
Defaults to 1

The status of the application configuration. Either 1 for not ready, 2 for ready, 3 for pending, 4 for deployed, 5 for failed, 6 for cloud deployed, or 7 for connector deployed.

Allowed:
integer
enum

The type of application configuration. Either 1 for Enterprise Hosted, 2 for SAAS, 3 for Bookmark, 4 for Tunnel, or 5 for Enterprise Threat Protector.

Allowed:
string | null

The connector for the application.

string
length ≥ 1
Defaults to true

Enables authentication.

integer
enum
Defaults to 1

The type of authentication used. Either 1 for Cloud, 2 for Enterprise, or 3 for Third Party.

Allowed:
string
length ≥ 0

The Okta Bookmark app URL.

string | null

A valid certificate string for front-end SSL connections. Used if you configure your domain as the external hostname. Specify null if you want to name it later.

integer
enum
Defaults to 1

The mode of client app. 1 for TCP or 2 for Tunnel.

Allowed:
string | null

The upstream URL for a CNAME redirect.

string | null

The data connector for the application.

string
length ≥ 1

A description of the application.

directories
array of objects
length ≥ 1

Application directory details for validating user accounts.

directories
directory
object

Directory properties.

integer
enum
Defaults to 1

The type of access domain. Select 1 for custom or 2 for Akamai.

Allowed:
string
length ≥ 0

The domain suffix. For example, .com.

string
enum

Enables multifactor authentication. Either enable or use to inherit to use the IDP's MFA settings.

Allowed:
string | null

The external default hostname for the application.

idp
object

Specifies the identity provider (IDP) for authenticating user requests.

string
length ≥ 1

Name of the user who most recently modified this application object. If the object wasn't modified since first being created, the value matches createdAt.

string
length ≥ 0

The name of the application configuration.

boolean

Enables OpenID Connect (OIDC).

oidc_settings
object | null

JSON settings to implement OIDC.

string

Whether the origin host uses TLS encryption.

string | null

The IP address or FQDN of the application origin server.

integer

The application's origin port.

string
length ≥ 0

The identifier for the target region to deploy the application.

string
length ≥ 0

The target region to deploy the application. For example, US-West or US-East.

string
length ≥ 1

The version of remote desktop protocol (RDP).

string
length ≥ 1

Name of resource mapping to an entity or set of entities. For example, apps.

resource_status
object

The most recent status of various application resources.

resource_uri
object

Related resource URIs for the application.

boolean

Enables SAML for the application.

saml_settings
array of objects

SAML configuration for an application.

saml_settings
servers
array of objects
length ≥ 0

Origin server details of the internal application within your network.

servers
services
array of objects
length ≥ 1

Services enabled on the application configuration.

services
sites
array of strings
length ≥ 1

The application's site resources.

sites
integer
enum
Defaults to 1

The status of the application configuration. Either 1 for not ready, 2 for ready, 3 for pending, 4 for deployed, 5 for failed, 6 for cloud deployed, or 7 for connector deployed.

Allowed:
string
length ≥ 1

A unique identifier for the application.

boolean

Enables Web Services Federation (WSFED) identity federation.

wsfed_settings
array of objects

JSON settings to implement WSFED.

wsfed_settings
Response

Updated 21 days ago

Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 21 days ago